igniteui-webcomponents-grids/vscode.html-custom-data.json

Ignite UI Web Components grid components.

{
      "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
      "version": 1.1,
      "tags": [{"name":"igc-grid-state","description":"State component allows saving and restoring the state of the grid features.\n---\n\n\n### **Events:**\n - **stateParsed** - Event emitted when set state is called with a string.  Returns the parsed state object so that it can be further modified before applying to the grid.","attributes":[{"name":"options","description":"An object with options determining if a certain feature state should be saved.","values":[{"name":"IgcGridStateOptions"}]}],"references":[]},{"name":"igc-action-strip","description":"Action Strip provides templatable area for one or more actions.\n---\n","attributes":[{"name":"action-buttons","description":"ActionButton as ContentChildren inside the Action Strip","values":[{"name":"IgcGridActionsBaseDirective[]"}]},{"name":"hidden","description":"Gets/Sets the visibility of the Action Strip.  Could be used to set if the Action Strip will be initially hidden.","values":[]},{"name":"resource-strings","description":"Gets/Sets the resource strings.","values":[{"name":"IgcActionStripResourceStrings"}]}],"references":[]},{"name":"igc-grid-editing-actions","description":"Grid Editing Actions for the Action Strip\n---\n","attributes":[{"name":"add-row","description":"An input to enable/disable action strip row adding button","values":[]},{"name":"edit-row","description":"An input to enable/disable action strip row editing button","values":[]},{"name":"delete-row","description":"An input to enable/disable action strip row deleting button","values":[]},{"name":"add-child","description":"An input to enable/disable action strip child row adding button","values":[]},{"name":"as-menu-items","description":"Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label.","values":[]}],"references":[]},{"name":"igc-grid-pinning-actions","description":"Grid Pinning Actions for the Action Strip\n---\n","attributes":[{"name":"as-menu-items","description":"Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label.","values":[]}],"references":[]},{"name":"igc-column-group","description":"**Ignite UI for Angular Column Group**\n---\n\n\n### **Events:**\n - **hiddenChange** - Emitted when the column is hidden or shown.\n- **expandedChange** - Emitted when the column expanded or collapsed.\n- **widthChange** - Emitted when the column width changes.\n- **pinnedChange** - Emitted when the column is pinned/unpinned.","attributes":[{"name":"children","values":[{"name":"HTMLCollection"}]},{"name":"collapsible","description":"Set if the column group is collapsible.  Default value is `false`","values":[]},{"name":"expanded","description":"Set whether the group is expanded or collapsed initially.  Applied only if the collapsible property is set to `true`  Default value is `true`","values":[]},{"name":"field","description":"Sets/gets the `field` value.","values":[]},{"name":"header","description":"Sets/gets the `header` value.","values":[]},{"name":"title","description":"Sets/gets the `title` value.","values":[]},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","values":[]},{"name":"selectable","description":"Returns if the column is selectable.","values":[]},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","values":[]},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","values":[]},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","values":[]},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","values":[]},{"name":"autosize-header","description":"Sets/gets whether the column header is included in autosize logic.  Useful when template for a column header is sized based on parent, for example a default `div`.  Default value is `false`.","values":[]},{"name":"has-summary","description":"Gets a value indicating whether the summary for the column is enabled.","values":[]},{"name":"hidden","description":"Gets whether the column is hidden.","values":[]},{"name":"selected","description":"Returns if the column is selected.","values":[]},{"name":"disable-hiding","description":"Gets whether the hiding is disabled.","values":[]},{"name":"disable-pinning","description":"Gets whether the pinning is disabled.","values":[]},{"name":"width","description":"Gets the `width` of the column.","values":[]},{"name":"max-width","description":"Sets/gets the maximum `width` of the column.","values":[]},{"name":"header-classes","description":"Sets/gets the class selector of the column header.","values":[]},{"name":"header-styles","description":"Sets conditional style properties on the column header.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","values":[]},{"name":"header-group-classes","description":"Sets/gets the class selector of the column group header.","values":[]},{"name":"header-group-styles","description":"Sets conditional style properties on the column header group wrapper.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","values":[]},{"name":"cell-classes","description":"Sets a conditional class selector of the column cells.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class, while the  value is either a callback function that returns a boolean,  or boolean, like so:","values":[]},{"name":"cell-styles","description":"Sets conditional style properties on the column cells.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.  As with `cellClasses` it accepts a callback function.","values":[]},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","values":[]},{"name":"summary-formatter","description":"The summaryFormatter is used to format the display of the column summaries.   In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter  to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.","values":[]},{"name":"filtering-ignore-case","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","values":[]},{"name":"sorting-ignore-case","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","values":[]},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","values":[]},{"name":"data-type","description":"Sets/gets the data type of the column values.  Default value is `string`.","values":[{"name":"GridColumnDataType"}]},{"name":"row-end","description":"Row index where the current field should end.  The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field","values":[]},{"name":"col-end","description":"Column index where the current field should end.  The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field","values":[]},{"name":"row-start","description":"Row index from which the field is starting.","values":[]},{"name":"col-start","description":"Column index from which the field is starting.","values":[]},{"name":"additional-template-context","description":"Sets/gets custom properties provided in additional template context.","values":[]},{"name":"min-width","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","values":[]},{"name":"pinned","description":"Gets whether the column is `pinned`.","values":[]},{"name":"summaries","description":"Gets the column `summaries`.","values":[]},{"name":"disabled-summaries","description":"Sets/gets the summary operands to exclude from display.  Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.","values":[{"name":"string[]"}]},{"name":"filters","description":"Gets the column `filters`.","values":[{"name":"IgcFilteringOperand"}]},{"name":"sort-strategy","description":"Gets the column `sortStrategy`.","values":[{"name":"IgcSortingStrategy"}]},{"name":"visible-when-collapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","values":[]},{"name":"pipe-args","values":[{"name":"IgcColumnPipeArgs"}]},{"name":"editor-options","description":"Pass optional properties for the default column editors.","values":[{"name":"IgcColumnEditorOptions"}]},{"name":"parent","description":"Sets/gets the parent column.","values":[]}],"references":[]},{"name":"igc-column","description":"**Ignite UI for Angular Column** -  [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid#columns-configuration)   The Ignite UI Column is used within an `igx-grid` element to define what data the column will show. Features such as sorting,  filtering & editing are enabled at the column level.  You can also provide a template containing custom content inside  the column using `ng-template` which will be used for all cells within the column.\n---\n\n\n### **Events:**\n - **hiddenChange** - Emitted when the column is hidden or shown.\n- **expandedChange** - Emitted when the column expanded or collapsed.\n- **widthChange** - Emitted when the column width changes.\n- **pinnedChange** - Emitted when the column is pinned/unpinned.","attributes":[{"name":"field","description":"Sets/gets the `field` value.","values":[]},{"name":"header","description":"Sets/gets the `header` value.","values":[]},{"name":"title","description":"Sets/gets the `title` value.","values":[]},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","values":[]},{"name":"selectable","description":"Returns if the column is selectable.","values":[]},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","values":[]},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","values":[]},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","values":[]},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","values":[]},{"name":"autosize-header","description":"Sets/gets whether the column header is included in autosize logic.  Useful when template for a column header is sized based on parent, for example a default `div`.  Default value is `false`.","values":[]},{"name":"has-summary","description":"Gets a value indicating whether the summary for the column is enabled.","values":[]},{"name":"hidden","description":"Gets whether the column is hidden.","values":[]},{"name":"selected","description":"Returns if the column is selected.","values":[]},{"name":"disable-hiding","description":"Gets whether the hiding is disabled.","values":[]},{"name":"disable-pinning","description":"Gets whether the pinning is disabled.","values":[]},{"name":"width","description":"Gets the `width` of the column.","values":[]},{"name":"max-width","description":"Sets/gets the maximum `width` of the column.","values":[]},{"name":"header-classes","description":"Sets/gets the class selector of the column header.","values":[]},{"name":"header-styles","description":"Sets conditional style properties on the column header.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","values":[]},{"name":"header-group-classes","description":"Sets/gets the class selector of the column group header.","values":[]},{"name":"header-group-styles","description":"Sets conditional style properties on the column header group wrapper.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","values":[]},{"name":"cell-classes","description":"Sets a conditional class selector of the column cells.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class, while the  value is either a callback function that returns a boolean,  or boolean, like so:","values":[]},{"name":"cell-styles","description":"Sets conditional style properties on the column cells.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.  As with `cellClasses` it accepts a callback function.","values":[]},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","values":[]},{"name":"summary-formatter","description":"The summaryFormatter is used to format the display of the column summaries.   In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter  to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.","values":[]},{"name":"filtering-ignore-case","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","values":[]},{"name":"sorting-ignore-case","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","values":[]},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","values":[]},{"name":"data-type","description":"Sets/gets the data type of the column values.  Default value is `string`.","values":[{"name":"GridColumnDataType"}]},{"name":"row-end","description":"Row index where the current field should end.  The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field","values":[]},{"name":"col-end","description":"Column index where the current field should end.  The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field","values":[]},{"name":"row-start","description":"Row index from which the field is starting.","values":[]},{"name":"col-start","description":"Column index from which the field is starting.","values":[]},{"name":"additional-template-context","description":"Sets/gets custom properties provided in additional template context.","values":[]},{"name":"min-width","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","values":[]},{"name":"pinned","description":"Gets whether the column is `pinned`.","values":[]},{"name":"summaries","description":"Gets the column `summaries`.","values":[]},{"name":"disabled-summaries","description":"Sets/gets the summary operands to exclude from display.  Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.","values":[{"name":"string[]"}]},{"name":"filters","description":"Gets the column `filters`.","values":[{"name":"IgcFilteringOperand"}]},{"name":"sort-strategy","description":"Gets the column `sortStrategy`.","values":[{"name":"IgcSortingStrategy"}]},{"name":"visible-when-collapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","values":[]},{"name":"pipe-args","values":[{"name":"IgcColumnPipeArgs"}]},{"name":"editor-options","description":"Pass optional properties for the default column editors.","values":[{"name":"IgcColumnEditorOptions"}]},{"name":"parent","description":"Sets/gets the parent column.","values":[]}],"references":[]},{"name":"igc-column-layout","description":"Column layout for declaration of Multi-row Layout\n---\n\n\n### **Events:**\n - **hiddenChange** - Emitted when the column is hidden or shown.\n- **expandedChange** - Emitted when the column expanded or collapsed.\n- **widthChange** - Emitted when the column width changes.\n- **pinnedChange** - Emitted when the column is pinned/unpinned.","attributes":[{"name":"children","values":[{"name":"HTMLCollection"}]},{"name":"collapsible","description":"Set if the column group is collapsible.  Default value is `false`","values":[]},{"name":"expanded","description":"Set whether the group is expanded or collapsed initially.  Applied only if the collapsible property is set to `true`  Default value is `true`","values":[]},{"name":"field","description":"Sets/gets the `field` value.","values":[]},{"name":"header","description":"Sets/gets the `header` value.","values":[]},{"name":"title","description":"Sets/gets the `title` value.","values":[]},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","values":[]},{"name":"selectable","description":"Returns if the column is selectable.","values":[]},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","values":[]},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","values":[]},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","values":[]},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","values":[]},{"name":"autosize-header","description":"Sets/gets whether the column header is included in autosize logic.  Useful when template for a column header is sized based on parent, for example a default `div`.  Default value is `false`.","values":[]},{"name":"has-summary","description":"Gets a value indicating whether the summary for the column is enabled.","values":[]},{"name":"hidden","description":"Gets whether the column is hidden.","values":[]},{"name":"selected","description":"Returns if the column is selected.","values":[]},{"name":"disable-hiding","description":"Gets whether the hiding is disabled.","values":[]},{"name":"disable-pinning","description":"Gets whether the pinning is disabled.","values":[]},{"name":"width","description":"Gets the `width` of the column.","values":[]},{"name":"max-width","description":"Sets/gets the maximum `width` of the column.","values":[]},{"name":"header-classes","description":"Sets/gets the class selector of the column header.","values":[]},{"name":"header-styles","description":"Sets conditional style properties on the column header.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","values":[]},{"name":"header-group-classes","description":"Sets/gets the class selector of the column group header.","values":[]},{"name":"header-group-styles","description":"Sets conditional style properties on the column header group wrapper.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","values":[]},{"name":"cell-classes","description":"Sets a conditional class selector of the column cells.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class, while the  value is either a callback function that returns a boolean,  or boolean, like so:","values":[]},{"name":"cell-styles","description":"Sets conditional style properties on the column cells.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.  As with `cellClasses` it accepts a callback function.","values":[]},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","values":[]},{"name":"summary-formatter","description":"The summaryFormatter is used to format the display of the column summaries.   In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter  to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.","values":[]},{"name":"filtering-ignore-case","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","values":[]},{"name":"sorting-ignore-case","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","values":[]},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","values":[]},{"name":"data-type","description":"Sets/gets the data type of the column values.  Default value is `string`.","values":[{"name":"GridColumnDataType"}]},{"name":"row-end","description":"Row index where the current field should end.  The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field","values":[]},{"name":"col-end","description":"Column index where the current field should end.  The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field","values":[]},{"name":"row-start","description":"Row index from which the field is starting.","values":[]},{"name":"col-start","description":"Column index from which the field is starting.","values":[]},{"name":"additional-template-context","description":"Sets/gets custom properties provided in additional template context.","values":[]},{"name":"min-width","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","values":[]},{"name":"pinned","description":"Gets whether the column is `pinned`.","values":[]},{"name":"summaries","description":"Gets the column `summaries`.","values":[]},{"name":"disabled-summaries","description":"Sets/gets the summary operands to exclude from display.  Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.","values":[{"name":"string[]"}]},{"name":"filters","description":"Gets the column `filters`.","values":[{"name":"IgcFilteringOperand"}]},{"name":"sort-strategy","description":"Gets the column `sortStrategy`.","values":[{"name":"IgcSortingStrategy"}]},{"name":"visible-when-collapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","values":[]},{"name":"pipe-args","values":[{"name":"IgcColumnPipeArgs"}]},{"name":"editor-options","description":"Pass optional properties for the default column editors.","values":[{"name":"IgcColumnEditorOptions"}]},{"name":"parent","description":"Sets/gets the parent column.","values":[]}],"references":[]},{"name":"igc-grid","description":"Grid provides a way to present and manipulate tabular data.\n---\n\n\n### **Events:**\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 `IgxGridRowComponent` is selected.\n- **columnSelectionChanging** - Emitted when `IgxColumnComponent` is selected.\n- **columnPin** - Emitted before `IgxColumnComponent` is pinned.\n- **columnPinned** - Emitted after `IgxColumnComponent` 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- **columnsAutogenerated**\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.","attributes":[{"name":"groups-expanded","description":"Gets/Sets whether created groups are rendered expanded or collapsed.","values":[]},{"name":"id","description":"Gets/Sets the value of the `id` attribute.","values":[]},{"name":"data","description":"Gets/Sets the array of data that populates the component.","values":[{"name":"any[]"}]},{"name":"total-item-count","description":"Gets/Sets the total number of records in the data source.","values":[]},{"name":"grouping-expressions","description":"Gets/Sets the group by state.","values":[{"name":"IgcGroupingExpression[]"}]},{"name":"grouping-expansion-state","description":"Gets/Sets a list of expansion states for group rows.","values":[{"name":"IgcGroupByExpandState[]"}]},{"name":"hide-grouped-columns","description":"Gets/Sets whether the grouped columns should be hidden.","values":[]},{"name":"group-strategy","description":"Gets/Sets the grouping strategy of the grid.","values":[{"name":"IgcGridGroupingStrategy"}]},{"name":"drop-area-message","description":"Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on.","values":[]},{"name":"show-group-area","description":"Returns whether the `IgxGridComponent` has group area.","values":[]},{"name":"snackbar-display-time","description":"Gets/Sets the display time for the row adding snackbar notification.","values":[]},{"name":"auto-generate","description":"Gets/Sets whether to auto-generate the columns.","values":[]},{"name":"auto-generate-exclude","description":"Gets/Sets a list of property keys to be excluded from the generated column collection","values":[{"name":"string[]"}]},{"name":"moving","description":"Controls whether columns moving is enabled in the grid.","values":[]},{"name":"summary-row-height","description":"Get/Set IgxSummaryRow height","values":[]},{"name":"data-clone-strategy","description":"Gets/Sets the data clone strategy of the grid when in edit mode.","values":[{"name":"IgcDataCloneStrategy"}]},{"name":"clipboard-options","description":"Controls the copy behavior of the grid.","values":[{"name":"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:","values":[]},{"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.","values":[]},{"name":"primary-key","description":"Gets/Sets the primary key.","values":[]},{"name":"column-list","values":[{"name":"IgcColumnComponent[]"}]},{"name":"action-strip-components","values":[{"name":"IgcActionStripToken[]"}]},{"name":"toolbar","values":[{"name":"IgcGridToolbarComponent[]"}]},{"name":"pagination-components","values":[{"name":"IgcPaginatorComponent[]"}]},{"name":"resource-strings","description":"Gets/Sets the resource strings.","values":[{"name":"IgcGridResourceStrings"}]},{"name":"filtering-logic","description":"Gets/Sets the filtering logic of the `IgxGridComponent`.","values":[{"name":"FilteringLogic"}]},{"name":"filtering-expressions-tree","description":"Gets/Sets the filtering state.","values":[{"name":"IgcFilteringExpressionsTree"}]},{"name":"advanced-filtering-expressions-tree","description":"Gets/Sets the advanced filtering state.","values":[{"name":"IgcFilteringExpressionsTree"}]},{"name":"locale","description":"Gets/Sets the locale.","values":[]},{"name":"paging-mode","values":[{"name":"GridPagingMode"}]},{"name":"hide-row-selectors","description":"Gets/Sets if the row selectors are hidden.","values":[]},{"name":"row-draggable","description":"Gets/Sets whether rows can be moved.","values":[]},{"name":"validation-trigger","description":"Gets/Sets the trigger for validators used when editing the grid.","values":[{"name":"GridValidationTrigger"}]},{"name":"row-editable","description":"Gets/Sets whether the rows are editable.","values":[]},{"name":"height","description":"Gets/Sets the height.","values":[]},{"name":"width","description":"Gets/Sets the width of the grid.","values":[]},{"name":"row-height","description":"Gets/Sets the row height.","values":[]},{"name":"column-width","description":"Gets/Sets the default width of the columns.","values":[]},{"name":"empty-grid-message","description":"Get/Sets the message displayed when there are no records.","values":[]},{"name":"is-loading","description":"Gets/Sets whether the grid is going to show a loading indicator.","values":[]},{"name":"should-generate","description":"Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid","values":[]},{"name":"empty-filtered-grid-message","description":"Gets/Sets the message displayed when there are no records and the grid is filtered.","values":[]},{"name":"pinning","description":"Gets/Sets the initial pinning configuration.","values":[{"name":"IgcPinningConfig"}]},{"name":"allow-filtering","description":"Gets/Sets if the filtering is enabled.","values":[]},{"name":"allow-advanced-filtering","description":"Gets/Sets a value indicating whether the advanced filtering is enabled.","values":[]},{"name":"filter-mode","description":"Gets/Sets the filter mode.","values":[{"name":"FilterMode"}]},{"name":"summary-position","description":"Gets/Sets the summary position.","values":[{"name":"GridSummaryPosition"}]},{"name":"summary-calculation-mode","description":"Gets/Sets the summary calculation mode.","values":[{"name":"GridSummaryCalculationMode"}]},{"name":"show-summary-on-collapse","description":"Controls whether the summary row is visible when groupBy/parent row is collapsed.","values":[]},{"name":"filter-strategy","description":"Gets/Sets the filtering strategy of the grid.","values":[{"name":"IgcFilteringStrategy"}]},{"name":"sort-strategy","description":"Gets/Sets the sorting strategy of the grid.","values":[{"name":"IgcGridSortingStrategy"}]},{"name":"sorting-options","description":"Gets/Sets the sorting options - single or multiple sorting.  Accepts an `ISortingOptions` object with any of the `mode` properties.","values":[{"name":"IgcSortingOptions"}]},{"name":"selected-rows","description":"Gets/Sets the current selection state.","values":[{"name":"any[]"}]},{"name":"sorting-expressions","description":"Gets/Sets the sorting state.","values":[{"name":"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.","values":[]},{"name":"cell-selection","description":"Gets/Sets cell selection mode.","values":[{"name":"GridSelectionMode"}]},{"name":"row-selection","description":"Gets/Sets row selection mode","values":[{"name":"GridSelectionMode"}]},{"name":"column-selection","description":"Gets/Sets column selection mode","values":[{"name":"GridSelectionMode"}]},{"name":"expansion-states","description":"Gets/Sets a list of key-value pairs [row ID, expansion state].","values":[{"name":"Map<any"},{"name":"boolean>"}]},{"name":"outlet","description":"Gets/Sets the outlet used to attach the grid's overlays to.","values":[{"name":"IgcOverlayOutletDirective"}]},{"name":"total-records","description":"Returns the total number of records.","values":[]},{"name":"select-row-on-click","description":"Gets/Sets whether clicking over a row should select/deselect it","values":[]}],"references":[]},{"name":"igc-hierarchical-grid","description":"Hierarchical grid\n---\n\n\n### **Events:**\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 `IgxGridRowComponent` is selected.\n- **columnSelectionChanging** - Emitted when `IgxColumnComponent` is selected.\n- **columnPin** - Emitted before `IgxColumnComponent` is pinned.\n- **columnPinned** - Emitted after `IgxColumnComponent` 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- **columnsAutogenerated**\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.","attributes":[{"name":"child-layout-list","values":[{"name":"IgcRowIslandComponent[]"}]},{"name":"advanced-filtering-expressions-tree","values":[{"name":"IgcFilteringExpressionsTree"}]},{"name":"id","description":"Gets/Sets the value of the `id` attribute.","values":[]},{"name":"data","description":"Gets/Sets the array of data that populates the component.","values":[{"name":"any[]"}]},{"name":"total-item-count","description":"Gets/Sets the total number of records in the data source.","values":[]},{"name":"expand-children","description":"Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed.  Default value is false.","values":[]},{"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.","values":[]},{"name":"show-expand-all","description":"Gets/Sets whether the expand/collapse all button in the header should be rendered.","values":[]},{"name":"root-grid","values":[{"name":"IgcGridBaseDirective"}]},{"name":"snackbar-display-time","description":"Gets/Sets the display time for the row adding snackbar notification.","values":[]},{"name":"auto-generate","description":"Gets/Sets whether to auto-generate the columns.","values":[]},{"name":"auto-generate-exclude","description":"Gets/Sets a list of property keys to be excluded from the generated column collection","values":[{"name":"string[]"}]},{"name":"moving","description":"Controls whether columns moving is enabled in the grid.","values":[]},{"name":"summary-row-height","description":"Get/Set IgxSummaryRow height","values":[]},{"name":"data-clone-strategy","description":"Gets/Sets the data clone strategy of the grid when in edit mode.","values":[{"name":"IgcDataCloneStrategy"}]},{"name":"clipboard-options","description":"Controls the copy behavior of the grid.","values":[{"name":"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:","values":[]},{"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.","values":[]},{"name":"primary-key","description":"Gets/Sets the primary key.","values":[]},{"name":"column-list","values":[{"name":"IgcColumnComponent[]"}]},{"name":"action-strip-components","values":[{"name":"IgcActionStripToken[]"}]},{"name":"toolbar","values":[{"name":"IgcGridToolbarComponent[]"}]},{"name":"pagination-components","values":[{"name":"IgcPaginatorComponent[]"}]},{"name":"resource-strings","description":"Gets/Sets the resource strings.","values":[{"name":"IgcGridResourceStrings"}]},{"name":"filtering-logic","description":"Gets/Sets the filtering logic of the `IgxGridComponent`.","values":[{"name":"FilteringLogic"}]},{"name":"filtering-expressions-tree","description":"Gets/Sets the filtering state.","values":[{"name":"IgcFilteringExpressionsTree"}]},{"name":"locale","description":"Gets/Sets the locale.","values":[]},{"name":"paging-mode","values":[{"name":"GridPagingMode"}]},{"name":"hide-row-selectors","description":"Gets/Sets if the row selectors are hidden.","values":[]},{"name":"row-draggable","description":"Gets/Sets whether rows can be moved.","values":[]},{"name":"validation-trigger","description":"Gets/Sets the trigger for validators used when editing the grid.","values":[{"name":"GridValidationTrigger"}]},{"name":"row-editable","description":"Gets/Sets whether the rows are editable.","values":[]},{"name":"height","description":"Gets/Sets the height.","values":[]},{"name":"width","description":"Gets/Sets the width of the grid.","values":[]},{"name":"row-height","description":"Gets/Sets the row height.","values":[]},{"name":"column-width","description":"Gets/Sets the default width of the columns.","values":[]},{"name":"empty-grid-message","description":"Get/Sets the message displayed when there are no records.","values":[]},{"name":"is-loading","description":"Gets/Sets whether the grid is going to show a loading indicator.","values":[]},{"name":"should-generate","description":"Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid","values":[]},{"name":"empty-filtered-grid-message","description":"Gets/Sets the message displayed when there are no records and the grid is filtered.","values":[]},{"name":"pinning","description":"Gets/Sets the initial pinning configuration.","values":[{"name":"IgcPinningConfig"}]},{"name":"allow-filtering","description":"Gets/Sets if the filtering is enabled.","values":[]},{"name":"allow-advanced-filtering","description":"Gets/Sets a value indicating whether the advanced filtering is enabled.","values":[]},{"name":"filter-mode","description":"Gets/Sets the filter mode.","values":[{"name":"FilterMode"}]},{"name":"summary-position","description":"Gets/Sets the summary position.","values":[{"name":"GridSummaryPosition"}]},{"name":"summary-calculation-mode","description":"Gets/Sets the summary calculation mode.","values":[{"name":"GridSummaryCalculationMode"}]},{"name":"show-summary-on-collapse","description":"Controls whether the summary row is visible when groupBy/parent row is collapsed.","values":[]},{"name":"filter-strategy","description":"Gets/Sets the filtering strategy of the grid.","values":[{"name":"IgcFilteringStrategy"}]},{"name":"sort-strategy","description":"Gets/Sets the sorting strategy of the grid.","values":[{"name":"IgcGridSortingStrategy"}]},{"name":"sorting-options","description":"Gets/Sets the sorting options - single or multiple sorting.  Accepts an `ISortingOptions` object with any of the `mode` properties.","values":[{"name":"IgcSortingOptions"}]},{"name":"selected-rows","description":"Gets/Sets the current selection state.","values":[{"name":"any[]"}]},{"name":"sorting-expressions","description":"Gets/Sets the sorting state.","values":[{"name":"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.","values":[]},{"name":"cell-selection","description":"Gets/Sets cell selection mode.","values":[{"name":"GridSelectionMode"}]},{"name":"row-selection","description":"Gets/Sets row selection mode","values":[{"name":"GridSelectionMode"}]},{"name":"column-selection","description":"Gets/Sets column selection mode","values":[{"name":"GridSelectionMode"}]},{"name":"expansion-states","description":"Gets/Sets a list of key-value pairs [row ID, expansion state].","values":[{"name":"Map<any"},{"name":"boolean>"}]},{"name":"outlet","description":"Gets/Sets the outlet used to attach the grid's overlays to.","values":[{"name":"IgcOverlayOutletDirective"}]},{"name":"total-records","description":"Returns the total number of records.","values":[]},{"name":"select-row-on-click","description":"Gets/Sets whether clicking over a row should select/deselect it","values":[]}],"references":[]},{"name":"igc-row-island","description":"Row island\n---\n\n\n### **Events:**\n - **gridCreated** - Event emitted when a grid is being created based on this row island.\n- **gridInitialized** - Emitted after a grid is being initialized for this row island.  The emitting is done in `ngAfterViewInit`.\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 `IgxGridRowComponent` is selected.\n- **columnSelectionChanging** - Emitted when `IgxColumnComponent` is selected.\n- **columnPin** - Emitted before `IgxColumnComponent` is pinned.\n- **columnPinned** - Emitted after `IgxColumnComponent` 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- **columnsAutogenerated**\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 befo