File

projects/i-components/src/lib/components/xam-grid/test/custom-xam-grid.component.ts

Extends

XamGridComponent

Metadata

selector	`wm-custom-xam-grid`
template	`<wm-xam-grid [model]="model"></wm-xam-grid>`

Index

Constructor

constructor(injectedModel: XamGridModel, injector: Injector, cdRef: ChangeDetectorRef, differsFactory: IterableDiffers, resolver: ComponentFactoryResolver, ref: ElementRef, document, iconService: IgxIconService)

Defined in projects/i-components/src/lib/components/xam-grid/test/custom-xam-grid.component.ts:50

Parameters :

Name	Type	Optional
injectedModel	`XamGridModel`	No
injector	`Injector`	No
cdRef	`ChangeDetectorRef`	No
differsFactory	`IterableDiffers`	No
resolver	`ComponentFactoryResolver`	No
ref	`ElementRef`	No
document		No
iconService	`IgxIconService`	No

Inputs

model
Type : `CustomXamGrid`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:46`

addNewRowInheritance
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:373`
Input from the extended component to fill the addNewRow in the internal xamGrid

autoGenerateColumns
Type : `boolean`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:416`
Sets whether the columns of all ColumnLayout objects of this XamGrid should be generated.

borderBrush
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:947`
Gets the border color of the control.

borderThickness
Type : `string`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:916`
Gets the border styling of the grid.

cellStyleEnabled
Type : `boolean`
Default value : `false`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:336`
Flag which indicates if the cell styling is enabled

columnLayoutInheritance
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:365`
Input from the extended component to fill the ColumnLayout in the internal xamGrid

columnWidth
Type : `ColumnWidth`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:1016`
Gets/sets the ColumnWidth type for the columns of the grid. Runs only on initialization

data
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:750`
Gets/set data.

editingInheritance
Type : `EditingSettingsComponent`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:381`
Input from the extended component to fill the addNewRow in the internal xamGrid

filterCellTooltip
Type : `string`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:357`
Custom input of xam grid component to add tooltip message to each filter column. Note: Every FilterRowCellControl is going to have the same tooltip, if an specific tooltip should be set to an specific FilterRowCellControl please add new functionality.

footerVisibility
Type : `boolean`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:344`
Controls whether to show the column footers if any.

gridColumnsInheritance
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:408`
Input from the extended component to fill the grid columns in the internal xamGrid

headerStyle
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:806`
set headerStyle.

headersVisibility
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:984`
Sets the visibility of the Xam grid columns headers.

isAlternateRowsEnabled
Type : `boolean`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:1035`
Gets/sets the isAlternateRowsEnabled, if enabled even rows will display in a different color.

itemsSource
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:765`
Two-way bindable property for the data source of the Xam grid.

name
Type : `string`
Inherited from `BaseComponent`
Defined in `BaseComponent:446`
Sets the name model property for the control when the name is an input

selectedRow
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:824`
Gets/sets the current selected row in the Xam grid.

selectionSettings
Type : `SelectionSettings`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:735`
Gets/sets the selection settings for the XamGrid.

sortingSettingInheritance
Type : `SortingSettingsComponent`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:400`
Sorting settings from the extended component.

virtualHeight
Type : `any`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:902`
Sets the grid height to limit how many rows are rendered accepts null value, which will render all rows in the DOM with no scrollbar

controlTemplate
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1197`
Sets the controlTemplate Input property for changing the model's `TemplateProperty`

cursor
Inherited from `BaseComponent`
Defined in `BaseComponent:1451`
Property used to save the cursor value

dataContext
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:952`
Gets/sets the dataContext Input property for changing the model's `DataContextProperty`

dataGridRowHeight
Type : `number`
Default value : `22`
Inherited from `BaseComponent`
Defined in `BaseComponent:507`
Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead.

foreground
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1223`
Sets the value of the Foreground property

height
Inherited from `BaseComponent`
Defined in `BaseComponent:1394`
Sets the height

horizontalAlignment
Inherited from `BaseComponent`
Defined in `BaseComponent:1096`
Sets the horizontal alignment.

horizontalContentAlignment
Inherited from `BaseComponent`
Defined in `BaseComponent:1125`
Sets the horizontal content alignment.

hostHozSelfAlign
Type : `boolean`
Default value : `false`
Inherited from `BaseComponent`
Defined in `BaseComponent:380`
Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment.

isEnabled
Inherited from `BaseComponent`
Defined in `BaseComponent:1008`
Gets/sets the isEnabled property for the BaseComponent

isTabStop
Type : `boolean`
Inherited from `BaseComponent`
Defined in `BaseComponent:760`
Sets/gets IsTabStop property of the BaseComponent

margin
Type : `string`
Inherited from `BaseComponent`
Defined in `BaseComponent:782`
Sets Margin property of the BaseComponent.

maxHeight
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1325`
Sets maxHeight

maxWidth
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1283`
Sets maxWidth

minHeight
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1304`
Sets minHeight

minWidth
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1262`
Sets min Width

opacity
Inherited from `BaseComponent`
Defined in `BaseComponent:1336`
Sets Opacity value property of the component

spellCheck
Type : `boolean`
Default value : `false`
Inherited from `BaseComponent`
Defined in `BaseComponent:186`
Flag to determinate if the component should do the spell check or not. Default value is false.

style
Inherited from `BaseComponent`
Defined in `BaseComponent:1434`
Sets the style

tabIndex
Type : `number`
Inherited from `BaseComponent`
Defined in `BaseComponent:733`
Sets the property TabIndex of the control model.

tag
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:1171`
Object used in the Tag property of the Button

useCss
Type : `boolean`
Default value : `false`
Inherited from `BaseComponent`
Defined in `BaseComponent:177`
Determines if the component uses CSS height/width values, instead of inputs

verticalAlignment
Inherited from `BaseComponent`
Defined in `BaseComponent:1038`
Sets the vertical alignment.

verticalContentAlignment
Inherited from `BaseComponent`
Defined in `BaseComponent:1067`
Sets the vertical content alignment.

visibility
Type : `any`
Inherited from `BaseComponent`
Defined in `BaseComponent:980`
Gets/sets the visibility property for the BaseComponent

width
Inherited from `BaseComponent`
Defined in `BaseComponent:1365`
Sets the width

zindex
Type : `number`
Inherited from `BaseComponent`
Defined in `BaseComponent:1498`
Property used to set the canvas zindex value. Note: Consider moving this @Input to canvas.direcive.ts, refactoring the directive so all inputs are declared in the directive, and all @HostBindings are declared here in baseComponent, the directive would be responsible for updating the models, while baseComponent will be responsible for binding the values: zIndex, Top, Left...

Outputs

activeCellChanged
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:670`
Active cell event emitter

afterCellControlAttached
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:883`
Event emitted after the 'new' cells are created

cellClicked
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:466`
CellClicked eventEmitter.

cellControlAttached
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:874`
Event emitted when 'new' cells are entering the view

cellDoubleClicked
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:517`
Double-click eventEmitter.

cellEdited
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:661`
Cell edited event emitter

cellEditing
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:652`
Cell editing event emitter

cellEnteredEditMode
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:607`
CellEnteredEditMode

cellEnteringEditMode
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:598`
Cell enter edit mode

cellExitedEditMode
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:625`
Cell exit edit mode

cellExitingEditMode
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:616`
Cell exiting edit mode eventEmitter

cellSelectionChange
Type : `EventEmitter<IGridCellEventArgs>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:475`
cellSelectionChanged eventEmitter.

columnFiltered
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:580`
Column filtering eventEmitter

columnFixed
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:589`
Column fixed eventEmitter.

columnFixedStateChanged
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:553`
column fixed state changed eventEmitter

columnResized
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:535`
Column resized eventEmitter.

columnResizing
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:544`
Column resizing eventEmitter

columnSelectionChanged
Type : `EventEmitter<IColumnSelectionEventArgs>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:499`
columnSelectionChange event emitter.

columnSorted
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:562`
Event emitted when a column has done applying a sorting

columnSorting
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:571`
Column sorting eventEmitter.

initializeRow
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:892`
Event emitted when the row is initialized

itemsSourceChange
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:788`
Event emitter for two-way binding of the `itemsSource` property.

keyDown
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:508`
KeyDown eventEmitter.

loaded
Type : `EventEmitter<any>`
Inherited from `BaseComponent`
Defined in `BaseComponent:856`
Event emitted when the grid is done loading in the DOM

pageIndexChanged
Type : `EventEmitter<PageChangedEventArgs>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:706`
Page changed event emitter

pageIndexChanging
Type : `EventEmitter<CancellablePageChangingEventArgs>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:697`
Page changing event emitter

rendered
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:526`
XamGrid rendered eventEmitter.

rowAdded
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:679`
Row added event emitter

rowDeleted
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:688`
Row deleted event emitter

rowEnteredEditMode
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:643`
Row entered edit mode

rowExitedEditMode
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:634`
Row exit edit mode

selectedRowChange
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:847`
Event emitter for two-way binding of the `selectedRow` property.

selectedRowsCollectionChanged
Type : `EventEmitter<literal type>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:484`
rowSelectionChange eventEmitter.

unloaded
Type : `EventEmitter<any>`
Inherited from `XamGridComponent`
Defined in `XamGridComponent:865`
Event emitted when the grid is unloading the component

bindingValidationError
Type : `EventEmitter<any>`
Inherited from `BaseComponent`
Defined in `BaseComponent:114`
output to emit the new value of the bindingValidationError event

layoutUpdated
Type : `EventEmitter<any>`
Inherited from `BaseComponent`
Defined in `BaseComponent:140`
Output to emit when then component's layout is updated.

mouseEnter
Type : `EventEmitter<literal type>`
Inherited from `BaseComponent`
Defined in `BaseComponent:157`
Event Emitter. EventEmitter normally called in the mouseEnterHandler.

mouseLeave
Type : `EventEmitter<literal type>`
Inherited from `BaseComponent`
Defined in `BaseComponent:167`
Event Emitter Called in the mouseLeave handler

mouseLeftButtonUp
Type : `EventEmitter<literal type>`
Inherited from `BaseComponent`
Defined in `BaseComponent:147`
MouseLeftButtonUp event Emitter.

sizeChanged
Type : `EventEmitter<any>`
Inherited from `BaseComponent`
Defined in `BaseComponent:132`
Output to emit when then component size is changed.

HostBindings

class

Type : string

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:407

Applies custom CSS classes

class.defaultFontStyles

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:398

Applies default font styles class, used to allow specificity for each control css

class.focusable

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:388

Display if the component is focusable or not

class.hasDefinedCursor

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:415

Applies Defined Cursor class

class.horizontal-center

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:308

Applies horizontal alignment left class

class.horizontal-left

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:298

Applies horizontal alignment left class

class.horizontal-right

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:368

Applies horizontal alignment right class

class.horizontal-stretch

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:358

Applies horizontal alignment stretch class

class.vertical-bottom

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:328

Applies vertical alignment bottom class

class.vertical-center

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:338

Applies vertical alignment center class

class.vertical-stretch

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:318

Applies horizontal alignment stretch class

class.vertical-top

Type : boolean

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:348

Applies vertical alignment top class

style.display

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:243

Property use it to apply the host binding for the visibility

style.font-family

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:261

Property use it to apply the host binding for the font-family

style.font-size

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:270

Property use it to apply the host binding for the font-size

style.font-style

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:279

Property use it to apply the host binding for the font-style

style.font-weight

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:288

Property use it to apply the host binding for the font-weight

style.height

Type : string

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:218

Property use it to apply the host binding for the height

style.max-height.px

Type : number

Inherited from BaseComponent

Defined in BaseComponent:234

Property used to apply the host binding for max-height

style.max-width.px

Type : number

Inherited from BaseComponent

Defined in BaseComponent:210

Property used to apply the host binding for max-width

style.min-height.px

Type : number

Inherited from BaseComponent

Defined in BaseComponent:226

Property used to apply the host binding for min-height

style.min-width.px

Type : number

Inherited from BaseComponent

Defined in BaseComponent:202

Property used to apply the host binding for min-width

style.opacity

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:252

Property use it to apply the host binding for the opacity

style.width

Type : string

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:194

Property use it to apply the host binding for the width

style.z-index

