Provides a pre-configured column pinning component for the grid.

Constructors

Section titled "Constructors"

IgcGridToolbarPinningComponent 

new IgcGridToolbarPinningComponent(args: any[]): IgcGridToolbarPinningComponent

Returns IgcGridToolbarPinningComponent

Properties

Section titled "Properties"

tagName

Section titled "tagName" 
tagName: string

Accessors

Section titled "Accessors"

columnListHeight

Section titled "columnListHeight"

Inherited from: IgcBaseToolbarColumnActionsDirective 

get columnListHeight(): string

Returns string

Sets the height of the column list in the dropdown.

 
set columnListHeight(value: string): void

Parameters

  • value: string

Returns void

overlaySettings

Section titled "overlaySettings"

Inherited from: IgcBaseToolbarColumnActionsDirective 

get overlaySettings(): IgcOverlaySettings

Returns IgcOverlaySettings

Sets overlay settings

 
set overlaySettings(value: IgcOverlaySettings): void

Parameters

Returns void

prompt

Section titled "prompt"

Inherited from: IgcBaseToolbarColumnActionsDirective 

get prompt(): string

Returns string

The placeholder text for the search input.

 
set prompt(value: string): void

Parameters

  • value: string

Returns void

title

Section titled "title"

Inherited from: IgcBaseToolbarColumnActionsDirective

The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

MDN Reference

 
get title(): string

Returns string

Title text for the column action component

 
set title(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: IgcBaseToolbarColumnActionsDirective 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

removeEventListener

Section titled "removeEventListener"

Inherited from: IgcBaseToolbarColumnActionsDirective 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

register

Section titled "register" 
register(): void

Returns void