igniteui-webcomponents-grids/web-types.json

Ignite UI Web Components grid components.

{
    "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
    "name": "igniteui-api-analyzer",
    "version": "1.0.0",
    "description-markup": "markdown",    "contributions": {
      "html": {
        "elements": [{"name":"igc-grid","description":"Grid provides a way to present and manipulate tabular data.\n---\n\n\n### **Events:**\n - **columnsAutogenerated**\n- **childrenResolved** - Emitted when content children are resolved and collections in grid are updated.\n- **dataPreLoad** - Emitted when a new chunk of data is loaded from virtualization.\n- **groupingExpressionsChange** - Emitted when grouping is performed.\n- **groupingExpansionStateChange** - Emitted when groups are expanded/collapsed.\n- **groupingDone** - Emitted when columns are grouped/ungrouped.\n- **filteringExpressionsTreeChange** - Emitted after filtering is performed.\n- **advancedFilteringExpressionsTreeChange** - Emitted after advanced filtering is performed.\n- **gridScroll** - Emitted when grid is scrolled horizontally/vertically.\n- **cellClick** - Emitted when a cell is clicked.\n- **rowClick** - Emitted when a row is clicked.\n- **formGroupCreated** - Emitted when formGroup is created on edit of row/cell.\n- **validationStatusChange** - Emitted when grid's validation status changes.\n- **selected** - Emitted when a cell is selected.\n- **rowSelectionChanging** - Emitted when grid row is selected.\n- **columnSelectionChanging** - Emitted when column is selected.\n- **columnPin** - Emitted before column is pinned.\n- **columnPinned** - Emitted after column is pinned.\n- **cellEditEnter** - Emitted when cell enters edit mode.\n- **cellEditExit** - Emitted when cell exits edit mode.\n- **cellEdit** - Emitted when cell has been edited.\n- **cellEditDone** - Emitted after cell has been edited and editing has been committed.\n- **rowEditEnter** - Emitted when a row enters edit mode.\n- **rowEdit** - Emitted when exiting edit mode for a row.\n- **rowEditDone** - Emitted after exiting edit mode for a row and editing has been committed.\n- **rowEditExit** - Emitted when row editing is canceled.\n- **columnInit** - Emitted when a column is initialized.\n- **sorting** - Emitted before sorting expressions are applied.\n- **sortingDone** - Emitted after sorting is completed.\n- **filtering** - Emitted before filtering expressions are applied.\n- **filteringDone** - Emitted after filtering is performed through the UI.\n- **rowAdded** - Emitted when a row is added.\n- **rowDeleted** - Emitted when a row is deleted.\n- **rowDelete** - Emmited when deleting a row.\n- **rowAdd** - Emmited just before the newly added row is commited.\n- **columnResized** - Emitted after column is resized.\n- **contextMenu** - Emitted when a cell or row is right clicked.\n- **doubleClick** - Emitted when a cell is double clicked.\n- **columnVisibilityChanging** - Emitted before column visibility is changed.\n- **columnVisibilityChanged** - Emitted after column visibility is changed.\n- **columnMovingStart** - Emitted when column moving starts.\n- **columnMoving** - Emitted during the column moving operation.\n- **columnMovingEnd** - Emitted when column moving ends.\n- **gridKeydown** - Emitted when keydown is triggered over element inside grid's body.\n- **rowDragStart** - Emitted when start dragging a row.\n- **rowDragEnd** - Emitted when dropping a row.\n- **gridCopy** - Emitted when a copy operation is executed.\n- **expansionStatesChange** - Emitted when the rows are expanded or collapsed.\n- **selectedRowsChange** - Emitted when the rows are selected or deselected.\n- **rowToggle** - Emitted when the expanded state of a row gets changed.\n- **rowPinning** - Emitted when the pinned state of a row is changed.\n- **rowPinned** - Emitted when the pinned state of a row is changed.\n- **activeNodeChange** - Emitted when the active node is changed.\n- **sortingExpressionsChange** - Emitted before sorting is performed.\n- **toolbarExporting** - Emitted when an export process is initiated by the user.\n- **rangeSelected** - Emitted when making a range selection.\n- **rendered** - Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM\n- **dataChanging** - Emitted before the grid's data view is changed because of a data operation, rebinding, etc.\n- **dataChanged** - Emitted after the grid's data view is changed because of a data operation, rebinding, etc.","doc-url":"","attributes":[{"name":"action-strip-components","value":{"type":"IgcActionStripToken[]"}},{"name":"groups-expanded","description":"Gets/Sets whether created groups are rendered expanded or collapsed.","value":{"type":"boolean"}},{"name":"id","description":"Gets/Sets the value of the `id` attribute.","value":{"type":"string"}},{"name":"data","description":"Gets/Sets the array of data that populates the component.\n     \n    /* treatAsRef */","value":{"type":"any[]"}},{"name":"total-item-count","description":"Gets/Sets the total number of records in the data source.","value":{"type":"number"}},{"name":"grouping-expressions","description":"Gets/Sets the group by state.","value":{"type":"IgcGroupingExpression[]"}},{"name":"grouping-expansion-state","description":"Gets/Sets a list of expansion states for group rows.","value":{"type":"IgcGroupByExpandState[]"}},{"name":"hide-grouped-columns","description":"Gets/Sets whether the grouped columns should be hidden.","value":{"type":"boolean"}},{"name":"group-strategy","description":"Gets/Sets the grouping strategy of the grid.","value":{"type":"IgcGridGroupingStrategy"}},{"name":"drop-area-message","description":"Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on.","value":{"type":"string"}},{"name":"show-group-area","description":"Returns whether the grid has group area.","value":{"type":"boolean"}},{"name":"snackbar-display-time","description":"Gets/Sets the display time for the row adding snackbar notification.","value":{"type":"number"}},{"name":"auto-generate","description":"Gets/Sets whether to auto-generate the columns.","value":{"type":"boolean"}},{"name":"auto-generate-exclude","description":"Gets/Sets a list of property keys to be excluded from the generated column collection","value":{"type":"string[]"}},{"name":"moving","description":"Controls whether columns moving is enabled in the grid.","value":{"type":"boolean"}},{"name":"summary-row-height","description":"Get/Set summary row height","value":{"type":"number"}},{"name":"data-clone-strategy","description":"Gets/Sets the data clone strategy of the grid when in edit mode.","value":{"type":"IgcDataCloneStrategy"}},{"name":"clipboard-options","description":"Controls the copy behavior of the grid.","value":{"type":"IgcClipboardOptions"}},{"name":"row-classes","description":"Sets a conditional class selector to the grid's row element.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class and the value is  either a callback function that returns a boolean, or boolean, like so:","value":{"type":"any"}},{"name":"row-styles","description":"Sets conditional style properties on the grid row element.  It accepts an object literal where the keys are  the style properties and the value is an expression to be evaluated.","value":{"type":"any"}},{"name":"primary-key","description":"Gets/Sets the primary key.","value":{"type":"string"}},{"name":"column-list","value":{"type":"IgcColumnComponent[]"}},{"name":"toolbar","value":{"type":"IgcGridToolbarComponent[]"}},{"name":"pagination-components","value":{"type":"IgcPaginatorComponent[]"}},{"name":"resource-strings","description":"Gets/Sets the resource strings.","value":{"type":"IgcGridResourceStrings"}},{"name":"filtering-logic","description":"Gets/Sets the filtering logic of the grid.","value":{"type":"FilteringLogic"}},{"name":"filtering-expressions-tree","description":"Gets/Sets the filtering state.","value":{"type":"IgcFilteringExpressionsTree"}},{"name":"advanced-filtering-expressions-tree","description":"Gets/Sets the advanced filtering state.","value":{"type":"IgcFilteringExpressionsTree"}},{"name":"locale","description":"Gets/Sets the locale.","value":{"type":"string"}},{"name":"paging-mode","value":{"type":"GridPagingMode"}},{"name":"hide-row-selectors","description":"Gets/Sets if the row selectors are hidden.","value":{"type":"boolean"}},{"name":"row-draggable","description":"Gets/Sets whether rows can be moved.","value":{"type":"boolean"}},{"name":"validation-trigger","description":"Gets/Sets the trigger for validators used when editing the grid.","value":{"type":"GridValidationTrigger"}},{"name":"row-editable","description":"Gets/Sets whether the rows are editable.","value":{"type":"boolean"}},{"name":"height","description":"Gets/Sets the height.","value":{"type":"string"}},{"name":"width","description":"Gets/Sets the width of the grid.","value":{"type":"string"}},{"name":"row-height","description":"Gets/Sets the row height.","value":{"type":"number"}},{"name":"column-width","description":"Gets/Sets the default width of the columns.","value":{"type":"string"}},{"name":"empty-grid-message","description":"Get/Sets the message displayed when there are no records.","value":{"type":"string"}},{"name":"is-loading","description":"Gets/Sets whether the grid is going to show a loading indicator.","value":{"type":"boolean"}},{"name":"should-generate","description":"Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid","value":{"type":"boolean"}},{"name":"empty-filtered-grid-message","description":"Gets/Sets the message displayed when there are no records and the grid is filtered.","value":{"type":"string"}},{"name":"pinning","description":"Gets/Sets the initial pinning configuration.","value":{"type":"IgcPinningConfig"}},{"name":"allow-filtering","description":"Gets/Sets if the filtering is enabled.","value":{"type":"boolean"}},{"name":"allow-advanced-filtering","description":"Gets/Sets a value indicating whether the advanced filtering is enabled.","value":{"type":"boolean"}},{"name":"filter-mode","description":"Gets/Sets the filter mode.","value":{"type":"FilterMode"}},{"name":"summary-position","description":"Gets/Sets the summary position.","value":{"type":"GridSummaryPosition"}},{"name":"summary-calculation-mode","description":"Gets/Sets the summary calculation mode.","value":{"type":"GridSummaryCalculationMode"}},{"name":"show-summary-on-collapse","description":"Controls whether the summary row is visible when groupBy/parent row is collapsed.","value":{"type":"boolean"}},{"name":"filter-strategy","description":"Gets/Sets the filtering strategy of the grid.","value":{"type":"IgcFilteringStrategy"}},{"name":"sort-strategy","description":"Gets/Sets the sorting strategy of the grid.","value":{"type":"IgcGridSortingStrategy"}},{"name":"merge-strategy","description":"Gets/Sets the merge strategy of the grid.","value":{"type":"IgcGridMergeStrategy"}},{"name":"sorting-options","description":"Gets/Sets the sorting options - single or multiple sorting.  Accepts an `ISortingOptions` object with any of the `mode` properties.","value":{"type":"IgcSortingOptions"}},{"name":"selected-rows","description":"Gets/Sets the current selection state.","value":{"type":"any[]"}},{"name":"sorting-expressions","description":"Gets/Sets the sorting state.","value":{"type":"IgcSortingExpression[]"}},{"name":"batch-editing","description":"Gets/Sets whether the grid has batch editing enabled.  When batch editing is enabled, changes are not made directly to the underlying data.  Instead, they are stored as transactions, which can later be committed w/ the `commit` method.","value":{"type":"boolean"}},{"name":"cell-selection","description":"Gets/Sets cell selection mode.","value":{"type":"GridSelectionMode"}},{"name":"cell-merge-mode","description":"Gets/Sets cell merge mode.","value":{"type":"GridCellMergeMode"}},{"name":"row-selection","description":"Gets/Sets row selection mode","value":{"type":"GridSelectionMode"}},{"name":"column-selection","description":"Gets/Sets column selection mode","value":{"type":"GridSelectionMode"}},{"name":"expansion-states","description":"Gets/Sets a list of key-value pairs [row ID, expansion state].","value":{"type":"Map<any, boolean>"}},{"name":"outlet","description":"Gets/Sets the outlet used to attach the grid's overlays to.","value":{"type":"IgcOverlayOutletDirective"}},{"name":"total-records","description":"Returns the total number of records.","value":{"type":"number"}},{"name":"select-row-on-click","description":"Gets/Sets whether clicking over a row should select/deselect it","value":{"type":"boolean"}}],"events":[{"name":"columnsAutogenerated","type":"CustomEvent<IgcColumnsAutoGeneratedEventArgs>"},{"name":"childrenResolved","type":"CustomEvent<void>","description":"Emitted when content children are resolved and collections in grid are updated."},{"name":"dataPreLoad","type":"CustomEvent<IgcForOfState>","description":"Emitted when a new chunk of data is loaded from virtualization."},{"name":"groupingExpressionsChange","type":"CustomEvent<IgcGroupingExpression[]>","description":"Emitted when grouping is performed."},{"name":"groupingExpansionStateChange","type":"CustomEvent<IgcGroupByExpandState[]>","description":"Emitted when groups are expanded/collapsed."},{"name":"groupingDone","type":"CustomEvent<IgcGroupingDoneEventArgs>","description":"Emitted when columns are grouped/ungrouped."},{"name":"filteringExpressionsTreeChange","type":"CustomEvent<IgcFilteringExpressionsTree>","description":"Emitted after filtering is performed."},{"name":"advancedFilteringExpressionsTreeChange","type":"CustomEvent<IgcFilteringExpressionsTree>","description":"Emitted after advanced filtering is performed."},{"name":"gridScroll","type":"CustomEvent<IgcGridScrollEventArgs>","description":"Emitted when grid is scrolled horizontally/vertically."},{"name":"cellClick","type":"CustomEvent<IgcGridCellEventArgs>","description":"Emitted when a cell is clicked."},{"name":"rowClick","type":"CustomEvent<IgcGridRowEventArgs>","description":"Emitted when a row is clicked."},{"name":"formGroupCreated","type":"CustomEvent<IgcGridFormGroupCreatedEventArgs>","description":"Emitted when formGroup is created on edit of row/cell."},{"name":"validationStatusChange","type":"CustomEvent<IgcGridValidationStatusEventArgs>","description":"Emitted when grid's validation status changes."},{"name":"selected","type":"CustomEvent<IgcGridCellEventArgs>","description":"Emitted when a cell is selected."},{"name":"rowSelectionChanging","type":"CustomEvent<IgcRowSelectionEventArgs>","description":"Emitted when grid row is selected."},{"name":"columnSelectionChanging","type":"CustomEvent<IgcColumnSelectionEventArgs>","description":"Emitted when column is selected."},{"name":"columnPin","type":"CustomEvent<IgcPinColumnCancellableEventArgs>","description":"Emitted before column is pinned."},{"name":"columnPinned","type":"CustomEvent<IgcPinColumnEventArgs>","description":"Emitted after column is pinned."},{"name":"cellEditEnter","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when cell enters edit mode."},{"name":"cellEditExit","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted when cell exits edit mode."},{"name":"cellEdit","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when cell has been edited."},{"name":"cellEditDone","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted after cell has been edited and editing has been committed."},{"name":"rowEditEnter","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when a row enters edit mode."},{"name":"rowEdit","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when exiting edit mode for a row."},{"name":"rowEditDone","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted after exiting edit mode for a row and editing has been committed."},{"name":"rowEditExit","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted when row editing is canceled."},{"name":"columnInit","type":"CustomEvent<IgcColumnComponent>","description":"Emitted when a column is initialized."},{"name":"sorting","type":"CustomEvent<IgcSortingEventArgs>","description":"Emitted before sorting expressions are applied."},{"name":"sortingDone","type":"CustomEvent<IgcSortingExpression[]>","description":"Emitted after sorting is completed."},{"name":"filtering","type":"CustomEvent<IgcFilteringEventArgs>","description":"Emitted before filtering expressions are applied."},{"name":"filteringDone","type":"CustomEvent<IgcFilteringExpressionsTree>","description":"Emitted after filtering is performed through the UI."},{"name":"rowAdded","type":"CustomEvent<IgcRowDataEventArgs>","description":"Emitted when a row is added."},{"name":"rowDeleted","type":"CustomEvent<IgcRowDataEventArgs>","description":"Emitted when a row is deleted."},{"name":"rowDelete","type":"CustomEvent<IgcRowDataCancelableEventArgs>","description":"Emmited when deleting a row."},{"name":"rowAdd","type":"CustomEvent<IgcRowDataCancelableEventArgs>","description":"Emmited just before the newly added row is commited."},{"name":"columnResized","type":"CustomEvent<IgcColumnResizeEventArgs>","description":"Emitted after column is resized."},{"name":"contextMenu","type":"CustomEvent<IgcGridContextMenuEventArgs>","description":"Emitted when a cell or row is right clicked."},{"name":"doubleClick","type":"CustomEvent<IgcGridCellEventArgs>","description":"Emitted when a cell is double clicked."},{"name":"columnVisibilityChanging","type":"CustomEvent<IgcColumnVisibilityChangingEventArgs>","description":"Emitted before column visibility is changed."},{"name":"columnVisibilityChanged","type":"CustomEvent<IgcColumnVisibilityChangedEventArgs>","description":"Emitted after column visibility is changed."},{"name":"columnMovingStart","type":"CustomEvent<IgcColumnMovingStartEventArgs>","description":"Emitted when column moving starts."},{"name":"columnMoving","type":"CustomEvent<IgcColumnMovingEventArgs>","description":"Emitted during the column moving operation."},{"name":"columnMovingEnd","type":"CustomEvent<IgcColumnMovingEndEventArgs>","description":"Emitted when column moving ends."},{"name":"gridKeydown","type":"CustomEvent<IgcGridKeydownEventArgs>","description":"Emitted when keydown is triggered over element inside grid's body."},{"name":"rowDragStart","type":"CustomEvent<IgcRowDragStartEventArgs>","description":"Emitted when start dragging a row."},{"name":"rowDragEnd","type":"CustomEvent<IgcRowDragEndEventArgs>","description":"Emitted when dropping a row."},{"name":"gridCopy","type":"CustomEvent<IgcGridClipboardEvent>","description":"Emitted when a copy operation is executed."},{"name":"expansionStatesChange","type":"CustomEvent<Map<any, boolean>>","description":"Emitted when the rows are expanded or collapsed."},{"name":"selectedRowsChange","type":"CustomEvent<any[]>","description":"Emitted when the rows are selected or deselected."},{"name":"rowToggle","type":"CustomEvent<IgcRowToggleEventArgs>","description":"Emitted when the expanded state of a row gets changed."},{"name":"rowPinning","type":"CustomEvent<IgcPinRowEventArgs>","description":"Emitted when the pinned state of a row is changed."},{"name":"rowPinned","type":"CustomEvent<IgcPinRowEventArgs>","description":"Emitted when the pinned state of a row is changed."},{"name":"activeNodeChange","type":"CustomEvent<IgcActiveNodeChangeEventArgs>","description":"Emitted when the active node is changed."},{"name":"sortingExpressionsChange","type":"CustomEvent<IgcSortingExpression[]>","description":"Emitted before sorting is performed."},{"name":"toolbarExporting","type":"CustomEvent<IgcGridToolbarExportEventArgs>","description":"Emitted when an export process is initiated by the user."},{"name":"rangeSelected","type":"CustomEvent<IgcGridSelectionRange>","description":"Emitted when making a range selection."},{"name":"rendered","type":"CustomEvent<boolean>","description":"Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM"},{"name":"dataChanging","type":"CustomEvent<IgcForOfDataChangeEventArgs>","description":"Emitted before the grid's data view is changed because of a data operation, rebinding, etc."},{"name":"dataChanged","type":"CustomEvent<IgcForOfDataChangeEventArgs>","description":"Emitted after the grid's data view is changed because of a data operation, rebinding, etc."}],"js":{"properties":[{"name":"actionStripComponents","type":"IgcActionStripToken[]"},{"name":"groupsExpanded","description":"Gets/Sets whether created groups are rendered expanded or collapsed.","type":"boolean"},{"name":"dropAreaTemplate","description":"Gets/Sets the template that will be rendered as a GroupBy drop area.","type":"IgcRenderFunction<void>"},{"name":"detailTemplate","description":"Returns a reference to the master-detail template.","type":"IgcRenderFunction<IgcGridMasterDetailContext>"},{"name":"id","description":"Gets/Sets the value of the `id` attribute.","type":"string"},{"name":"groupsRecords","description":"Gets the hierarchical representation of the group by records.","type":"IgcGroupByRecord[]"},{"name":"data","description":"Gets/Sets the array of data that populates the component.\n     \n    /* treatAsRef */","type":"any[]"},{"name":"totalItemCount","description":"Gets/Sets the total number of records in the data source.","type":"number"},{"name":"groupingExpressions","description":"Gets/Sets the group by state.","type":"IgcGroupingExpression[]"},{"name":"groupingExpansionState","description":"Gets/Sets a list of expansion states for group rows.","type":"IgcGroupByExpandState[]"},{"name":"hideGroupedColumns","description":"Gets/Sets whether the grouped columns should be hidden.","type":"boolean"},{"name":"groupStrategy","description":"Gets/Sets the grouping strategy of the grid.","type":"IgcGridGroupingStrategy"},{"name":"dropAreaMessage","description":"Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on.","type":"string"},{"name":"groupByRowSelectorTemplate","description":"Gets the group by row selector template.","type":"IgcRenderFunction<IgcGroupByRowSelectorTemplateContext>"},{"name":"groupRowTemplate","description":"Gets/Sets the template reference for the group row.","type":"IgcRenderFunction<IgcGroupByRowTemplateContext>"},{"name":"showGroupArea","description":"Returns whether the grid has group area.","type":"boolean"},{"name":"selectedCells","description":"Returns an array of the selected grid cells.","type":"IgcCellType[]"},{"name":"snackbarDisplayTime","description":"Gets/Sets the display time for the row adding snackbar notification.","type":"number"},{"name":"autoGenerate","description":"Gets/Sets whether to auto-generate the columns.","type":"boolean"},{"name":"autoGenerateExclude","description":"Gets/Sets a list of property keys to be excluded from the generated column collection","type":"string[]"},{"name":"moving","description":"Controls whether columns moving is enabled in the grid.","type":"boolean"},{"name":"emptyGridTemplate","description":"Gets/Sets a custom template when empty.","type":"IgcRenderFunction<IgcGridTemplateContext>"},{"name":"addRowEmptyTemplate","description":"Gets/Sets a custom template for adding row UI when grid is empty.","type":"IgcRenderFunction<void>"},{"name":"loadingGridTemplate","description":"Gets/Sets a custom template when loading.","type":"IgcRenderFunction<IgcGridTemplateContext>"},{"name":"summaryRowHeight","description":"Get/Set summary row height","type":"number"},{"name":"dataCloneStrategy","description":"Gets/Sets the data clone strategy of the grid when in edit mode.","type":"IgcDataCloneStrategy"},{"name":"clipboardOptions","description":"Controls the copy behavior of the grid.","type":"IgcClipboardOptions"},{"name":"rowClasses","description":"Sets a conditional class selector to the grid's row element.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class and the value is  either a callback function that returns a boolean, or boolean, like so:","type":"any"},{"name":"rowStyles","description":"Sets conditional style properties on the grid row element.  It accepts an object literal where the keys are  the style properties and the value is an expression to be evaluated.","type":"any"},{"name":"primaryKey","description":"Gets/Sets the primary key.","type":"string"},{"name":"columnList","type":"IgcColumnComponent[]"},{"name":"dragGhostCustomTemplate","description":"Gets the custom template, if any, used for row drag ghost.","type":"IgcRenderFunction<IgcGridRowDragGhostContext>"},{"name":"rowEditTextTemplate","description":"Gets the row edit text template.","type":"IgcRenderFunction<IgcGridRowEditTextTemplateContext>"},{"name":"rowAddTextTemplate","description":"Gets the row add text template.","type":"IgcRenderFunction<IgcGridEmptyTemplateContext>"},{"name":"rowEditActionsTemplate","description":"Gets the row edit actions template.","type":"IgcRenderFunction<IgcGridRowEditActionsTemplateContext>"},{"name":"rowExpandedIndicatorTemplate","description":"Gets the row expand indicator template.","type":"IgcRenderFunction<IgcGridRowTemplateContext>"},{"name":"rowCollapsedIndicatorTemplate","description":"Gets the row collapse indicator template.","type":"IgcRenderFunction<IgcGridRowTemplateContext>"},{"name":"headerExpandedIndicatorTemplate","description":"Gets the header expand indicator template.","type":"IgcRenderFunction<IgcGridTemplateContext>"},{"name":"headerCollapsedIndicatorTemplate","description":"Gets the row collapse indicator template.","type":"IgcRenderFunction<IgcGridTemplateContext>"},{"name":"excelStyleHeaderIconTemplate","description":"Gets the excel style header icon.","type":"IgcRenderFunction<IgcGridHeaderTemplateContext>"},{"name":"sortAscendingHeaderIconTemplate","description":"The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.","type":"IgcRenderFunction<IgcGridHeaderTemplateContext>"},{"name":"sortDescendingHeaderIconTemplate","description":"The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.","type":"IgcRenderFunction<IgcGridHeaderTemplateContext>"},{"name":"sortHeaderIconTemplate","description":"Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.","type":"IgcRenderFunction<IgcGridHeaderTemplateContext>"},{"name":"toolbar","type":"IgcGridToolbarComponent[]"},{"name":"paginationComponents","type":"IgcPaginatorComponent[]"},{"name":"resourceStrings","description":"Gets/Sets the resource strings.","type":"IgcGridResourceStrings"},{"name":"filteringLogic","description":"Gets/Sets the filtering logic of the grid.","type":"FilteringLogic"},{"name":"filteringExpressionsTree","description":"Gets/Sets the filtering state.","type":"IgcFilteringExpressionsTree"},{"name":"advancedFilteringExpressionsTree","description":"Gets/Sets the advanced filtering state.","type":"IgcFilteringExpressionsTree"},{"name":"locale","description":"Gets/Sets the locale.","type":"string"},{"name":"pagingMode","type":"GridPagingMode"},{"name":"hideRowSelectors","description":"Gets/Sets if the row selectors are hidden.","type":"boolean"},{"name":"rowDraggable","description":"Gets/Sets whether rows can be moved.","type":"boolean"},{"name":"validationTrigger","description":"Gets/Sets the trigger for validators used when editing the grid.","type":"GridValidationTrigger"},{"name":"rowEditable","description":"Gets/Sets whether the rows are editable.","type":"boolean"},{"name":"height","description":"Gets/Sets the height.","type":"string"},{"name":"width","description":"Gets/Sets the width of the grid.","type":"string"},{"name":"rowHeight","description":"Gets/Sets the row height.","type":"number"},{"name":"columnWidth","description":"Gets/Sets the default width of the columns.","type":"string"},{"name":"emptyGridMessage","description":"Get/Sets the message displayed when there are no records.","type":"string"},{"name":"isLoading","description":"Gets/Sets whether the grid is going to show a loading indicator.","type":"boolean"},{"name":"shouldGenerate","description":"Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid","type":"boolean"},{"name":"emptyFilteredGridMessage","description":"Gets/Sets the message displayed when there are no records and the grid is filtered.","type":"string"},{"name":"pinning","description":"Gets/Sets the initial pinning configuration.","type":"IgcPinningConfig"},{"name":"allowFiltering","description":"Gets/Sets if the filtering is enabled.","type":"boolean"},{"name":"allowAdvancedFiltering","description":"Gets/Sets a value indicating whether the advanced filtering is enabled.","type":"boolean"},{"name":"filterMode","description":"Gets/Sets the filter mode.","type":"FilterMode"},{"name":"summaryPosition","description":"Gets/Sets the summary position.","type":"GridSummaryPosition"},{"name":"summaryCalculationMode","description":"Gets/Sets the summary calculation mode.","type":"GridSummaryCalculationMode"},{"name":"showSummaryOnCollapse","description":"Controls whether the summary row is visible when groupBy/parent row is collapsed.","type":"boolean"},{"name":"filterStrategy","description":"Gets/Sets the filtering strategy of the grid.","type":"IgcFilteringStrategy"},{"name":"sortStrategy","description":"Gets/Sets the sorting strategy of the grid.","type":"IgcGridSortingStrategy"},{"name":"mergeStrategy","description":"Gets/Sets the merge strategy of the grid.","type":"IgcGridMergeStrategy"},{"name":"sortingOptions","description":"Gets/Sets the sorting options - single or multiple sorting.  Accepts an `ISortingOptions` object with any of the `mode` properties.","type":"IgcSortingOptions"},{"name":"selectedRows","description":"Gets/Sets the current selection state.","type":"any[]"},{"name":"rowList","description":"A list of grid row.","type":"IgcRowDirective[]"},{"name":"dataRowList","description":"A list of currently rendered grid row's.","type":"IgcRowDirective[]"},{"name":"headSelectorTemplate","description":"Gets the header row selector template.","type":"IgcRenderFunction<IgcHeadSelectorTemplateContext>"},{"name":"rowSelectorTemplate","description":"Gets the row selector template.","type":"IgcRenderFunction<IgcRowSelectorTemplateContext>"},{"name":"dragIndicatorIconTemplate","description":"The custom template, if any, that should be used when rendering the row drag indicator icon","type":"IgcRenderFunction<IgcGridEmptyTemplateContext>"},{"name":"sortingExpressions","description":"Gets/Sets the sorting state.","type":"IgcSortingExpression[]"},{"name":"hiddenColumnsCount","description":"Gets the number of hidden columns.","type":"number"},{"name":"pinnedColumnsCount","description":"Gets the number of pinned columns.","type":"number"},{"name":"batchEditing","description":"Gets/Sets whether the grid has batch editing enabled.  When batch editing is enabled, changes are not made directly to the underlying data.  Instead, they are stored as transactions, which can later be committed w/ the `commit` method.","type":"boolean"},{"name":"transactions","description":"Get transactions service for the grid.","type":"TransactionService"},{"name":"cellSelection","description":"Gets/Sets cell selection mode.","type":"GridSelectionMode"},{"name":"cellMergeMode","description":"Gets/Sets cell merge mode.","type":"GridCellMergeMode"},{"name":"rowSelection","description":"Gets/Sets row selection mode","type":"GridSelectionMode"},{"name":"columnSelection","description":"Gets/Sets column selection mode","type":"GridSelectionMode"},{"name":"lastSearchInfo","description":"Represents the last search information.","type":"IgcSearchInfo"},{"name":"filteredData","description":"Returns an array of objects containing the filtered data.","type":"any"},{"name":"filteredSortedData","description":"Returns an array containing the filtered sorted data.","type":"any[]"},{"name":"virtualizationState","description":"Returns the state of the grid virtualization.","type":"IgcForOfState"},{"name":"expansionStates","description":"Gets/Sets a list of key-value pairs [row ID, expansion state].","type":"Map<any, boolean>"},{"name":"outlet","description":"Gets/Sets the outlet used to attach the grid's overlays to.","type":"IgcOverlayOutletDirective"},{"name":"defaultRowHeight","description":"Gets the default row height.","type":"number"},{"name":"columns","description":"Gets an array of columns.","type":"IgcColumnComponent[]"},{"name":"pinnedColumns","description":"Gets an array of the pinned columns.","type":"IgcColumnComponent[]"},{"name":"pinnedStartColumns","description":"Gets an array of the pinned to the left columns.","type":"IgcColumnComponent[]"},{"name":"pinnedEndColumns","description":"Gets an array of the pinned to the right columns.","type":"IgcColumnComponent[]"},{"name":"pinnedRows","description":"Gets an array of the pinned rows.","type":"IgcGridRowComponent[]"},{"name":"unpinnedColumns","description":"Gets an array of unpinned columns.","type":"IgcColumnComponent[]"},{"name":"visibleColumns","description":"Returns an array of visible columns.","type":"IgcColumnComponent[]"},{"name":"totalRecords","description":"Returns the total number of records.","type":"number"},{"name":"dataView","description":"Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.","type":"any[]"},{"name":"selectRowOnClick","description":"Gets/Sets whether clicking over a row should select/deselect it","type":"boolean"}],"events":[{"name":"columnsAutogenerated","type":"CustomEvent<IgcColumnsAutoGeneratedEventArgs>"},{"name":"childrenResolved","type":"CustomEvent<void>","description":"Emitted when content children are resolved and collections in grid are updated."},{"name":"dataPreLoad","type":"CustomEvent<IgcForOfState>","description":"Emitted when a new chunk of data is loaded from virtualization."},{"name":"groupingExpressionsChange","type":"CustomEvent<IgcGroupingExpression[]>","description":"Emitted when grouping is performed."},{"name":"groupingExpansionStateChange","type":"CustomEvent<IgcGroupByExpandState[]>","description":"Emitted when groups are expanded/collapsed."},{"name":"groupingDone","type":"CustomEvent<IgcGroupingDoneEventArgs>","description":"Emitted when columns are grouped/ungrouped."},{"name":"filteringExpressionsTreeChange","type":"CustomEvent<IgcFilteringExpressionsTree>","description":"Emitted after filtering is performed."},{"name":"advancedFilteringExpressionsTreeChange","type":"CustomEvent<IgcFilteringExpressionsTree>","description":"Emitted after advanced filtering is performed."},{"name":"gridScroll","type":"CustomEvent<IgcGridScrollEventArgs>","description":"Emitted when grid is scrolled horizontally/vertically."},{"name":"cellClick","type":"CustomEvent<IgcGridCellEventArgs>","description":"Emitted when a cell is clicked."},{"name":"rowClick","type":"CustomEvent<IgcGridRowEventArgs>","description":"Emitted when a row is clicked."},{"name":"formGroupCreated","type":"CustomEvent<IgcGridFormGroupCreatedEventArgs>","description":"Emitted when formGroup is created on edit of row/cell."},{"name":"validationStatusChange","type":"CustomEvent<IgcGridValidationStatusEventArgs>","description":"Emitted when grid's validation status changes."},{"name":"selected","type":"CustomEvent<IgcGridCellEventArgs>","description":"Emitted when a cell is selected."},{"name":"rowSelectionChanging","type":"CustomEvent<IgcRowSelectionEventArgs>","description":"Emitted when grid row is selected."},{"name":"columnSelectionChanging","type":"CustomEvent<IgcColumnSelectionEventArgs>","description":"Emitted when column is selected."},{"name":"columnPin","type":"CustomEvent<IgcPinColumnCancellableEventArgs>","description":"Emitted before column is pinned."},{"name":"columnPinned","type":"CustomEvent<IgcPinColumnEventArgs>","description":"Emitted after column is pinned."},{"name":"cellEditEnter","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when cell enters edit mode."},{"name":"cellEditExit","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted when cell exits edit mode."},{"name":"cellEdit","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when cell has been edited."},{"name":"cellEditDone","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted after cell has been edited and editing has been committed."},{"name":"rowEditEnter","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when a row enters edit mode."},{"name":"rowEdit","type":"CustomEvent<IgcGridEditEventArgs>","description":"Emitted when exiting edit mode for a row."},{"name":"rowEditDone","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted after exiting edit mode for a row and editing has been committed."},{"name":"rowEditExit","type":"CustomEvent<IgcGridEditDoneEventArgs>","description":"Emitted when row editing is canceled."},{"name":"columnInit","type":"CustomEvent<IgcColumnComponent>","description":"Emitted when a column is initialized."},{"name":"sorting","type":"CustomEvent<IgcSortingEventArgs>","description":"Emitted before sorting expressions are applied."},{"name":"sortingDone","type":"CustomEvent<IgcSortingExpression[]>","description":"Emitted after sorting is completed."},{"name":"filtering","type":"CustomEvent<IgcFilteringEventArgs>","description":"Emitted before filtering expressions are applied."},{"name":"filteringDone","type":"CustomEvent<IgcFilteringExpressionsTree>","description":"Emitted after filtering is performed through the UI."},{"name":"rowAdded","type":"CustomEvent<IgcRowDataEventArgs>","description":"Emitted when a row is added."},{"name":"rowDeleted","type":"CustomEvent<IgcRowDataEventArgs>","description":"Emitted when a row is deleted."},{"name":"rowDelete","type":"CustomEvent<IgcRowDataCancelableEventArgs>","description":"Emmited when deleting a row."},{"name":"rowAdd","type":"CustomEvent<IgcRowDataCancelableEventArgs>","description":"Emmited just before the newly added row is commited."},{"name":"columnResized","type":"CustomEvent<IgcColumnResizeEventArgs>","description":"Emitted after column is resized."},{"name":"contextMenu","type":"CustomEvent<IgcGridContextMenuEventArgs>","description":"Emitted when a cell or row is right clicked."},{"name":"doubleClick","type":"CustomEvent<IgcGridCellEventArgs>","description":"Emitted when a cell is double clicked."},{"name":"columnVisibilityChanging","type":"CustomEvent<IgcColumnVisibilityChangingEventArgs>","description":"Emitted before column visibility is changed."},{"name":"columnVisibilityChanged","type":"CustomEvent<IgcColumnVisibilityChangedEventArgs>","description":"Emitted after column visibility is changed."},{"name":"columnMovingStart","type":"CustomEvent<IgcColumnMovingStartEventArgs>","description":"Emitted when column moving starts."},{"name":"columnMoving","type":"CustomEvent<IgcColumnMovingEventArgs>","description":"Emitted during the column moving operation."},{"name":"columnMovingEnd","type":"CustomEvent<IgcColumnMovingEndEventArgs>","description":"Emitted when column moving ends."},{"name":"gridKeydown","type":"CustomEvent<IgcGridKeydownEventArgs>","description":"Emitted when keydown is triggered over element inside grid's body."},{"name":"rowDragStart","type":"CustomEvent<IgcRowDragStartEventArgs>","description":"Emitted when start dragging a row."},{"name":"rowDragEnd","type":"CustomEvent<IgcRowDragEndEventArgs>","description":"Emitted when dropping a row."},{"name":"gridCopy","type":"CustomEvent<IgcGridClipboardEvent>","description":"Emitted when a copy operation is executed."},{"name":"expansionStatesChange","type":"CustomEvent<Map<any, boolean>>","description":"Emitted when the rows are expanded or collapsed."},{"name":"selectedRowsChange","type":"CustomEvent<any[]>","description":"Emitted when the rows are selected or deselected."},{"name":"rowToggle","type":"CustomEvent<IgcRowToggleEventArgs>","description":"Emitted when the expanded state of a row gets changed."},{"name":"rowPinning","type":"CustomEvent<IgcPinRowEventArgs>","description":"Emitted when the pinned state of a row is changed."},{"name":"rowPinned","type":"CustomEvent<IgcPinRowEventArgs>","description":"Emitted when the pinned state of a row is changed."},{"name":"activeNodeChange","type":"CustomEvent<IgcActiveNodeChangeEventArgs>","description":"Emitted when the active node is changed."},{"name":"sortingExpressionsChange","type":"CustomEvent<IgcSortingExpression[]>","description":"Emitted before sorting is performed."},{"name":"toolbarExporting","type":"CustomEvent<IgcGridToolbarExportEventArgs>","description":"Emitted when an export process is initiated by the user."},{"name":"rangeSelected","type":"CustomEvent<IgcGridSelectionRange>","description":"Emitted when making a range selection."},{"name":"rendered","type":"CustomEvent<boolean>","description":"Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM"},{"name":"dataChanging","type":"CustomEvent<IgcForOfDataChangeEventArgs>","description":"Emitted before the grid's data view is changed because of a data operation, rebinding, etc."},{"name":"dataChanged","type":"CustomEvent<IgcForOfDataChangeEventArgs>","description":"Emitted after the grid's data view is changed because of a data operation, rebinding, etc."}]}},{"name":"igc-hierarchical-grid","description":"Hierarchical grid\n---\n\n\n### **Events:**\n - **columnsAutogenerated**\n- **childrenResolved** - Emitted when content children are resolved and collections in grid are updated.\n- **dataPreLoad** - Emitted when a new chunk of data is loaded from virtualization.\n- **filteringExpressionsTreeChange** - Emitted after filtering is performed.\n- **advancedFilteringExpressionsTreeChange** - Emitted after advanced filtering is performed.\n- **gridScroll** - Emitted when grid is scrolled horizontally/vertically.\n- **cellClick** - Emitted when a cell is clicked.\n- **rowClick** - Emitted when a row is clicked.\n- **formGroupCreated** - Emitted when formGroup is created on edit of row/cell.\n- **validationStatusChange** - Emitted when grid's validation status changes.\n- **selected** - Emitted when a cell is selected.\n- **rowSelectionChanging** - Emitted when grid row is selected.\n- **columnSelectionChanging** - Emitted when column is selected.\n- **columnPin** - Emitted before column is pinned.\n- **columnPinned** - Emitted after column is pinned.\n- **cellEditEnter** - Emitted when cell enters edit mode.\n- **cellEditExit** - Emitted when cell exits edit mode.\n- **cellEdit** - Emitted when cell has been edited.\n- **cellEditDone** - Emitted after cell has been edited and editing has been committed.\n- **rowEditEnter** - Emitted when a row enters edit mode.\n- **rowEdit** - Emitted when exiting edit mode for a row.\n- **rowEditDone** - Emitted after exiting edit mode for a row and editing has been committed.\n- **rowEditExit** - Emitted when row editing is canceled.\n- **columnInit** - Emitted when a column is initialized.\n- **sorting** - Emitted before sorting expressions are applied.\n- **sortingDone** - Emitted after sorting is completed.\n- **filtering** - Emitted before filtering expressions are applied.\n- **filteringDone** - Emitted after filtering is performed through the UI.\n- **rowAdded** - Emitted when a row is added.\n- **rowDeleted** - Emitted when a row is deleted.\n- **rowDelete** - Emmited when deleting a row.\n- **rowAdd** - Emmited just before the newly added row is commited.\n- **columnResized** - Emitted after column is resized.\n- **contextMenu** - Emitted when a cell or row is right clicked.\n- **doubleClick** - Emitted when a cell is double clicked.\n- **columnVisibilityChanging** - Emitted before column visibility is changed.\n- **columnVisibilityChanged** - Emitted after column visibility is changed.\n- **columnMovingStart** - Emitted when column moving starts.\n- **columnMoving** - Emitted during the column moving operation.\n- **columnMovingEnd** - Emitted when column moving ends.\n- **gridKeydown** - Emitted when keydown is triggered over element inside grid's body.\n- **rowDragStart** - Emitted when start dragging a row.\n- **rowDragEnd** - Emitted when dropping a row.\n- **gridCopy** - Emitted when a copy operation is executed.\n- **expansionStatesChange** - Emitted when the rows are expanded or collapsed.\n- **selectedRowsChange** - Emitted when the rows are selected or deselected.\n- **rowToggle** - Emitted when the expanded state of a row gets changed.\n- **rowPinning** - Emitted when the pinned state of a row is changed.\n- **rowPinned** - Emitted when the pinned state of a row is changed.\n- **activeNodeChange** - Emitted when the active node is changed.\n- **sortingExpressionsChange** - Emitted before sorting is performed.\n- **toolbarExporting** - Emitted when an export process is initiated by the user.\n- **rangeSelected** - Emitted when making a range selection.\n- **rendered** - Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM\n- **dataChanging** - Emitted before the grid's data view is changed because of a data operation, rebinding, etc.\n- **dataChanged** - Emitted after the grid's data view is changed because of a data operation, rebinding, etc.","doc-url":"","attributes":[{"name":"child-layout-list","value":{"type":"IgcRowIslandComponent[]"}},{"name":"action-strip-components","value":{"type":"IgcActionStripToken[]"}},{"name":"id","description":"Gets/Sets the value of the `id` attribute.","value":{"type":"string"}},{"name":"data","description":"Gets/Sets the array of data that populates the component.","value":{"type":"any[]"}},{"name":"total-item-count","description":"Gets/Sets the total number of records in the data source.","value":{"type":"number"}},{"name":"expand-children","description":"Sets if all immediate children of the hierarchical grid should be expanded/collapsed.  Default value is false.","value":{"type":"boolean"}},{"name":"resource-strings","description":"Gets/Sets the resource strings.","value":{"type":"IgcGridResourceStrings"}},{"name":"has-children-key","description":"Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.","value":{"type":"string"}},{"name":"show-expand-all","description":"Gets/Sets whether the expand/collapse all button in the header should be rendered.","value":{"type":"boolean"}},{"name":"root-grid","value":{"type":"IgcGridBaseDirective"}},{"name":"snackbar-display-time","description":"Gets/Sets the display time for the row adding snackbar notification.","value":{"type":"number"}},{"name":"auto-generate","description":"Gets/Sets whether to auto-generate the columns.","value":{"type":"boolean"}},{"name":"auto-generate-exclude","description":"Gets/Sets a list of property keys to be excluded from the generated column collection","value":{"type":"string[]"}},{"name":"moving","description":"Controls whether columns moving is enabled in the grid.","value":{"type":"boolean"}},{"name":"summary-row-height","description":"Get/Set summary row height","value":{"type":"number"}},{"name":"data-clone-strategy","description":"Gets/Sets the data clone strategy of the grid when in edit mode.","value":{"type":"IgcDataCloneStrategy"}},{"name":"clipboard-options","description":"Controls the copy behavior of the grid.","value":{"type":"IgcClipboardOptions"}},{"name":"row-classes","description":"Sets a conditional class selector to the grid's row element.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class and the value is  either a callback function that returns a boolean, or boolean, like so:","value":{"type":"any"}},{"name":"row-styles","description":"Sets conditional style properties on the grid row element.  It accepts an object literal where the keys are  the style properties and the value is an expression to be evaluated.","value":{"type":"any"}},{"name":"primary-key","description":"Gets/Sets the primary key.","value":{"type":"string"}},{"name":"column-list","value":{"type":"IgcColumnComponent[]"}},{"name":"toolbar","value":{"type":"IgcGridToolbarComponent[]"}},{"name":"pagination-components","value":{"type":"IgcPaginatorComponent[]"}},{"name":"filtering-logic","description":"Gets/Sets the filtering logic of the grid.","value":{"type":"FilteringLogic"}},{"name":"filtering-expressions-tree","description":"Gets/Sets the filtering state.","value":{"type":"IgcFilteringExpressionsTree"}},{"name":"advanced-filtering-expressions-tree","description":"Gets/Sets the advanced filtering state.","value":{"type":"IgcFilteringExpressionsTree"}},{"name":"locale","description":"Gets/Sets the locale.","value":{"type":"string"}},{"name":"paging-mode","value":{"type":"GridPagingMode"}},{"name":"hide-row-selectors","description":"Gets/Sets if the row selectors are hidden.","value":{"type":"boolean"}},{"name":"row-draggable","description":"Gets/Sets whether rows can be moved.","value":{"type":"boolean"}},{"name":"validation-trigger","description":"Gets/Sets the trigger for validators used when editing the grid.","value":{"type":"GridValidationTrigger"}},{"name":"row-editable","description":"Gets/Sets whether the rows are editable.","value":{"type":"boolean"}},{"name":"height","description":"Gets/Sets the height.","value":{"type":"string"}},{"name":"width","description":"Gets/Sets the width of the grid.","value":{"type":"string"}},{"name":"row-height","description":"Gets/Sets the row height.","value":{"type":"number"}},{"name":"column-width","description":"Gets/Sets the default width of the columns.","value":{"type":"stri