Type : string

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:424

Sets the z-index style.

HostListeners

document:mousedown

Arguments : '$event.target'

document:mousedown(target: any)

Inherited from XamGridComponent

Defined in XamGridComponent:3885

TriggerExitEditMode when a click is called outside a xam grid row and a row and is in edition

Parameters :

Name	Optional
target	No

keydown

Arguments : '$event'

keydown(event: KeyboardEvent)

Inherited from XamGridComponent

Defined in XamGridComponent:3188

Listener for tab keydown event Needs to be done in host listener to trigger even in not editable cells

Parameters :

Name	Optional
event	No

Methods

ngOnInit

ngOnInit()

Inherited from BaseComponent

Defined in BaseComponent:47

Returns : void

activeNodeHandler

activeNodeHandler(event: IActiveNodeChangeEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3246

Active cell handler

Parameters :

Name	Type	Optional
event	`IActiveNodeChangeEventArgs`	No

Returns : void

Private addColumnFromExpression

addColumnFromExpression(expression: any)

Inherited from XamGridComponent

Defined in XamGridComponent:4992

Helper method to add a column to a column collection. Used to handle filtering/sorting/grouping.

Parameters :

Name	Type	Optional
expression	`any`	No

Returns : void

addValidationHelper

addValidationHelper(element: any, msg: string)

Inherited from XamGridComponent

Defined in XamGridComponent:5608

Attach a validation helper to the given element.

Parameters :

Name	Type	Optional
element	`any`	No
msg	`string`	No

Returns : void

Private adjustPagerSettings

adjustPagerSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:5843

Adjust the pager settings and initialize required fields

Returns : void

applyColumnFooterStyles

applyColumnFooterStyles()

Inherited from XamGridComponent

Defined in XamGridComponent:1826

Apply footer styles to DOM elements.

Returns : void

applyDataUpdate

applyDataUpdate(isRendering)

Inherited from XamGridComponent

Defined in XamGridComponent:1978

Reassign current grid data. This is required to see changes reflected.

Parameters :

Name	Optional	Default value
isRendering	No	`false`

Returns : void

arrowLeftHandler

arrowLeftHandler(event: KeyboardEvent)

Inherited from XamGridComponent

Defined in XamGridComponent:3126

Handler for arrowLeft keydown event Gets the cursor position and move to the last cell

Parameters :

Name	Type	Optional
event	`KeyboardEvent`	No

Returns : void

arrowRightHandler

arrowRightHandler(event: KeyboardEvent)

Inherited from XamGridComponent

Defined in XamGridComponent:3093

Handler for arrowRight keydown event Gets the cursor position and move to the next cell

Parameters :

Name	Type	Optional
event	`KeyboardEvent`	No

Returns : void

arrowsHandler

arrowsHandler(event: KeyboardEvent)

Inherited from XamGridComponent

Defined in XamGridComponent:3139

Handler to know which handler has to use

Parameters :

Name	Type	Optional
event	`KeyboardEvent`	No

Returns : boolean

beginAddRow

beginAddRow(index?: number)

Inherited from XamGridComponent

Defined in XamGridComponent:2061

Starts the row adding UI for the XamGrid.

Parameters :

Name	Type	Optional
index	`number`	Yes

Returns : void

buildFooterStylePlan

buildFooterStylePlan()

Inherited from XamGridComponent

Defined in XamGridComponent:1841

Build a footer style plan for the current grid.

Returns : StylePlan

{StylePlan}

Protected calculateAndSetNonSpecialColumnsWidth

calculateAndSetNonSpecialColumnsWidth()

Inherited from XamGridComponent

Defined in XamGridComponent:4208

Calculates and sets the columns width used for numeric and star values.

Returns : void

Private calculateCellControlValue

calculateCellControlValue(cellComponent: CellType, event: any, result: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:3332

Calculates the value of the cell control

Parameters :

Name	Type	Optional
cellComponent	`CellType`	No
event	`any`	No
result	`literal type`	No

Returns : void

Protected calculateNumericColumnsWidth

calculateNumericColumnsWidth(columnModels: XamGridColumnModel[])

Inherited from XamGridComponent

Defined in XamGridComponent:4227

Calculates column width for numeric columns.

Parameters :

Name	Type	Optional
columnModels	`XamGridColumnModel[]`	No

Returns : void

Protected calculatePercentPerStar

calculatePercentPerStar(starValues: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:4274

Calculates width percent that should be given to each star unit.

Parameters :

Name	Type	Optional
starValues	`literal type`	No

Returns : void

Protected calculateStarColumnsWidth

calculateStarColumnsWidth(columnModels: XamGridColumnModel[])

Inherited from XamGridComponent

Defined in XamGridComponent:4244

Calculates column width for star columns.

Parameters :

Name	Type	Optional
columnModels	`XamGridColumnModel[]`	No

Returns : void

Protected calculateStarColumnsWidthLoop

calculateStarColumnsWidthLoop(starValues: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:4296

Calculates column width for star columns. If some star column gets assigned a fixed width, it recalculates usedPixelSize and starTotalSpace and returns false, to indicate that width should be recalculated for all remaining star columns.

Parameters :

Name	Type	Optional
starValues	`literal type`	No

Returns : boolean

{boolean} true if width for all star columns was calculated, false otherwise.

calcVirtualHeight

calcVirtualHeight()

Inherited from XamGridComponent

Defined in XamGridComponent:3358

Defines whether to use virtualization or not

Returns : string | null

cellChanged

cellChanged()

Inherited from XamGridComponent

Defined in XamGridComponent:2426

Flag to know when a style change from the model

Returns : void

cellClickHandler

cellClickHandler(event: IGridCellEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2849

Click Handler event.

Parameters :

Name	Type	Optional
event	`IGridCellEventArgs`	No

Returns : void

cellContext

cellContext(context)

Inherited from XamGridComponent

Defined in XamGridComponent:3744

Returns current column data context.

Parameters :

Name	Optional
context	No

Returns : any

{void}

Private cellControlEvents

cellControlEvents(cell: XamGridCell)

Inherited from XamGridComponent

Defined in XamGridComponent:3588

This function is called when a cell is created and it fires two events that can be used to attach a control to the cell.

Parameters :

Name	Type	Optional	Description
cell	`XamGridCell`	No	XamGridCell - The cell that the control is being attached to.

Returns : void

cellEditedHandler

cellEditedHandler(event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3411

Cell edited handler

Parameters :

Name	Type	Optional
event	`IGridEditDoneEventArgs`	No

Returns : void

cellEditHandler

cellEditHandler(event: IGridEditEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3290

Cell editing handler

Parameters :

Name	Type	Optional
event	`IGridEditEventArgs`	No

Returns : void

cellEnterEditMode

cellEnterEditMode(cellType: CellType, isAsync)

Inherited from XamGridComponent

Defined in XamGridComponent:3706

Triggers the cell edit mode if column is editable and not read-only

Parameters :

Name	Type	Optional	Default value	Description
cellType	`CellType`	No		cell to enter edit mode
isAsync		No	`false`

Returns : void

cellSelectionHandler

cellSelectionHandler(event: IGridCellEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2899

Cell selection event handler.

Parameters :

Name	Type	Optional
event	`IGridCellEventArgs`	No

Returns : void

changePage

changePage()

Inherited from XamGridComponent

Defined in XamGridComponent:5898

Changes the page base on the newItemsPerPage value

Returns : void

Private checkDecimalLimits

checkDecimalLimits(result: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:5700

Converts the given value to number and check if it is within allowed limits for decimal type.

NOTE: number limits are much lower than decimal limits, so a true check for decimal limits is not possible with primitive JS number type.

Parameters :

Name	Type	Optional
result	`literal type`	No

Returns : void

{void}

Private checkIntLimits

checkIntLimits(result: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:5668

Converts the given value to number and check if it is within allowed limits for int type.

Parameters :

Name	Type	Optional
result	`literal type`	No

Returns : void

{void}

Private checkNullableIntLimits

checkNullableIntLimits(result: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:5648

Converts the given value to null if it is an empty string, otherwise it converts the value to number and check if it is within allowed limits for int type.

Parameters :

Name	Type	Optional
result	`literal type`	No

Returns : void

{void}

cleanActiveFromIgxGrid

cleanActiveFromIgxGrid()

Inherited from XamGridComponent

Defined in XamGridComponent:5887

Clean the active cell of the xam-grid component

Returns : void

clearResolvedCellControl

clearResolvedCellControl()

Inherited from XamGridComponent

Defined in XamGridComponent:4829

Method in charge of reset the cell control content herarchy resolutions when required Used in rows scrolling to avoid wrong references in reused controls

Returns : void

clickListener

clickListener(target: any)

Decorators :

@HostListener('document:mousedown', ['$event.target'])

Inherited from XamGridComponent

Defined in XamGridComponent:3885

TriggerExitEditMode when a click is called outside a xam grid row and a row and is in edition

Parameters :

Name	Type	Optional
target	`any`	No

Returns : void

columnSelectionHandler

columnSelectionHandler(event: any)

Inherited from XamGridComponent

Defined in XamGridComponent:3051

Column selection handler.

Parameters :

Name	Type	Optional
event	`any`	No

Returns : void

Private columnSortingEventParameters

columnSortingEventParameters(e: any)

Inherited from XamGridComponent

Defined in XamGridComponent:2169

The function is called when the user clicks on a column header sorting arrow. It gets the column name from the event and then sets the sorting expression to that column.

Parameters :

Name	Type	Optional	Description
e	`any`	No	any - the sorting event object

Returns : void

Public createCell

createCell(cell: CellType, row?: XamGridRow)

Inherited from XamGridComponent

Defined in XamGridComponent:3939

Creates the cell component from the infragistics cell component

Parameters :

Name	Type	Optional
cell	`CellType`	No
row	`XamGridRow`	Yes

Returns : XamGridCell

Private createEventParams

createEventParams()

Inherited from XamGridComponent

Defined in XamGridComponent:4936

Helper method for creating event params.

Returns : any

Private createRow

createRow(row: RowType)

Inherited from XamGridComponent

Defined in XamGridComponent:5222

Create or returns a cached row model from a rowType. Could be a data row or a addNew row.

Parameters :

Name	Type	Optional
row	`RowType`	No

Returns : any

Private createRowFromData

createRowFromData(data: any, index: number)

Inherited from XamGridComponent

Defined in XamGridComponent:5364

Create row from data

Parameters :

Name	Type	Optional
data	`any`	No
index	`number`	No

Returns : any

dataChangedHandler

dataChangedHandler(event: any)

Inherited from XamGridComponent

Defined in XamGridComponent:2233

Handler triggered after the data has changed Emitted after a data operation, rebinding, pagination, etc

Parameters :

Name	Type	Optional
event	`any`	No

Returns : void

dataHandler

dataHandler()

Inherited from XamGridComponent

Defined in XamGridComponent:2012

Returns data

Returns : any[]

Private deselectGridRows

deselectGridRows(sender: any, newEventArgs: SelectionCollectionChangedEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:5424

Deselects the rows from the main grid and column layouts grids.

Parameters :

Name	Type	Optional
sender	`any`	No
newEventArgs	`SelectionCollectionChangedEventArgs<SelectedRowsCollection>`	No

Returns : void

doubleClickHandler

doubleClickHandler(event: IGridCellEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2879

Double-click event handler.

Parameters :

Name	Type	Optional
event	`IGridCellEventArgs`	No

Returns : void

endRowEdit

endRowEdit(commit, event?: Event)

Inherited from XamGridComponent

Defined in XamGridComponent:2079

Ends row editing and triggers the event pipeline.

Parameters :

Name	Type	Optional	Default value
commit		No	`true`
event	`Event`	Yes

Returns : void

enterEditHandler

enterEditHandler(event: IGridEditEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3429

Cell entering edit mode handler

Parameters :

Name	Type	Optional
event	`IGridEditEventArgs`	No

Returns : void

evaluateAutoColumns

evaluateAutoColumns()

Inherited from XamGridComponent

Defined in XamGridComponent:4110

Evaluate for which auto columns is neccesary to apply autosize.

Returns : void

evaluateColumnDataErrors

evaluateColumnDataErrors(data: any)

Inherited from XamGridComponent

Defined in XamGridComponent:3600

Validates if there are columns with errors

Parameters :

Name	Type	Optional
data	`any`	No

Returns : string

evaluateColumns

evaluateColumns()

Inherited from XamGridComponent

Defined in XamGridComponent:4158

Evaluate columns to apply width

Returns : void

executeInitializeRowSequence

executeInitializeRowSequence()

Inherited from XamGridComponent

Defined in XamGridComponent:5825

"For each row in the model, fire the InitializeRow event, then for each cell in the row, fire the CellControlAttached event."

memberof XamGridComponent

Returns : void

exitEditHandler

exitEditHandler(event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3541

Cell exiting edit mode handler

Parameters :

Name	Type	Optional
event	`IGridEditDoneEventArgs`	No

Returns : void

Private exitEditOnRowChanged

exitEditOnRowChanged(newRowIndex: number)

Inherited from XamGridComponent

Defined in XamGridComponent:5055

Exits edit mode on row changed

Parameters :

Name	Type	Optional
newRowIndex	`number`	No

Returns : void

filteringHandler

filteringHandler(event: IFilteringExpressionsTree)

Inherited from XamGridComponent

Defined in XamGridComponent:2246

Filtering handler

Parameters :

Name	Type	Optional
event	`IFilteringExpressionsTree`	No

Returns : void

findElement

findElement(element: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5149

If the element has children, return the first child that doesn't have the class 'validationCornerError'.

Parameters :

Name	Type	Optional	Description
element	`any`	No	any - the element that you want to find the child of

Returns : Element | null

the child element that is not a validationCornerError.

forceRevalidation

forceRevalidation()

Inherited from XamGridComponent

Defined in XamGridComponent:3172

Calling this function produces the necessary event to execute the validations of the cell being edited. When used, the cellEditHandler function will be called

Returns : void

Protected generateColumnModels

generateColumnModels()

Inherited from XamGridComponent

Defined in XamGridComponent:4038

Generates XamColumn instances and the corresponding column models for them.

Returns : void

Protected generateDataFields

generateDataFields(data: any[])

Inherited from XamGridComponent

Defined in XamGridComponent:4028

Try to infer the 'shape' of the objects in the passed data array and to generate the columns based on that.

Parameters :

Name	Type	Optional
data	`any[]`	No

Returns : string[]

{string[]}

Private getAddedRow

getAddedRow(event: IGridEditEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2359

Returns the row created from the data

Parameters :

Name	Type	Optional
event	`IGridEditEventArgs`	No

Returns : void

getAddRow

getAddRow()

Inherited from XamGridComponent

Defined in XamGridComponent:5276

Get the addNewRow position in the grid

Returns : any

{*}

getAllColumns

getAllColumns(columns?: ColumnBaseCollection | GroupColumnsCollection)

Inherited from XamGridComponent

Defined in XamGridComponent:5304

Get all columns

Parameters :

Name	Type	Optional
columns	`ColumnBaseCollection \| GroupColumnsCollection`	Yes

Returns : ColumnBaseCollection

getCellByRowColumn

getCellByRowColumn(rowIndex: number, column: string)

Inherited from XamGridComponent

Defined in XamGridComponent:5330

Get a cell throuht it row and column.

Parameters :

Name	Type	Optional
rowIndex	`number`	No
column	`string`	No

Returns : any

Private getCellControlIfExists

getCellControlIfExists(cell: () => void, cellModel: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5076

Gets cell control if it exists.

Parameters :

Name	Type	Optional
cell	`function`	No
cellModel	`any`	No

Returns : any

Private getCellElementByEvent

getCellElementByEvent(event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:5632

Gets the cell associated with the given event.

Parameters :

Name	Type	Optional
event	`IGridEditDoneEventArgs`	No

Returns : any

{*}

Protected getColumnCalcPixelWidth

getColumnCalcPixelWidth(col: IgxColumnComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:4418

Gets the column current used pixel width

Parameters :

Name	Type	Optional
col	`IgxColumnComponent`	No

Returns : any

getColumnGroup

getColumnGroup(col: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:2839

Returns columns from a column group

Parameters :

Name	Type	Optional
col	`XamGridColumnModel`	No

Returns : GroupColumnsCollection

Private getColumnKey

getColumnKey(key: string)

Inherited from XamGridComponent

Defined in XamGridComponent:4979

Gets the column key

Parameters :

Name	Type	Optional
key	`string`	No

Returns : any

Private getColumnModelByKey

getColumnModelByKey(key: string, searchInGroups)

Inherited from XamGridComponent

Defined in XamGridComponent:4948

Returns a column model by key, if found.

Parameters :

Name	Type	Optional	Default value
key	`string`	No
searchInGroups		No	`false`

Returns : XamGridColumnModel | undefined

{(XamGridColumnModel | undefined)}

getColumns

getColumns()

Inherited from XamGridComponent

Defined in XamGridComponent:2828

Returns columns from model.

Returns : any

{*}

getFilterable

getFilterable(col: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:5988

Returns true if the column IsFilterable and AllowFiltering is true for the grid model. Otherwise, return false.

Parameters :

Name	Type	Optional	Description
col	`XamGridColumnModel`	No	XamGridColumnModel - The column model that is evaluated.

Returns : any

boolean.

getFilteringCells

getFilteringCells()

Inherited from XamGridComponent

Defined in XamGridComponent:5044

Gets filtering cell DOM elements

Returns : any

NodeList

Protected getGridRemainSpaceInfo

getGridRemainSpaceInfo()

Inherited from XamGridComponent

Defined in XamGridComponent:4363

Gets the remaining available space

Returns : {}

getGridSelectionMode

getGridSelectionMode(selection: string)

Inherited from XamGridComponent

Defined in XamGridComponent:6034

Gets GridSelectionMode depending of the selection value

Parameters :

Name	Type	Optional
selection	`string`	No

Returns : GridSelectionMode

GridSelectionMode

getModelToUse

getModelToUse(control: any, element: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5123

Returns model for content use

Parameters :

Name	Type	Optional
control	`any`	No
element	`any`	No

Returns : any

getNativeElement

getNativeElement(cell: CellType)

Inherited from XamGridComponent

Defined in XamGridComponent:5022

Returns the DOM element of the cell

Parameters :

Name	Type	Optional
cell	`CellType`	No

Returns : any

{*}

Public getPaginationComponent

getPaginationComponent()

Inherited from XamGridComponent

Defined in XamGridComponent:1716

Gets the PagerSettingsComponent reference.

Returns : any

Public getRowFromFilteredDataByKey

getRowFromFilteredDataByKey(rowSelector: any)

Inherited from XamGridComponent

Defined in XamGridComponent:1688

Get row from filtered data by key

Parameters :

Name	Type	Optional
rowSelector	`any`	No

Returns : XamGridRow

Public getRowFromModelByKey

getRowFromModelByKey(rowSelector: any, component: XamGridComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1660

Gets row from model by key

Parameters :

Name	Type	Optional
rowSelector	`any`	No
component	`XamGridComponent`	No

Returns : XamGridRow

Protected getRowIndex

getRowIndex(row: XamGridRow)

Inherited from XamGridComponent

Defined in XamGridComponent:3993

Get row index

Parameters :

Name	Type	Optional
row	`XamGridRow`	No

Returns : number

Protected getRowIndexFromFilteredData

getRowIndexFromFilteredData(row: XamGridRow)

Inherited from XamGridComponent

Defined in XamGridComponent:4006

Get row index from filtered data

Parameters :

Name	Type	Optional
row	`XamGridRow`	No

Returns : number

getStrategy

getStrategy(col: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:5976

If the column has a SortComparer, return it. Otherwise, return null.

Parameters :

Name	Type	Optional	Description
col	`XamGridColumnModel`	No	XamGridColumnModel - The column model that is being sorted.

Returns : any

The comparer function that will be used to sort the column.

gridDataHandler

gridDataHandler()

Inherited from XamGridComponent

Defined in XamGridComponent:1995

Handler used to fill grid data when is required

Returns : void

gridScrollHandler

gridScrollHandler(event: IGridScrollEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2215

Handler triggered on scroll event Be aware this event is called several times per scroll

Parameters :

Name	Type	Optional
event	`IGridScrollEventArgs`	No

Returns : void

hasSummary

hasSummary(column: any)

Inherited from XamGridComponent

Defined in XamGridComponent:3819

Determine if the column has sumamry

Parameters :

Name	Type	Optional
column	`any`	No

Returns : boolean

boolean

hasValidationErrors

hasValidationErrors(row: XamGridRow)

Inherited from XamGridComponent

Defined in XamGridComponent:3648

Validates if the row currently has any validation errors

Parameters :

Name	Type	Optional
row	`XamGridRow`	No

Returns : boolean

internalColumnLayoutRowSelectionHandler

internalColumnLayoutRowSelectionHandler(sender: any, e: SelectionCollectionChangedEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3012

Internal row selection event handler for column layout.

Parameters :

Name	Type	Optional
sender	`any`	No
e	`SelectionCollectionChangedEventArgs<SelectedRowsCollection>`	No

Returns : void

Protected invalidateInternalDataWrapper

invalidateInternalDataWrapper()

Inherited from XamGridComponent

Defined in XamGridComponent:4016

Clears the internal data wrapper. On the next rebind of the grid data from the dataHandler method the internal wrapper will be populated.

Returns : void

InvalidateSelectionAndActivation

InvalidateSelectionAndActivation(isSelectingCell)

Inherited from XamGridComponent

Defined in XamGridComponent:2759

Validates the selectedRows and update the collection if it's necessary while is handling collection changes

Parameters :

Name	Optional	Default value	Description
isSelectingCell	No	`false`	boolean - flag to tell if its selecting a cell while is handling collection changes

Returns : void

Public isCellInEditMode

isCellInEditMode()

Inherited from XamGridComponent

Defined in XamGridComponent:3927

Returns true if the cell is in EditMode

Returns : boolean

Public isCellOrRowInEditMode

isCellOrRowInEditMode()

Inherited from XamGridComponent

Defined in XamGridComponent:3914

Returns true if the cell or row is in EditMode

Returns : boolean

isEditable

isEditable(column: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:3793

Determinate if the column is a editable column

Parameters :

Name	Type	Optional
column	`XamGridColumnModel`	No

Returns : boolean

boolean

isNewRow

isNewRow(row: RowType)

Inherited from XamGridComponent

Defined in XamGridComponent:5265

Validate if the row is an add new Row type.

Parameters :

Name	Type	Optional	Description
row	`RowType`	No	New row.

Returns : boolean

{boolean} true if the row is an add new row Type.

keydownHandler

keydownHandler(e: IGridKeydownEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3065

Keydown event handler.

Parameters :

Name	Type	Optional
e	`IGridKeydownEventArgs`	No

Returns : void

lostFocusTextPerPage

lostFocusTextPerPage()

Inherited from XamGridComponent

Defined in XamGridComponent:5908

Lost focus handler for page size change control textarea

Returns : void

modelChangeHandler

modelChangeHandler(name?: string, args?: any)

Inherited from BaseComponent

Defined in BaseComponent:2602

Detects if there are changes on the model.

Parameters :

Name	Type	Optional
name	`string`	Yes
args	`any`	Yes

Returns : void

navigateToCell

navigateToCell(cellType: CellType)

Inherited from XamGridComponent

Defined in XamGridComponent:3731

Navigates and focus the content of a cell.

Parameters :

Name	Type	Optional
cellType	`CellType`	No

Returns : void

Public ngAfterContentChecked

ngAfterContentChecked()

Inherited from BaseComponent

Defined in BaseComponent:2435

Usable for the grid to know when the style has changed and need to call the AlignmentPipe

Returns : void

ngAfterContentInit

ngAfterContentInit()

Inherited from BaseComponent

Defined in BaseComponent:1726

Angular lifecycle hook. Generates column models if needed and adds then to the 'silverlight' model.

Returns : void

ngAfterViewChecked

ngAfterViewChecked()

Inherited from BaseComponent

Defined in BaseComponent:1814

Angular lifecycle hook.

Returns : void

ngAfterViewInit

ngAfterViewInit()

Inherited from BaseComponent

Defined in BaseComponent:1797

Angular lifecycle hook.

Returns : void

Public ngDoCheck

ngDoCheck()

Inherited from BaseComponent

Defined in BaseComponent:2449

Angular lifecycle hook. Use to apply the style over the cells and rows In charge of triggering the first and any other re-evaluation of the columns width calculation

Returns : void

ngOnDestroy

ngOnDestroy()

Inherited from BaseComponent

Defined in BaseComponent:2027

Angular lifecycle hook. Removes all the event listeners for the disabled overlay.

Returns : void

paginationHandler

paginationHandler(event: IPageEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2397

Pagination handler for the control

Parameters :

Name	Type	Optional
event	`IPageEventArgs`	No

Returns : void

pagingHandler

pagingHandler()

Inherited from XamGridComponent

Defined in XamGridComponent:3753

Paging handler

Returns : boolean

true if handler paging is applied

pinningHandler

pinningHandler(event: IPinColumnEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2295

Column pinning handler

Parameters :

Name	Type	Optional
event	`IPinColumnEventArgs`	No

Returns : void

populateModel

populateModel(dataItem: any, index: number)

Inherited from XamGridComponent

Defined in XamGridComponent:1769

Returns a new model for the details XamGrid.

Parameters :

Name	Type	Optional
dataItem	`any`	No
index	`number`	No

Returns : any

processActiveCell

processActiveCell(isOnCellActiveEditingEnabled: boolean, isReadOnly: boolean)

Inherited from XamGridComponent

Defined in XamGridComponent:5860

Set the Active Cell in editMode if the conditions are met

Parameters :

Name	Type	Optional
isOnCellActiveEditingEnabled	`boolean`	No
isReadOnly	`boolean`	No

Returns : void

Private processAllowToolTips

processAllowToolTips(cell: CellType, model: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:5525

Auxiliary function that defines the cell's tooltip by changing the cell's element title property

Parameters :

Name	Type	Optional
cell	`CellType`	No
model	`XamGridColumnModel`	No

Returns : void

Private processAllowToolTipsByColumn

processAllowToolTipsByColumn(column: IgxColumnComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:5488

Defines whether to show or not the cell tooltip by changing the title property

Parameters :

Name	Type	Optional
column	`IgxColumnComponent`	No

Returns : void

Private processAllowToolTipsByRow

processAllowToolTipsByRow()

Inherited from XamGridComponent

Defined in XamGridComponent:5506

Process AllowToolTip property for all visible rows

Returns : void

processAutosize

processAutosize(columns: IgxColumnComponent[])

Inherited from XamGridComponent

Defined in XamGridComponent:4138

Asyncronously apply autosize to the given columns.

Parameters :

Name	Type	Optional
columns	`IgxColumnComponent[]`	No

Returns : void

Private processColumnLayoutForRowSelection

processColumnLayoutForRowSelection(oldRows: XamGridRow[])

Inherited from XamGridComponent

Defined in XamGridComponent:5394

Process column layout when a row is selected

Parameters :

Name	Type	Optional
oldRows	`XamGridRow[]`	No

Returns : void

processDefaultHeaderStyle

processDefaultHeaderStyle()

Inherited from XamGridComponent

Defined in XamGridComponent:2680

Process undefined headerstyle for new columns

Returns : void

processEditableColumn

processEditableColumn(column: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:3833

Determinate if the column is a editable column when the grid is in edit mode

Parameters :

Name	Type	Optional
column	`XamGridColumnModel`	No

Returns : boolean

{boolean}

processElementComponent

processElementComponent(component: any, control: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5102

Returns component model with tooltip handler

Parameters :

Name	Type	Optional
component	`any`	No
control	`any`	No

Returns : any

Private processFilterCellTooltip

processFilterCellTooltip()

Inherited from XamGridComponent

Defined in XamGridComponent:5342

Process filtering columns to add a filter tooltip

Returns : void

processFooterStyle

processFooterStyle(stylePlan: StylePlan, element: Element, footerStyle: RuntimeStyleInfo)

Inherited from XamGridComponent

Defined in XamGridComponent:1868

Process the given footer style into the style plan.

Parameters :

Name	Type	Optional
stylePlan	`StylePlan`	No
element	`Element`	No
footerStyle	`RuntimeStyleInfo`	No

Returns : void

processGridSelections

processGridSelections(name: string)

Inherited from XamGridComponent

Defined in XamGridComponent:2631

When SelectedItem is changed verify Grid Selections.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processHeaderStyle

processHeaderStyle(name: string)

Inherited from XamGridComponent

Defined in XamGridComponent:2667

Apply the style changes for each column.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processInnerSpans

processInnerSpans(stylePlan: StylePlan, element: Element, setter: Setter)

Inherited from XamGridComponent

Defined in XamGridComponent:1901

Add inner span elements into style plan, instead of the given element.

Parameters :

Name	Type	Optional
stylePlan	`StylePlan`	No
element	`Element`	No
setter	`Setter`	No

Returns : void

processItemSource

processItemSource(name: string)

Inherited from XamGridComponent

Defined in XamGridComponent:2647

When itemSource is changed igxGrid reassign the data.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processItemsSourceChange

processItemsSourceChange(name: string, args: DependencyPropertyChangedEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2696

Unregister and clear collectionHandler when ItemsSource changes.

Parameters :

Name	Type	Optional
name	`string`	No
args	`DependencyPropertyChangedEventArgs`	No

Returns : void

Private processPreviousSelectedRows

processPreviousSelectedRows(sender: any, newEventArgs: SelectionCollectionChangedEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:5447

Process previous selected rows when a row is selected in a column layout.

Parameters :

Name	Type	Optional
sender	`any`	No
newEventArgs	`SelectionCollectionChangedEventArgs<SelectedRowsCollection>`	No

Returns : void

Private processRowCells

processRowCells(row: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5209

Create dn select a new XamGridRow

Parameters :

Name	Type	Optional
row	`any`	No

Returns : void

Private processTabCode

processTabCode(event: KeyboardEvent)

Inherited from XamGridComponent

Defined in XamGridComponent:3210

Processes the Keyboard event when the code is for the Tab key

Parameters :

Name	Type	Optional
event	`KeyboardEvent`	No

Returns : void

processTriggerExitEditMode

processTriggerExitEditMode(name: string, commit: any)

Inherited from XamGridComponent

Defined in XamGridComponent:2744

Triggers the endEdit for the grid to allow changes to be handled

Parameters :

Name	Type	Optional
name	`string`	No
commit	`any`	No

Returns : void

Protected registerCellControl

registerCellControl(row: any)

Inherited from XamGridComponent

Defined in XamGridComponent:4858

Parameters :

Name	Type	Optional
row	`any`	No

Returns : void

registerHandlerForObservablesCollection

registerHandlerForObservablesCollection()

Inherited from XamGridComponent

Defined in XamGridComponent:1912

Returns : void

removeAllErrorMessages

removeAllErrorMessages()

Inherited from XamGridComponent

Defined in XamGridComponent:5577

Removes error messages from all cells.

Returns : void

removeErrorMessageOnCell

removeErrorMessageOnCell(event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:5566

Removes the error message from the cell asociated with event, if there is any.

Parameters :

Name	Type	Optional
event	`IGridEditDoneEventArgs`	No

Returns : void

Private removeItemSourceHandler

removeItemSourceHandler()

Inherited from XamGridComponent

Defined in XamGridComponent:5379

Remove the attached subscription

Returns : void

Protected removeModel

removeModel(models: XamGridColumnModel[], model: XamGridColumnModel)

Inherited from XamGridComponent

Defined in XamGridComponent:4331

Removes model from the models array.

Parameters :

Name	Type	Optional
models	`XamGridColumnModel[]`	No
model	`XamGridColumnModel`	No

Returns : void

removeValidationHelper

removeValidationHelper(element: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5591

Removes the validation helper from an element, if it exists.

Parameters :

Name	Type	Optional
element	`any`	No

Returns : void

renderedHandler

renderedHandler()

Inherited from XamGridComponent

Defined in XamGridComponent:2098

Event emitted when the underlying igx-grid is considered 'ready' in the DOM.

Returns : void

renderFooters

renderFooters()

Inherited from XamGridComponent

Defined in XamGridComponent:2136

Renders and rebinds the context for the footers of the Xam grid.

Returns : void

resetRows

resetRows()

Inherited from XamGridComponent

Defined in XamGridComponent:2802

Reset the rows

Returns : void

resetScrollPosition

resetScrollPosition()

Inherited from XamGridComponent

Defined in XamGridComponent:2816

Reset the scroll position: vertical scroll resets to top and horizontal scroll resets to left.

Returns : void

resizeHandler

resizeHandler(event: any)

Inherited from XamGridComponent

Defined in XamGridComponent:3232

Column resize event handler.

Parameters :

Name	Type	Optional
event	`any`	No

Returns : void

resolveCellDataContext

resolveCellDataContext(cellModel: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5171

Returns cell DataContext

Parameters :

Name	Type	Optional
cellModel	`any`	No

Returns : any

Private resolveUnboundColumnDataContext

resolveUnboundColumnDataContext(cellModel: any)

Inherited from XamGridComponent

Defined in XamGridComponent:5184

Creates a new UnboundColumnDataContext when the resolver is not defined otherwise just change the existing DataContext value.

Parameters :

Name	Type	Optional
cellModel	`any`	No

Returns : UnboundColumnDataContext

rowAddedHandler

rowAddedHandler(event: IGridEditEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2325

Row added handler

Parameters :

Name	Type	Optional
event	`IGridEditEventArgs`	No

Returns : void

Private RowCollectionHandler

RowCollectionHandler(isRendering)

Inherited from XamGridComponent

Defined in XamGridComponent:5789

Triggers a collection changed for each row

Parameters :

Name	Optional	Default value
isRendering	No	`false`

Returns : void

rowDefined

rowDefined()

Inherited from XamGridComponent

Defined in XamGridComponent:2089

Returns if row is defined

Returns : boolean

{boolean}

rowDeletedHandler

rowDeletedHandler(event: IRowDataEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:2373

Row deleted handler

Parameters :

Name	Type	Optional
event	`IRowDataEventArgs`	No

Returns : void

rowEditHandler

rowEditHandler(event: any)

Inherited from XamGridComponent

Defined in XamGridComponent:3380

RowEdit handler catches if state error is true and cancel enter edition

Parameters :

Name	Type	Optional
event	`any`	No

Returns : void

rowEnterEditHandler

rowEnterEditHandler(event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3683

Row exiting edit mode handler

Parameters :

Name	Type	Optional
event	`IGridEditDoneEventArgs`	No

Returns : void

rowExitEditHandler

rowExitEditHandler(event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3660

Row exiting edit mode handler

Parameters :

Name	Type	Optional
event	`IGridEditDoneEventArgs`	No

Returns : void

rowSelectionHandler

rowSelectionHandler(event: any)

Inherited from XamGridComponent

Defined in XamGridComponent:2931

Row selection event handler.

Parameters :

Name	Type	Optional
event	`any`	No

Returns : void

scrollCellIntoViewHandler

scrollCellIntoViewHandler(cell: XamGridCell)

Inherited from XamGridComponent

Defined in XamGridComponent:2617

Handler for the ScrollIntoView method

Parameters :

Name	Type	Optional
cell	`XamGridCell`	No

Returns : void

Private selectInputTextIfTextColumnDefault

selectInputTextIfTextColumnDefault(cell: XamGridCell, cellQuery: string)

Inherited from XamGridComponent

Defined in XamGridComponent:3517

If the cell is a text column, select the text in the input

Parameters :

Name	Type	Optional	Description
cell	`XamGridCell`	No	XamGridCell - the cell that is being edited
cellQuery	`string`	No	string - the query selector for the cell

Returns : void

Protected setColumnProperties

setColumnProperties(collection: any)

Inherited from XamGridComponent

Defined in XamGridComponent:4466

Set column properties based on the data grid model setting objects. Called only once, during rendering.

Parameters :

Name	Type	Optional
collection	`any`	No

Returns : void

Protected setColumnsToMinimumWidth

setColumnsToMinimumWidth(starColumnModels: XamGridColumnModel[])

Inherited from XamGridComponent

Defined in XamGridComponent:4349

Sets widths to MinimumWidth (or '0' if MinimumWidth is not available) for all given columns.

Parameters :

Name	Type	Optional
starColumnModels	`XamGridColumnModel[]`	No

Returns : void

Protected setColumnsWidth

setColumnsWidth(isRendering)

Inherited from XamGridComponent

Defined in XamGridComponent:4096

Called once after rendering of the XamGrid. Setups the width property for the column models based on the grid ColumnWidth property. It is a no-op for Auto, InitialAuto and Star width values.

Parameters :

Name	Optional	Default value
isRendering	No	`false`

Returns : void

Protected setColumnWidthSpecialCase

setColumnWidthSpecialCase(col: any, columnWidth: ColumnWidth)

Inherited from XamGridComponent

Defined in XamGridComponent:4430

Sets the igx column size for special scenarios using autosize

Parameters :

Name	Type	Optional
col	`any`	No
columnWidth	`ColumnWidth`	No

Returns : boolean

Private setParentRow

setParentRow(model: XamGridModel, rowInternalIndex: any)

Inherited from XamGridComponent

Defined in XamGridComponent:6017

Sets the parent row property of nested rows

Parameters :

Name	Type	Optional	Description
model	`XamGridModel`	No	Model that contains the nested rows
rowInternalIndex	`any`	No	The parent row internal index data

Returns : void

setReCalcColumnsValues

setReCalcColumnsValues(hasStarValues: boolean, failedSpecialCases: boolean)

Inherited from XamGridComponent

Defined in XamGridComponent:4192

Sets if the current columns should recalculated.

Parameters :

Name	Type	Optional
hasStarValues	`boolean`	No
failedSpecialCases	`boolean`	No

Returns : void

Protected setsColumnsToNumericValues

setsColumnsToNumericValues()

Inherited from XamGridComponent

Defined in XamGridComponent:4396

Sets the columns width to numeric values when resizing from UI. All columns should be resized to a numeric value.

Returns : void

Protected setupAvailableRows

setupAvailableRows()

Inherited from XamGridComponent

Defined in XamGridComponent:4841

For each available row at rendering it will register its cells.

Returns : void

Protected setupCellTracker

setupCellTracker()

Inherited from XamGridComponent

Defined in XamGridComponent:4799

Creates the tracking needed for the even emitter when a new cell has entered the view.

Returns : void

Protected setupColumnMovingSettings

setupColumnMovingSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4573

Applies grid column moving settings from template directive if defined.

Returns : void

{void}

Protected setupColumnResizing

setupColumnResizing()

Inherited from XamGridComponent

Defined in XamGridComponent:4558

Applies column resizing settings from template directive if defined.

Returns : void

{void}

Protected setupColumnTracking

setupColumnTracking()

Inherited from XamGridComponent

Defined in XamGridComponent:4059

Setup the handling of dynamic adding/removing of columns in XamGrid and keeping both models in sync.

Returns : void

Protected setupDisabledOverlay

setupDisabledOverlay()

Inherited from XamGridComponent

Defined in XamGridComponent:4891

Workaround for the IsEnabled property. The listeners here are registered in the capture phase.

Returns : void

Protected setupEditingSettings

setupEditingSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4519

Applies grid editing settings from template directive if defined.

Returns : void

{void}

Protected setupFilteringExpressions

setupFilteringExpressions()

Inherited from XamGridComponent

Defined in XamGridComponent:4667

Synchronize the grid filteringExpressions with the model FilteringSettings.

Returns : void

{void}

Protected setupFilteringSettings

setupFilteringSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4588

Applies grid filtering settings from template directive if defined.

Returns : void

{void}

Protected setupGridSettings

setupGridSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4781

Applies Xam grid settings defined in the context of the xam grid as template bindings

Returns : void

Protected setupPaginationSettings

setupPaginationSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4730

Applies grid pagination settings from template directive if defined.

Returns : void

{void}

Protected setupRowSelectorsSettings

setupRowSelectorsSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4758

Enables row selectors settings from template directive if defined.

Returns : void

Protected setupSelectionSettings

setupSelectionSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4502

Applies grid selection settings from template directive if defined.

Returns : void

{void}

Protected setupSortedColumns

setupSortedColumns()

Inherited from XamGridComponent

Defined in XamGridComponent:4618

Synchronize the grid sortingExpressions with the model SortingSettings.

Returns : void

{void}

Protected setupSortingSettings

setupSortingSettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4603

Synchronize the grid SortingSettings with the model SortingSettings.

Returns : void

{void}

Protected setupSummarySettings

setupSummarySettings()

Inherited from XamGridComponent

Defined in XamGridComponent:4717

Applies grid summary settings from template directive if defined.

Returns : void

{void}

Private shouldInvalidateActiveCell

shouldInvalidateActiveCell(itemsSource1: any)

Inherited from XamGridComponent

Defined in XamGridComponent:6002

"If the itemsSource is null or empty, or the active cell's row index is greater than the number of items in the itemsSource, or the active cell's row data is not in the itemsSource, then return true."

Parameters :

Name	Type	Optional	Description
itemsSource1	`any`	No	The data source for the grid.

Returns : boolean

The return value is a boolean.

Private shouldReCalcColumnsWidth

shouldReCalcColumnsWidth()

Inherited from XamGridComponent

Defined in XamGridComponent:5729

Indicates if the columns width calculation mechanism should be trigger again

Returns : boolean

showErrorMessageOnCell

showErrorMessageOnCell(msg: string, event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:5554

Display an error message on the cell asociated with event.

Parameters :

Name	Type	Optional
msg	`string`	No
event	`IGridEditDoneEventArgs`	No

Returns : void

sortingDoneHandler

sortingDoneHandler(event: ISortingExpression | ISortingExpression[], singleColumn)

Inherited from XamGridComponent

Defined in XamGridComponent:2186

Sorting Done handler, it is called when the sorting is done in the igx-grid The code syncs the sorting expressions with the XamGrid.model.SortingSettings.SortedColumns Also call the columnSorted event.

Parameters :

Name	Type	Optional	Default value
event	`ISortingExpression \| ISortingExpression[]`	No
singleColumn		No	`true`

Returns : void

sortingHandler

sortingHandler(e: any)

Inherited from XamGridComponent

Defined in XamGridComponent:2149

Called whenever sorting action is done Avoids the sorting 'None' state

Parameters :

Name	Type	Optional
e	`any`	No

Returns : void

stopClickOutsideCell

stopClickOutsideCell()

Inherited from XamGridComponent

Defined in XamGridComponent:3158

If AllowEditing is on Cell type and there is a error message on the active cell, prevent clicks on components in edit mode on table data

Returns : boolean

{boolean}

Protected syncFilteringExpressions

syncFilteringExpressions()

Inherited from XamGridComponent

Defined in XamGridComponent:4684

Sets the grid filteringExpressions based on the info of the model.

Returns : void

{void}

synchronizeRowCell

synchronizeRowCell()

Inherited from XamGridComponent

Defined in XamGridComponent:2994

Synchronize row

Returns : void

Protected syncSortedColumns

syncSortedColumns()

Inherited from XamGridComponent

Defined in XamGridComponent:4636

Sets the grid sortingExpressions based on the model information.

Returns : void

{void}

tabKeyListener

tabKeyListener(event: KeyboardEvent)

Decorators :

@HostListener('keydown', ['$event'])

Inherited from XamGridComponent

Defined in XamGridComponent:3188

Listener for tab keydown event Needs to be done in host listener to trigger even in not editable cells

Parameters :

Name	Type	Optional
event	`KeyboardEvent`	No

Returns : void

Private tabKeyNavigation

tabKeyNavigation(isShift: boolean)

Inherited from XamGridComponent

Defined in XamGridComponent:5744

Manages the tab key navigation for the grid cells

Parameters :

Name	Type	Optional	Description
isShift	`boolean`	No	if the shift key is being pressed

Returns : void

totalPagingRecordsHandler

totalPagingRecordsHandler()

Inherited from XamGridComponent

Defined in XamGridComponent:3859

Returns number of total items.

Returns : number

{number}

updateRowsWithFilterResults

updateRowsWithFilterResults()

Inherited from XamGridComponent

Defined in XamGridComponent:2276

Returns : void

validateDataErrorInfo

validateDataErrorInfo(data: any, columnName: string, event: IGridEditDoneEventArgs)

Inherited from XamGridComponent

Defined in XamGridComponent:3762

Validates if data implements IDataErrorInfo and checks for errors.

Parameters :

Name	Type	Optional
data	`any`	No
columnName	`string`	No
event	`IGridEditDoneEventArgs`	No

Returns : void

Public validateLimits

validateLimits(type: XamGridColumnType, result: literal type)

Inherited from XamGridComponent

Defined in XamGridComponent:3966

Validate if a new value is within allowed limits for the given type.

Parameters :

Name	Type	Optional
type	`XamGridColumnType`	No
result	`literal type`	No

Returns : void

{void}

verifyGridSelections

verifyGridSelections()

Inherited from XamGridComponent

Defined in XamGridComponent:1937

Verify grid row selection

Returns : void

Protected alignmentHandler

alignmentHandler()

Inherited from BaseComponent

Defined in BaseComponent:2346

Calculate the values for the grid size behavior from the alignments

Returns : void

Protected assignPendingPropertyValues

assignPendingPropertyValues()

Inherited from BaseComponent

Defined in BaseComponent:2057

Apply pending assignments to properties with property values

Returns : void

calculateActualSize

calculateActualSize(name?: string)

Inherited from BaseComponent

Defined in BaseComponent:1674

If the name is equal to 'calculateActualSize', then call the handlerCalcActualSize function and pass in false to avoid the timer in the function.

memberof BaseComponent

Parameters :

Name	Type	Optional	Description
name	`string`	Yes	The name of the event. memberof BaseComponent

Returns : void

Protected checkAndRegisterCompatibilityBinding

checkAndRegisterCompatibilityBinding(property: DependencyProperty, bindingObjectCandidate: any)

Inherited from BaseComponent

Defined in BaseComponent:2023

Verifies if the given object (bindingObjectCandidate) is a binding object. If so the binding will be registered.

Parameters :

Name	Type	Optional
property	`DependencyProperty`	No
bindingObjectCandidate	`any`	No

Returns : boolean

{boolean} true if the value is a binding info object and if the binding was registered, false if not

Protected checkForStaticResource

checkForStaticResource(property: string, value: any)

Inherited from BaseComponent

Defined in BaseComponent:2043

Checks if the given value is a static resource reference or not, if a reference then the value is queue for later assignment.

Parameters :

Name	Type	Optional	Description
property	`string`	No	the name of the property to check for
value	`any`	No	the property value

Returns : boolean

true if the value is a static resource reference, otherwise false

checkStaticItemInModelCollection

checkStaticItemInModelCollection(collection: any, itemToCheck: any)

Inherited from BaseComponent

Defined in BaseComponent:1889

Checks if the element exists previously in the items collection

Parameters :

Name	Type	Optional	Description
collection	`any`	No	The control items collection
itemToCheck	`any`	No	The static element to be reviewed

Returns : number

number Returns -1 if the item is not present in the items collection otherwise the index value

createElementInRoot

createElementInRoot(injector: Injector, componentToCreate: any)

Inherited from BaseComponent

Defined in BaseComponent:2698

Create a given component on the HTML body.

Parameters :

Name	Type	Optional
injector	`Injector`	No
componentToCreate	`any`	No

Returns : ComponentRef<any>

cursorStyle

cursorStyle()

Inherited from BaseComponent

Defined in BaseComponent:1549

Returns the correct CSS cursor style and sets the definedCursor flag if necessary

Returns : string

{string}

detectChanges

detectChanges()

Inherited from BaseComponent

Defined in BaseComponent:813

Performs a single detect Changes over the component

Returns : void

detectChangesAction

detectChangesAction()

Inherited from BaseComponent

Defined in BaseComponent:1686

Handle subscription to the notifyDetectChanges action Refresh the component whenever a model modification was performed

Returns : void

getForeground

getForeground()

Inherited from BaseComponent

Defined in BaseComponent:1966

Calculates the Foreground color to be applied

Returns : string

string

getImageString

getImageString(value: any)

Inherited from BaseComponent

Defined in BaseComponent:2221

Returns string path to the image.

Parameters :

Name	Type	Optional
value	`any`	No

Returns : any

getTargetValue

getTargetValue(e: Event)

Inherited from BaseComponent

Defined in BaseComponent:2239

Returns the value from a $event

Parameters :

Name	Type	Optional
e	`Event`	No

Returns : string

Protected handlerCalcActualSize

handlerCalcActualSize(async: boolean)

Inherited from BaseComponent

Defined in BaseComponent:2391

Handler that calculates ActualHeight & ActualWidth based on its inner content.

Parameters :

Name	Type	Optional
async	`boolean`	No

Returns : void

heightCalc

heightCalc()

Inherited from BaseComponent

Defined in BaseComponent:1939

Applies the height CSS value

Returns : any

heightDefaultStyle

heightDefaultStyle()

Inherited from BaseComponent

Defined in BaseComponent:1914

Calculates the auto height value

Returns : string

{string}

Protected hostHorizontalAlignmentCall

hostHorizontalAlignmentCall()

Inherited from BaseComponent

Defined in BaseComponent:2374

Assign all the horizontal bindings for the control

Returns : void

Protected hostVerticalAlignmentCall

hostVerticalAlignmentCall()

Inherited from BaseComponent

Defined in BaseComponent:2357

Assign all the vertical bindings for the control

Returns : void

imageToPath

imageToPath(value: any)

Inherited from BaseComponent

Defined in BaseComponent:2202

Returns the path of the given image.

Parameters :

Name	Type	Optional
value	`any`	No

Returns : any

loadStaticItems

loadStaticItems(staticItems: any, itemsCollection: any)

Inherited from BaseComponent

Defined in BaseComponent:1634

Parameters :

Name	Type	Optional	Description
staticItems	`any`	No	The static elements to be added
itemsCollection	`any`	No	The control items collection

Returns : void

void

Private markForCheckComp

markForCheckComp()

Inherited from BaseComponent

Defined in BaseComponent:2451

Marks current component

Returns : void

mouseEnterHandler

mouseEnterHandler(event: any)

Inherited from BaseComponent

Defined in BaseComponent:1982

Event Handler for when the mouse enter the Image component.

Parameters :

Name	Type	Optional	Description
event	`any`	No	event from the DOM event

Returns : void

mouseLeaveHandler

mouseLeaveHandler(event: any)

Inherited from BaseComponent

Defined in BaseComponent:2001

Event Handler for when the mouse enter the Image component.

Parameters :

Name	Type	Optional	Description
event	`any`	No	event from the DOM event

Returns : void

Public ngOnChanges

ngOnChanges()

Inherited from BaseComponent

Defined in BaseComponent:824

Angular Lifecycle Hooks

Returns : void

preventItemsDuplication

preventItemsDuplication(itemsToRender: any, items: any, contentChildTemplate: any, afterContentInitCalled: boolean, injector: Injector)

Inherited from BaseComponent

Defined in BaseComponent:2170

Validates if coming models are the same, and prevents to be recreated on Ribbon DOM. (Needs to be checked, in some statics scenarios RibbonTab, RibbonGroup duplicates items)

Parameters :

Name	Type	Optional
itemsToRender	`any`	No
items	`any`	No
contentChildTemplate	`any`	No
afterContentInitCalled	`boolean`	No
injector	`Injector`	No

Returns : any[]

processAlignments

processAlignments(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1704

Method to check if the component should assign a alignment property

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

{void}

processCursor

processCursor(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1850

Method to set the cursor style of the component

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processCustomCssClasses

processCustomCssClasses(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1723

Method to set custom CSS Clases

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

{void}

processFocusable

processFocusable(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1816

Method to check and set the height of the grid

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

Private processFontFamily

processFontFamily(name: string)

Inherited from BaseComponent

Defined in BaseComponent:2784

Process the FontFamily property

Parameters :

Name	Type	Optional
name	`string`	No

Returns : any

processFonts

processFonts(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1778

Method to apply the font styles for the component.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

Private processFontSize

processFontSize(name: string)

Inherited from BaseComponent

Defined in BaseComponent:2798

Process the FontSize property

Parameters :

Name	Type	Optional
name	`string`	No

Returns : any

Private processFontStyle

processFontStyle(name: string)

Inherited from BaseComponent

Defined in BaseComponent:2815

Process the FontStyle property

Parameters :

Name	Type	Optional
name	`string`	No

Returns : any

Private processFontWeight

processFontWeight(name: string)

Inherited from BaseComponent

Defined in BaseComponent:2832

Process the FontWeight property

Parameters :

Name	Type	Optional
name	`string`	No

Returns : any

processHeights

processHeights(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1797

Method to check and set the height of the grid

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processIsEnabled

processIsEnabled(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1764

Process changes to IsEnabled property.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processOpacity

processOpacity(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1751

Method to apply the opacity for the component.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processVisibility

processVisibility(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1737

Method to check if the component should be show or hide.

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

processWidths

processWidths(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1829

Method to check and set the width of the grid

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

Private processZIndex

processZIndex(name: string)

Inherited from BaseComponent

Defined in BaseComponent:1872

Method to process the ZIndex when set through the model

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

Private recreateInvalidBindings

recreateInvalidBindings()

Inherited from BaseComponent

Defined in BaseComponent:2756

Execution of removeModelProxyHandlers in a previous instance of the component (that used the same model) could have set some bindings in an invalid state, this will check if some of them has to be recreated

Returns : void

Private registerContextMenuActions

registerContextMenuActions(ctxMenu: ContextMenuManager)

Inherited from BaseComponent

Defined in BaseComponent:2533

Enable the contextMenu actions to be displayed when the user perform an action Creates dinamically a new instance of XamContextMenu to be displayed in the screen

Parameters :

Name	Type	Optional
ctxMenu	`ContextMenuManager`	No

Returns : void

Protected registerDomEventListenerOnElement

registerDomEventListenerOnElement(eventName: string, handler: any)

Inherited from BaseComponent

Defined in BaseComponent:2316

Registers a DOM handler on the current element

Parameters :

Name	Type	Optional
eventName	`string`	No
handler	`any`	No

Returns : void

Protected registerHandler

registerHandler(event: SubscriptionEvent<void>, arrowHandler: (s: any,a: any) => void)

Inherited from BaseComponent

Defined in BaseComponent:2298

Parameters :

Name	Type	Optional
event	`SubscriptionEvent<void>`	No
arrowHandler	`function`	No

Returns : void

Protected registerMouseEvents

registerMouseEvents()

Inherited from BaseComponent

Defined in BaseComponent:2272

Registers mouse events if required

Returns : void

Protected registerObservers

registerObservers(emitter: EventEmitter, model: FrameworkElement, event: SubscriptionEvent<void>)

Inherited from BaseComponent

Defined in BaseComponent:2252

Parameters :

Name	Type	Optional
emitter	`EventEmitter<any>`	No
model	`FrameworkElement`	No
event	`SubscriptionEvent<void>`	No

Returns : void

Private registerToolTip

registerToolTip(element: ElementRef, tooltip: ToolTipModel)

Inherited from BaseComponent

Defined in BaseComponent:2607

Registers a tooltip to a component

Parameters :

Name	Type	Optional
element	`ElementRef<any>`	No
tooltip	`ToolTipModel`	No

Returns : void

Private removeModelProxyHandlers

removeModelProxyHandlers()

Inherited from BaseComponent

Defined in BaseComponent:2738

Clean up the handlers when the component is destroyed

Returns : void

Private setComponentForDirectives

setComponentForDirectives()

Inherited from BaseComponent

Defined in BaseComponent:2512

Sets an internal reference through the element ref to access the component in a directive

Returns : void

Protected setPendingPropertyValue

setPendingPropertyValue(property: string, value: any)

Inherited from BaseComponent

Defined in BaseComponent:2336

Stores the pending property values for instance attach properties. Which will be applied when the model is available

Parameters :

Name	Type	Optional
property	`string`	No
value	`any`	No

Returns : void

setupDependencyComponents

setupDependencyComponents(model: FrameworkElement)

Inherited from BaseComponent

Defined in BaseComponent:1612

Adds the references to the dependency components

Parameters :

Name	Type	Optional
model	`FrameworkElement`	No

Returns : void

setupModel

setupModel(model: FrameworkElement)

Inherited from BaseComponent

Defined in BaseComponent:1559

Syncs the modelProxy with model

Parameters :

Name	Type	Optional
model	`FrameworkElement`	No

Returns : void

void

Private syncToolTip

syncToolTip(tooltip: ToolTipModel)

Inherited from BaseComponent

Defined in BaseComponent:2587

Updates the tooltip associated to a component

Parameters :

Name	Type	Optional
tooltip	`ToolTipModel`	No

Returns : void

Private syncValidationError

syncValidationError(name?: string)

Inherited from BaseComponent

Defined in BaseComponent:2766

Syncs validation information with component properties

Parameters :

Name	Type	Optional
name	`string`	Yes

Returns : void

Private tabSelectionSubscription

tabSelectionSubscription()

Inherited from BaseComponent

Defined in BaseComponent:2471

Subscribe to the tabhandler event if Required When the component is inside a tab control it should trigger the load event every time the tab is selected

Returns : void

trackByFn

trackByFn(index: any, item: any)

Inherited from BaseComponent

Defined in BaseComponent:1904

Function used by Angular to track elements in the ngFor directive. We use the GUID property to compare elements.

Parameters :

Name	Type	Optional	Description
index	`any`	No	index of the array
item	`any`	No	item of the array

Returns : any

{*} -return the model or object itself

Private unregisterToolTip

unregisterToolTip(element: ElementRef)

Inherited from BaseComponent

Defined in BaseComponent:2719

Unregisters a tooltip to a component

Parameters :

Name	Type	Optional
element	`ElementRef<any>`	No

Returns : void

Private updateSizePropertiesForActualSizeChange

updateSizePropertiesForActualSizeChange(element: Element)

Inherited from BaseComponent

Defined in BaseComponent:2421

Updates the size properties of the component based on the initial size change

Parameters :

Name	Type	Optional	Description
element	`Element`	No	HTML element

Returns : void

validatesLoadingFlag

validatesLoadingFlag()

Inherited from BaseComponent

Defined in BaseComponent:1519

Validates loading flag for components outside current tab index TabIndexService should be only tabItem provider, and when currentTabId is different from selectedTab IsFirstTimeLoad is set to false because tabService is going to be one in charge to trigger only one time when tab changes.

Returns : void

widthCalc

widthCalc()

Inherited from BaseComponent

Defined in BaseComponent:1953

Applies the width CSS value

Returns : any

widthDefaultStyle

widthDefaultStyle()

Inherited from BaseComponent

Defined in BaseComponent:1926

Calculates the auto width value

Returns : string

{string}

Properties

model

Type : CustomXamGrid

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:46

modelProxy

Type : CustomXamGrid

Default value : ModelProxy.create<CustomXamGrid>()

Inherited from BaseComponent

Defined in BaseComponent:45

activeCellChanged

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:670

Active cell event emitter

Private additionalStyles

Type : HTMLStyleElement

Inherited from XamGridComponent

Defined in XamGridComponent:1511

The html additional styles elements

addNewRow

Type : AddNewRowSettingsComponent

Decorators :


                            @ContentChild(AddNewRowSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1270

Add new row settings if present

addNewRowInheritance

Type : any

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:373

Input from the extended component to fill the addNewRow in the internal xamGrid

addRowKey

Type : RowType

Inherited from XamGridComponent

Defined in XamGridComponent:272

The addRowKey property

Protected adjustPaginator

Default value : () => {...}

Inherited from XamGridComponent

Defined in XamGridComponent:4912

Manipulate the default bottom pager of the grid component to emulate all the values from the PageLocation enumeration.

Parameters :

Name
value

afterCellControlAttached

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:883

Event emitted after the 'new' cells are created

allColumns

Type : ColumnBaseCollection

Inherited from XamGridComponent

Defined in XamGridComponent:5288

The all columns collection

allowChangeItemsPerPage

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:298

Flags to manage when the button for update the items per page

Protected autosizedColumns

Default value : new Set<IgxColumnComponent>()

Inherited from XamGridComponent

Defined in XamGridComponent:1440

Stores the columns which have been autosized during a horizontal scroll event.

Private cachedGridWidth

Type : number

Default value : 0

Inherited from XamGridComponent

Defined in XamGridComponent:1520

Cached latest grid width used to determine if the columns should be calculated again

callProcessActiveCellFlag

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1380

Flag to determine if we need to call the processActiveCell method

cellClicked

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:466

CellClicked eventEmitter.

cellControlAttached

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:874

Event emitted when 'new' cells are entering the view

cellDoubleClicked

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:517

Double-click eventEmitter.

cellEdited

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:661

Cell edited event emitter

cellEditing

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:652

Cell editing event emitter

cellEnteredEditMode

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:607

CellEnteredEditMode

cellEnteringEditMode

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:598

Cell enter edit mode

cellExitedEditMode

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:625

Cell exit edit mode

cellExitingEditMode

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:616

Cell exiting edit mode eventEmitter

cellSelectionChange

Type : EventEmitter<IGridCellEventArgs>

Default value : new EventEmitter<IGridCellEventArgs>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:475

cellSelectionChanged eventEmitter.

cellStyleEnabled

Default value : false

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:336

Flag which indicates if the cell styling is enabled

Protected cellsWithValidationMsg

Default value : new Set<any>()

Inherited from XamGridComponent

Defined in XamGridComponent:1493

Cells which have a validation message attached.

collectionHandler

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1356

Handler for the subscriptionEvent

columnContentTemplate

Type : QueryList<any>

Decorators :


                            @ContentChildren('columnContentTemplate')

Inherited from XamGridComponent

Defined in XamGridComponent:727

Query list of customColumn content.

columnFiltered

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:580

Column filtering eventEmitter

columnFixed

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:589

Column fixed eventEmitter.

columnFixedStateChanged

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:553

column fixed state changed eventEmitter

Public columnLayout

Type : XamColumnLayoutComponent

Decorators :


                            @ContentChild(XamColumnLayoutComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1232

Column layout component if present

columnLayoutInheritance

Type : any

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:365

Input from the extended component to fill the ColumnLayout in the internal xamGrid

Protected columnLayoutModels

Type : SimpleDictionary<any | XamGridModel>

Inherited from XamGridComponent

Defined in XamGridComponent:1467

Columns layout models dictionay

Protected columnMoving

Type : ColumnMovingSettingsComponent

Decorators :


                            @ContentChild(ColumnMovingSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1260

Column moving settings component if present

columnResized

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:535

Column resized eventEmitter.

columnResizing

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:544

Column resizing eventEmitter

columnSelectionChanged

Type : EventEmitter<IColumnSelectionEventArgs>

Default value : new EventEmitter<IColumnSelectionEventArgs>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:499

columnSelectionChange event emitter.

columnSorted

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:562

Event emitted when a column has done applying a sorting

columnSorting

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:571

Column sorting eventEmitter.

defaultBorderColor

Type : string

Default value : '#A3AEB9'

Inherited from XamGridComponent

Defined in XamGridComponent:211

Default XamGrid border color

Private differ

Type : IterableDiffer<XamGridColumnComponent>

Inherited from XamGridComponent

Defined in XamGridComponent:1502

The iterable differ for the XamGridColumnComponents

Protected disabledEventsHandler

Default value : () => {...}

Inherited from XamGridComponent

Defined in XamGridComponent:4876

Disables default browser behavior for events, and stops propagation through the DOM tree.

Parameters :

Name
event

Public editing

Type : EditingSettingsComponent

Decorators :


                            @ContentChild(EditingSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1280

Editing settings component if present

editingInheritance

Type : EditingSettingsComponent

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:381

Input from the extended component to fill the addNewRow in the internal xamGrid

Protected eventManager

Type : XamDataGridEventManager

Inherited from XamGridComponent

Defined in XamGridComponent:1240

Event manager to change the order of certain events

filterCellTooltip

Type : string

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:357

Custom input of xam grid component to add tooltip message to each filter column. Note: Every FilterRowCellControl is going to have the same tooltip, if an specific tooltip should be set to an specific FilterRowCellControl please add new functionality.

Private filteredExpressionsHandler

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1606

Handler for the subscriptionEvent of the filteredExpressions

Protected filtering

Type : FilteringSettingsComponent

Decorators :


                            @ContentChild(FilteringSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1290

Filtering settings component if present

filteringExpressions

Type : IFilteringExpression[] | FilteringExpressionsTree

Default value : []

Inherited from XamGridComponent

Defined in XamGridComponent:1580

Filtering settings for the grid

Private footerStylePlan

Type : StylePlan

Inherited from XamGridComponent

Defined in XamGridComponent:1564

Plan to apply columns footer style.

Private forcedColumnsWidthCalc

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1538

Forces the calculation of the columns width

gridColumnLayout

Type : XamGridComponent

Decorators :


                            @ViewChild('gridColumnLayout')

Inherited from XamGridComponent

Defined in XamGridComponent:241

reference to the internal xamGrid used to replicate the columnLayout feature

Public gridColumnLayouts

Type : QueryList<XamGridComponent>

Decorators :


                            @ViewChildren('gridColumnLayout')

Inherited from XamGridComponent

Defined in XamGridComponent:1222

The internal grid for columnLayout section.

gridColumns

Type : QueryList<XamGridColumnComponent>

Default value : new QueryList<XamGridColumnComponent>()

Decorators :


                            @ContentChildren(XamGridColumnComponent, {read: XamGridColumnComponent, descendants: true})

Inherited from XamGridComponent

Defined in XamGridComponent:718

Query list with XamGridColumnComponent.

gridColumnsInheritance

Type : any

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:408

Input from the extended component to fill the grid columns in the internal xamGrid

Public gridComponent

Type : XamGridComponent

Decorators :


                            @ViewChild(XamGridComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1166

Reference to the component itself in case the control is inherit.

Public gridRef

Type : IgxGridComponent

Decorators :


                            @ViewChild('grid', {read: IgxGridComponent})

Inherited from XamGridComponent

Defined in XamGridComponent:1156

The underlying Angular igx-grid instance.

initializeRow

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:892

Event emitted when the row is initialized

Protected internalData

Type : Array<any>

Inherited from XamGridComponent

Defined in XamGridComponent:1448

Array with data.

Protected internalDataWrapper

Type : []

Default value : []

Inherited from XamGridComponent

Defined in XamGridComponent:1458

Component's collection wrapper that includes a primary key definition that allows the grid to be edited

internalXamGrid

Type : XamGridComponent

Decorators :


                            @ViewChild(XamGridComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:233

reference to the internal grid component when the instance is a inherited grid

Private isActiveCellChanged

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1555

Flag to determine if the active cell changed in the enterEditHandler

isCellChanged

Type : number

Default value : 0

Inherited from XamGridComponent

Defined in XamGridComponent:5295

Value which indicates if a change has occurred in a cell

Private isColumnsWidthSet

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1615

Flag to check when the grid has calculated the first column width

isEvaluatingAutoColumns

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1403

Flag to indicate when autosize is being calculated for auto columns.

isHandlingCollectionChanges

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1417

Flag to indicate when RowCollectionHandler is executing.

isScrollingHorizontal

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1396

Flag to avoid consecutive horizontal scroll events triggered.

isScrollingVertical

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1388

Flag timer to avoid consecutive vertical scroll events triggered

isTabKeyNavigating

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1410

Flags that allow navigating throw cells in edit mode event when there are validation errors

itemsSourceChange

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:788

Event emitter for two-way binding of the itemsSource property.

keyDown

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:508

KeyDown eventEmitter.

lastSortingExpression

Type : ISortingExpression[]

Inherited from XamGridComponent

Defined in XamGridComponent:306

Keeps a reference to last sorting expression to avoid 'None' state

loaded

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:856

Event emitted when the grid is done loading in the DOM

newItemsPerPage

Type : string

Inherited from XamGridComponent

Defined in XamGridComponent:290

New value for items per page.

nextColumnWithErrors

Type : null

Default value : null

Inherited from XamGridComponent

Defined in XamGridComponent:225

Stores the name of the following column with errors

pageIndexChanged

Type : EventEmitter<PageChangedEventArgs>

Default value : new EventEmitter<PageChangedEventArgs>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:706

Page changed event emitter

pageIndexChanging

Type : EventEmitter<CancellablePageChangingEventArgs>

Default value : new EventEmitter<CancellablePageChangingEventArgs>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:697

Page changing event emitter

Protected pagination

Type : PagerSettingsComponent

Decorators :


                            @ContentChild(PagerSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1320

Pagination settings component if present

refreshRowsFilteredTimer

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1425

Flag timer to avoid consecutive update of rows filtered

refreshRowsTimer

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1372

Semaphore timer to avoid consecutive refresh of Rows structure

rendered

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:526

XamGrid rendered eventEmitter.

renderedCalled

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:264

Flag which indicates if the rendered have been called.

Private requiredSpecialValuesSizeReCalc

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:1547

Forces the calculation of the columns width for special values

Protected resizing

Type : ColumnResizingSettingsComponent

Decorators :


                            @ContentChild(ColumnResizingSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1330

Column resizing settings component if present

resolvedCellControlContent

Type : XamGridCellControl[]

Default value : []

Inherited from XamGridComponent

Defined in XamGridComponent:282

Registry of XamGridCellControl which have resolved the content This registry is used to reset the herarchy with the cell template control when scrolling or updated to avoid reference from the control the wrong template

rowAdded

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:679

Row added event emitter

rowDeleted

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:688

Row deleted event emitter

rowEnteredEditMode

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:643

Row entered edit mode

rowExitedEditMode

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:634

Row exit edit mode

Protected rowLimitNoVirtualization

Type : number

Default value : 2000

Inherited from XamGridComponent

Defined in XamGridComponent:1485

Value to limit how many rows are rendered in the DOM when no virtualization is applied This value affects the performance of the grid

Protected rowSelectors

Type : RowSelectorSettingsComponent

Decorators :


                            @ContentChild(RowSelectorSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1340

Row selectors settings component if present

selectedRowChange

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:847

Event emitter for two-way binding of the selectedRow property.

selectedRowsCollectionChanged

Type : EventEmitter<literal type>

Default value :

new EventEmitter<{
    sender: XamGridModel;
    e: SelectionCollectionChangedEventArgs<any>;
  }>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:484

rowSelectionChange eventEmitter.

selectedRowsCollectionHandler

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1364

Selected rows collection handler

Protected selection

Type : SelectionSettingsComponent

Decorators :


                            @ContentChild(SelectionSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1250

Selection settings component if present

sortedColumnsHandler

Type : any

Inherited from XamGridComponent

Defined in XamGridComponent:1348

Handler for the subscriptionEvent of the SortedColumns

sorting

Type : SortingSettingsComponent

Decorators :


                            @ContentChild(SortingSettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1300

Sorting settings component if present

sortingExpressions

Type : ISortingExpression[]

Default value : []

Inherited from XamGridComponent

Defined in XamGridComponent:1572

Sorting settings for the grid

sortingSettingInheritance

Type : SortingSettingsComponent

Decorators :


                            @Input()

Inherited from XamGridComponent

Defined in XamGridComponent:400

Sorting settings from the extended component.

styleChanged

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:257

Flag used to indicate when a row or cell change their style.

Protected summary

Type : SummarySettingsComponent

Decorators :


                            @ContentChild(SummarySettingsComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:1310

Summary settings component if present

toast

Type : IgxToastComponent

Default value : null

Decorators :


                            @ViewChild(IgxToastComponent)

Inherited from XamGridComponent

Defined in XamGridComponent:249

reference to the internal xamGrid used to replicate the columnLayout feature

Private toleranceGridColumnWidth

Type : number

Default value : 18

Inherited from XamGridComponent

Defined in XamGridComponent:1529

Tolerance of grid columns width mechanism

unloaded

Type : EventEmitter<any>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from XamGridComponent

Defined in XamGridComponent:865

Event emitted when the grid is unloading the component

validationErrorFlag

Default value : false

Inherited from XamGridComponent

Defined in XamGridComponent:218

Checks if an error state.

xamTextFilters

Default value : XamGridCustomFilterOperands.instance()

Inherited from XamGridComponent

Defined in XamGridComponent:1432

Additional string filter conditions for the Xam grid.

actualSizeCalled

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:481

Flag to know if the Angular event was called

afterContentInitCalled

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:465

Flag to know if the Angular event was called

afterViewCheckedCalled

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:473

Flag to know if the Angular event was called

afterViewInitCalled

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:457

Flag to know if the Angular event was called

Private bindingValidationCallback

Type : function

Inherited from BaseComponent

Defined in BaseComponent:618

Callback for binding validation

bindingValidationError

Type : EventEmitter<any>

Default value : new EventEmitter()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:114

output to emit the new value of the bindingValidationError event

Private cdRefInjection

Type : ChangeDetectorRef

Inherited from BaseComponent

Defined in BaseComponent:659

Change Detector Reference for the component

Private changeDetectionTimer

Type : any

Inherited from BaseComponent

Defined in BaseComponent:668

A timer to debounce changedetection actions

Protected changeDetectorNotifier

Type : ChangeDectionNotifierService

Inherited from BaseComponent

Defined in BaseComponent:576

Change Detection Notifier Service instace.

Private contextMenuUnlistener

Type : function

Inherited from BaseComponent

Defined in BaseComponent:676

Context Menu event unlisten action.

Private ctxMenuInstance

Type : any

Inherited from BaseComponent

Defined in BaseComponent:630

Reference to the ctxMenuInstance

customCssClasses

Type : string

Default value : null

Decorators :


                            @HostBinding('class')

Inherited from BaseComponent

Defined in BaseComponent:407

Applies custom CSS classes

Private customTooltipInstance

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:641

Reference to the custom tooltip instance this is used to render a popup with custom elements used when the content value is not a string

dataGridRowHeight

Type : number

Default value : 22

Decorators :


                            @Input()

Inherited from BaseComponent

Defined in BaseComponent:507

Represents the row height of both the DataGrid and XamGrid components it affects the css and also an internal function that virtualized data, so do not change directly on css, use this variable instead.

Protected domHandlerUnListeners

Type : Array<void>

Inherited from BaseComponent

Defined in BaseComponent:567

A collection (possible undefined) of DOM unlistener functions . That is, functions to de register handlers

fireLoadedSubscription

Type : Subscription

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:449

Flag to control load event for components inside tab control

focusable

Default value : false

Decorators :


                            @HostBinding('class.focusable')

Inherited from BaseComponent

Defined in BaseComponent:388

Display if the component is focusable or not

Protected handlersToUnregister

Type : Array<>

Default value : []

Inherited from BaseComponent

Defined in BaseComponent:558

handlers to unregister when the component is destroyed

hasDefinedCursor

Default value : false

Decorators :


                            @HostBinding('class.hasDefinedCursor')

Inherited from BaseComponent

Defined in BaseComponent:415

Applies Defined Cursor class

hostFontFamily

Type : any

Default value : null

Decorators :


                            @HostBinding('style.font-family')

Inherited from BaseComponent

Defined in BaseComponent:261

Property use it to apply the host binding for the font-family

hostFontSize

Type : any

Default value : null

Decorators :


                            @HostBinding('style.font-size')

Inherited from BaseComponent

Defined in BaseComponent:270

Property use it to apply the host binding for the font-size

hostFontStyle

Type : any

Default value : null

Decorators :


                            @HostBinding('style.font-style')

Inherited from BaseComponent

Defined in BaseComponent:279

Property use it to apply the host binding for the font-style

hostFontStyles

Default value : false

Decorators :


                            @HostBinding('class.defaultFontStyles')

Inherited from BaseComponent

Defined in BaseComponent:398

Applies default font styles class, used to allow specificity for each control css

hostFontWeight

Type : any

Default value : null

Decorators :


                            @HostBinding('style.font-weight')

Inherited from BaseComponent

Defined in BaseComponent:288

Property use it to apply the host binding for the font-weight

hostHeight

Type : string

Default value : null

Decorators :


                            @HostBinding('style.height')

Inherited from BaseComponent

Defined in BaseComponent:218

Property use it to apply the host binding for the height

hostHozCenter

Default value : false

Decorators :


                            @HostBinding('class.horizontal-center')

Inherited from BaseComponent

Defined in BaseComponent:308

Applies horizontal alignment left class

hostHozLeft

Default value : false

Decorators :


                            @HostBinding('class.horizontal-left')

Inherited from BaseComponent

Defined in BaseComponent:298

Applies horizontal alignment left class

hostHozRight

Default value : false

Decorators :


                            @HostBinding('class.horizontal-right')

Inherited from BaseComponent

Defined in BaseComponent:368

Applies horizontal alignment right class

hostHozSelfAlign

Default value : false

Decorators :


                            @HostBinding('class.horizontal-selfalign')
@Input()

Inherited from BaseComponent

Defined in BaseComponent:380

Applies horizontal selfalign class. Flags indicates when the control should handle its own horizontal alignment and ignore container alignment.

hostHozStretch

Default value : false

Decorators :


                            @HostBinding('class.horizontal-stretch')

Inherited from BaseComponent

Defined in BaseComponent:358

Applies horizontal alignment stretch class

hostMaxHeight

Type : number

Decorators :


                            @HostBinding('style.max-height.px')

Inherited from BaseComponent

Defined in BaseComponent:234

Property used to apply the host binding for max-height

hostMaxWidth

Type : number

Decorators :


                            @HostBinding('style.max-width.px')

Inherited from BaseComponent

Defined in BaseComponent:210

Property used to apply the host binding for max-width

hostMinHeight

Type : number

Decorators :


                            @HostBinding('style.min-height.px')

Inherited from BaseComponent

Defined in BaseComponent:226

Property used to apply the host binding for min-height

hostMinWidth

Type : number

Decorators :


                            @HostBinding('style.min-width.px')

Inherited from BaseComponent

Defined in BaseComponent:202

Property used to apply the host binding for min-width

hostOpacity

Type : any

Default value : null

Decorators :


                            @HostBinding('style.opacity')

Inherited from BaseComponent

Defined in BaseComponent:252

Property use it to apply the host binding for the opacity

hostVerBottom

Default value : false

Decorators :


                            @HostBinding('class.vertical-bottom')

Inherited from BaseComponent

Defined in BaseComponent:328

Applies vertical alignment bottom class

hostVerCenter

Default value : false

Decorators :


                            @HostBinding('class.vertical-center')

Inherited from BaseComponent

Defined in BaseComponent:338

Applies vertical alignment center class

hostVerStretch

Default value : false

Decorators :


                            @HostBinding('class.vertical-stretch')

Inherited from BaseComponent

Defined in BaseComponent:318

Applies horizontal alignment stretch class

hostVerTop

Default value : false

Decorators :


                            @HostBinding('class.vertical-top')

Inherited from BaseComponent

Defined in BaseComponent:348

Applies vertical alignment top class

hostVisibility

Type : any

Default value : null

Decorators :


                            @HostBinding('style.display')

Inherited from BaseComponent

Defined in BaseComponent:243

Property use it to apply the host binding for the visibility

hostWidth

Type : string

Default value : null

Decorators :


                            @HostBinding('style.width')

Inherited from BaseComponent

Defined in BaseComponent:194

Property use it to apply the host binding for the width

hostZIndex

Type : string

Default value : null

Decorators :


                            @HostBinding('style.z-index')

Inherited from BaseComponent

Defined in BaseComponent:424

Sets the z-index style.

isInitialized

Type : any

Default value : undefined

Inherited from BaseComponent

Defined in BaseComponent:523

Flag to know if the component is ready to render

isInternalInherit

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:515

Flag which indicates that the component is an internal use for inheritance

layoutUpdated

Type : EventEmitter<any>

Default value : new EventEmitter()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:140

Output to emit when then component's layout is updated.

Protected modelChangeRef

Type : function

Inherited from BaseComponent

Defined in BaseComponent:601

Contains the reference of the function added for handle the model's change

mouseEnter

Type : EventEmitter<literal type>

Default value : new EventEmitter()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:157

Event Emitter. EventEmitter normally called in the mouseEnterHandler.

mouseLeave

Type : EventEmitter<literal type>

Default value : new EventEmitter()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:167

Event Emitter Called in the mouseLeave handler

Private mouseLeaveTooltipUnlistener

Type : function

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:684

Mouse over event for tooltip unlisten action.

mouseLeftButtonUp

Type : EventEmitter<literal type>

Default value : new EventEmitter<any>()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:147

MouseLeftButtonUp event Emitter.

Private mouseMoveTooltipUnlistener

Type : function

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:701

Mouse move event for tooltip unlisten action. This should have a short lifespan, as much as it takes for the tooltip to be shown

Private mouseOverTooltipUnlistener

Type : function

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:692

Mouse over event for tooltip unlisten action.

Protected ngZone

Type : NgZone

Inherited from BaseComponent

Defined in BaseComponent:585

Angular´s NgZone accessor

Protected pendingDependencyPropertyValue

Type : Array<>

Default value : []

Inherited from BaseComponent

Defined in BaseComponent:549

A collection of pending dependency properties values to assign to the model

Protected pendingSetValues

Type : Array<>

Default value : []

Inherited from BaseComponent

Defined in BaseComponent:540

A collection of pending values to assign to the model

Protected renderer2

Type : Renderer2

Inherited from BaseComponent

Defined in BaseComponent:594

Angular´s Renderer2

sizeChanged

Type : EventEmitter<any>

Default value : new EventEmitter()

Decorators :


                            @Output()

Inherited from BaseComponent

Defined in BaseComponent:132

Output to emit when then component size is changed.

Private sizeChangedPendingTimeout

Type : any

Inherited from BaseComponent

Defined in BaseComponent:610

Timeout id for triggering the sizechanged event

spellCheck

Default value : false

Decorators :


                            @Input()

Inherited from BaseComponent

Defined in BaseComponent:186

Flag to determinate if the component should do the spell check or not. Default value is false.

staticContent

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:432

cache the static content of the control to validate if the current data is not equals.

tabSubscription

Type : Subscription

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:440

TabSelection event subscription

Private tooltipMousePosition

Type : DOMRect

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:710

To track the position of the mouse while the tooltip is being displayed

Private toolTipTimeout

Type : any

Default value : null

Inherited from BaseComponent

Defined in BaseComponent:650

To control the timer to show the tooltip

useCss

Default value : false

Decorators :


                            @Input()

Inherited from BaseComponent

Defined in BaseComponent:177

Determines if the component uses CSS height/width values, instead of inputs

validationError

Default value : false

Inherited from BaseComponent

Defined in BaseComponent:488

Property to set the validationError class in the component

validationErrorMessage

Type : string

Default value : ''

Inherited from BaseComponent

Defined in BaseComponent:496

Property for specifying validation error message

import { DOCUMENT } from '@angular/common';
import {
  ChangeDetectorRef,
  Component,
  ComponentFactoryResolver,
  ElementRef,
  Inject,
  Injector,
  Input,
  IterableDiffers,
  Optional,
} from '@angular/core';
import { ModelProxy, XamGridModel } from '@mobilize/wms-framework';
import { IgxIconService } from 'igniteui-angular';
import { XamGridComponent } from '../xam-grid.component';

export class CustomXamGrid extends XamGridModel {
  constructor() {
    super();
    this.AngularComponentId = 'CustomXamGrid';
  }
}

@Component({
  selector: 'wm-custom-xam-grid',
  template: `<wm-xam-grid [model]="model"></wm-xam-grid>`,
})
export class CustomXamGridComponent extends XamGridComponent {
  modelProxy: CustomXamGrid = ModelProxy.create<CustomXamGrid>();
  @Input() model: CustomXamGrid;
  ngOnInit() {
    this.model = this.model || new CustomXamGrid();
    super.ngOnInit();
  }
  constructor(
    @Optional() injectedModel: XamGridModel,
    injector: Injector,
    cdRef: ChangeDetectorRef,
    differsFactory: IterableDiffers,
    resolver: ComponentFactoryResolver,
    ref: ElementRef,
    @Inject(DOCUMENT) document,
    iconService: IgxIconService
  ) {
    super(
      injector,
      cdRef,
      differsFactory,
      resolver,
      ref,
      document,
      iconService
    );
    this.model = injectedModel;
  }
}

Legend

Html element

Component

Html element with directive

File

Extends

Metadata

Index

Properties

Methods

Inputs

Outputs

HostBindings

HostListeners

Constructor

Inputs

Outputs

HostBindings

HostListeners

Methods

Properties

result-matching ""

No results matching ""