{ "schemaVersion": "1.0.0", "modules": [ { "kind": "javascript-module", "path": "grids/index.ts", "declarations": [ { "kind": "class", "name": "IgcGridStateComponent", "description": "State component allows saving and restoring the state of the grid features.", "members": [ { "kind": "field", "privacy": "public", "name": "options", "description": "An object with options determining if a certain feature state should be saved.", "attribute": "options", "type": { "text": "IgcGridStateOptions" } }, { "kind": "method", "privacy": "public", "name": "applyState", "description": "Restores grid features' state based on the IGridStateInfo object passed as an argument.", "parameters": [ { "name": "state", "type": { "text": "IgcGridStateInfo" }, "optional": false }, { "name": "features", "type": { "text": "string[]" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "applyStateFromString", "description": "Restores grid features' state based on the serialized IGridState object passed as an argument.", "parameters": [ { "name": "state", "type": { "text": "string" }, "optional": false }, { "name": "features", "type": { "text": "string[]" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getState", "description": "Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the `options` property.", "parameters": [ { "name": "features", "type": { "text": "string[]" }, "optional": true } ], "return": { "type": { "text": "IgcGridStateInfo" } } }, { "kind": "method", "privacy": "public", "name": "getStateAsString", "description": "Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the `options` property.", "parameters": [ { "name": "features", "type": { "text": "string[]" }, "optional": true } ], "return": { "type": { "text": "string" } } } ], "attributes": [ { "name": "options", "type": { "text": "IgcGridStateOptions" }, "fieldName": "options", "description": "An object with options determining if a certain feature state should be saved." } ], "events": [ { "name": "stateParsed", "description": "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.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-state", "customElement": true }, { "kind": "class", "name": "IgcActionStripComponent", "description": "Action Strip provides templatable area for one or more actions.", "members": [ { "kind": "field", "privacy": "public", "name": "actionButtons", "description": "ActionButton as ContentChildren inside the Action Strip", "attribute": "action-buttons", "type": { "text": "IgcGridActionsBaseDirective[]" } }, { "kind": "field", "privacy": "public", "name": "hidden", "description": "Gets/Sets the visibility of the Action Strip. Could be used to set if the Action Strip will be initially hidden.", "attribute": "hidden", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcActionStripResourceStrings" } }, { "kind": "method", "privacy": "public", "name": "show", "description": "Showing the Action Strip and appending it the specified context element.", "parameters": [ { "name": "context", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "hide", "description": "Hiding the Action Strip and removing it from its current context element.", "parameters": [], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "action-buttons", "type": { "text": "IgcGridActionsBaseDirective[]" }, "fieldName": "actionButtons", "description": "ActionButton as ContentChildren inside the Action Strip" }, { "name": "hidden", "type": { "text": "boolean" }, "fieldName": "hidden", "description": "Gets/Sets the visibility of the Action Strip. Could be used to set if the Action Strip will be initially hidden." }, { "name": "resource-strings", "type": { "text": "IgcActionStripResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." } ], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-action-strip", "customElement": true }, { "kind": "class", "name": "IgcColumnGroupComponent", "description": "**Ignite UI for Angular Column Group**", "members": [ { "kind": "field", "privacy": "public", "name": "children", "deprecated": "Use the `childColumns` property instead.", "attribute": "children", "type": { "text": "HTMLCollection" } }, { "kind": "field", "privacy": "public", "name": "collapsible", "description": "Set if the column group is collapsible. Default value is `false`", "attribute": "collapsible", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "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`", "attribute": "expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "summaries", "description": "Gets the column group `summaries`.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filters", "description": "Gets the column group `filters`.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "selectable", "description": "Returns if the column group is selectable", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "collapsibleIndicatorTemplate", "description": "Allows you to define a custom template for expand/collapse indicator", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "hidden", "description": "Gets whether the column group is hidden.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selected", "description": "Returns if the column group is selected.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "childColumns", "description": "A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "columnGroup", "description": "Returns a boolean indicating if the column is a `ColumnGroup`.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayout", "description": "Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets the width of the column group.", "readonly": true, "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "field", "description": "Sets/gets the `field` value.", "attribute": "field", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "merge", "description": "Sets/gets whether to merge cells in this column.", "attribute": "merge", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "header", "description": "Sets/gets the `header` value.", "attribute": "header", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "title", "description": "Sets/gets the `title` value.", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "sortable", "description": "Sets/gets whether the column is sortable. Default value is `false`.", "attribute": "sortable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selectable", "description": "Returns if the column is selectable.", "attribute": "selectable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "groupable", "description": "Sets/gets whether the column is groupable. Default value is `false`.", "attribute": "groupable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "editable", "description": "Gets whether the column is editable. Default value is `false`.", "attribute": "editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterable", "description": "Sets/gets whether the column is filterable. Default value is `true`.", "attribute": "filterable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "resizable", "description": "Sets/gets whether the column is resizable. Default value is `false`.", "attribute": "resizable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autosizeHeader", "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`.", "attribute": "autosize-header", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hasSummary", "description": "Gets a value indicating whether the summary for the column is enabled.", "attribute": "has-summary", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hidden", "description": "Gets whether the column is hidden.", "attribute": "hidden", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selected", "description": "Returns if the column is selected.", "attribute": "selected", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "disableHiding", "description": "Gets whether the hiding is disabled.", "attribute": "disable-hiding", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "disablePinning", "description": "Gets whether the pinning is disabled.", "attribute": "disable-pinning", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets the `width` of the column.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "maxWidth", "description": "Sets/gets the maximum `width` of the column.", "attribute": "max-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerClasses", "description": "Sets/gets the class selector of the column header.", "attribute": "header-classes", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerStyles", "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.", "attribute": "header-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "headerGroupClasses", "description": "Sets/gets the class selector of the column group header.", "attribute": "header-group-classes", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerGroupStyles", "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.", "attribute": "header-group-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "cellClasses", "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:", "attribute": "cell-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "cellStyles", "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.", "attribute": "cell-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "formatter", "description": "Applies display format to cell values in the column. Does not modify the underlying data.", "attribute": "formatter", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "summaryFormatter", "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.", "attribute": "summary-formatter", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteringIgnoreCase", "description": "Sets/gets whether the column filtering should be case sensitive. Default value is `true`.", "attribute": "filtering-ignore-case", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "sortingIgnoreCase", "description": "Sets/gets whether the column sorting should be case sensitive. Default value is `true`.", "attribute": "sorting-ignore-case", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "searchable", "description": "Sets/gets whether the column is `searchable`. Default value is `true`.", "attribute": "searchable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "dataType", "description": "Sets/gets the data type of the column values. Default value is `string`.", "attribute": "data-type", "type": { "text": "GridColumnDataType" } }, { "kind": "field", "privacy": "public", "name": "rowEnd", "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", "attribute": "row-end", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "colEnd", "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", "attribute": "col-end", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "rowStart", "description": "Row index from which the field is starting.", "attribute": "row-start", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "colStart", "description": "Column index from which the field is starting.", "attribute": "col-start", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "additionalTemplateContext", "description": "Sets/gets custom properties provided in additional template context.", "attribute": "additional-template-context", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "minWidth", "description": "Sets/gets the minimum `width` of the column. Default value is `88`;", "attribute": "min-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "index", "description": "Gets the column index.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinningPosition", "description": "Gets the pinning position of the column.", "attribute": "pinning-position", "type": { "text": "ColumnPinningPosition" } }, { "kind": "field", "privacy": "public", "name": "pinned", "description": "Gets whether the column is `pinned`.", "attribute": "pinned", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "summaries", "description": "Gets the column `summaries`.", "attribute": "summaries", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "disabledSummaries", "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.", "attribute": "disabled-summaries", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "filters", "description": "Gets the column `filters`.", "attribute": "filters", "type": { "text": "IgcFilteringOperand" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets the column `sortStrategy`.", "attribute": "sort-strategy", "type": { "text": "IgcSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "summaryTemplate", "description": "Returns a reference to the `summaryTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "bodyTemplate", "description": "Returns a reference to the `bodyTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerTemplate", "description": "Returns a reference to the header template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "inlineEditorTemplate", "description": "Returns a reference to the inline editor template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "errorTemplate", "description": "Returns a reference to the validation error template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "filterCellTemplate", "description": "Returns a reference to the `filterCellTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "visibleIndex", "description": "Gets the column visible index. If the column is not visible, returns `-1`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnGroup", "description": "Returns a boolean indicating if the column is a `ColumnGroup`.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayout", "description": "Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayoutChild", "description": "Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "childColumns", "description": "A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "level", "description": "Returns the level of the column in a column group. Returns `0` if the column doesn't have a `parent`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "visibleWhenCollapsed", "description": "Indicates whether the column will be visible when its parent is collapsed.", "attribute": "visible-when-collapsed", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "pipeArgs", "attribute": "pipe-args", "type": { "text": "IgcColumnPipeArgs" } }, { "kind": "field", "privacy": "public", "name": "editorOptions", "description": "Pass optional properties for the default column editors.", "attribute": "editor-options", "type": { "text": "IgcColumnEditorOptions" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Returns the filteringExpressionsTree of the column.", "readonly": true, "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "parent", "description": "Sets/gets the parent column.", "attribute": "parent", "type": { "text": "IgcColumnComponent" } }, { "kind": "field", "privacy": "public", "name": "topLevelParent", "description": "Returns a reference to the top level parent column.", "readonly": true, "type": { "text": "IgcColumnComponent" } }, { "kind": "method", "privacy": "public", "name": "pin", "description": "Pins the column in the specified position at the provided index in that pinned area. Defaults to index `0` if not provided, or to the initial index in the pinned area. Returns `true` if the column is successfully pinned. Returns `false` if the column cannot be pinned. Column cannot be pinned if: - Is already pinned - index argument is out of range", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpin", "description": "Unpins the column and place it at the provided index in the unpinned area. Defaults to index `0` if not provided, or to the initial index in the unpinned area. Returns `true` if the column is successfully unpinned. Returns `false` if the column cannot be unpinned. Column cannot be unpinned if: - Is already unpinned - index argument is out of range", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "move", "description": "Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "autosize", "description": "Autosize the column to the longest currently visible cell value, including the header cell.", "parameters": [ { "name": "byHeaderOnly", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "children", "type": { "text": "HTMLCollection" }, "fieldName": "children", "deprecated": "Use the `childColumns` property instead." }, { "name": "collapsible", "type": { "text": "boolean" }, "fieldName": "collapsible", "description": "Set if the column group is collapsible. Default value is `false`" }, { "name": "expanded", "type": { "text": "boolean" }, "fieldName": "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`" }, { "name": "field", "type": { "text": "string" }, "fieldName": "field", "description": "Sets/gets the `field` value." }, { "name": "merge", "type": { "text": "boolean" }, "fieldName": "merge", "description": "Sets/gets whether to merge cells in this column." }, { "name": "header", "type": { "text": "string" }, "fieldName": "header", "description": "Sets/gets the `header` value." }, { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Sets/gets the `title` value." }, { "name": "sortable", "type": { "text": "boolean" }, "fieldName": "sortable", "description": "Sets/gets whether the column is sortable. Default value is `false`." }, { "name": "selectable", "type": { "text": "boolean" }, "fieldName": "selectable", "description": "Returns if the column is selectable." }, { "name": "groupable", "type": { "text": "boolean" }, "fieldName": "groupable", "description": "Sets/gets whether the column is groupable. Default value is `false`." }, { "name": "editable", "type": { "text": "boolean" }, "fieldName": "editable", "description": "Gets whether the column is editable. Default value is `false`." }, { "name": "filterable", "type": { "text": "boolean" }, "fieldName": "filterable", "description": "Sets/gets whether the column is filterable. Default value is `true`." }, { "name": "resizable", "type": { "text": "boolean" }, "fieldName": "resizable", "description": "Sets/gets whether the column is resizable. Default value is `false`." }, { "name": "autosize-header", "type": { "text": "boolean" }, "fieldName": "autosizeHeader", "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`." }, { "name": "has-summary", "type": { "text": "boolean" }, "fieldName": "hasSummary", "description": "Gets a value indicating whether the summary for the column is enabled." }, { "name": "hidden", "type": { "text": "boolean" }, "fieldName": "hidden", "description": "Gets whether the column is hidden." }, { "name": "selected", "type": { "text": "boolean" }, "fieldName": "selected", "description": "Returns if the column is selected." }, { "name": "disable-hiding", "type": { "text": "boolean" }, "fieldName": "disableHiding", "description": "Gets whether the hiding is disabled." }, { "name": "disable-pinning", "type": { "text": "boolean" }, "fieldName": "disablePinning", "description": "Gets whether the pinning is disabled." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets the `width` of the column." }, { "name": "max-width", "type": { "text": "string" }, "fieldName": "maxWidth", "description": "Sets/gets the maximum `width` of the column." }, { "name": "header-classes", "type": { "text": "string" }, "fieldName": "headerClasses", "description": "Sets/gets the class selector of the column header." }, { "name": "header-styles", "type": { "text": "any" }, "fieldName": "headerStyles", "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." }, { "name": "header-group-classes", "type": { "text": "string" }, "fieldName": "headerGroupClasses", "description": "Sets/gets the class selector of the column group header." }, { "name": "header-group-styles", "type": { "text": "any" }, "fieldName": "headerGroupStyles", "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." }, { "name": "cell-classes", "type": { "text": "any" }, "fieldName": "cellClasses", "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:" }, { "name": "cell-styles", "type": { "text": "any" }, "fieldName": "cellStyles", "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." }, { "name": "formatter", "type": { "text": "any" }, "fieldName": "formatter", "description": "Applies display format to cell values in the column. Does not modify the underlying data." }, { "name": "summary-formatter", "type": { "text": "any" }, "fieldName": "summaryFormatter", "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." }, { "name": "filtering-ignore-case", "type": { "text": "boolean" }, "fieldName": "filteringIgnoreCase", "description": "Sets/gets whether the column filtering should be case sensitive. Default value is `true`." }, { "name": "sorting-ignore-case", "type": { "text": "boolean" }, "fieldName": "sortingIgnoreCase", "description": "Sets/gets whether the column sorting should be case sensitive. Default value is `true`." }, { "name": "searchable", "type": { "text": "boolean" }, "fieldName": "searchable", "description": "Sets/gets whether the column is `searchable`. Default value is `true`." }, { "name": "data-type", "type": { "text": "GridColumnDataType" }, "fieldName": "dataType", "description": "Sets/gets the data type of the column values. Default value is `string`." }, { "name": "row-end", "type": { "text": "number" }, "fieldName": "rowEnd", "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" }, { "name": "col-end", "type": { "text": "number" }, "fieldName": "colEnd", "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" }, { "name": "row-start", "type": { "text": "number" }, "fieldName": "rowStart", "description": "Row index from which the field is starting." }, { "name": "col-start", "type": { "text": "number" }, "fieldName": "colStart", "description": "Column index from which the field is starting." }, { "name": "additional-template-context", "type": { "text": "any" }, "fieldName": "additionalTemplateContext", "description": "Sets/gets custom properties provided in additional template context." }, { "name": "min-width", "type": { "text": "string" }, "fieldName": "minWidth", "description": "Sets/gets the minimum `width` of the column. Default value is `88`;" }, { "name": "pinning-position", "type": { "text": "ColumnPinningPosition" }, "fieldName": "pinningPosition", "description": "Gets the pinning position of the column." }, { "name": "pinned", "type": { "text": "boolean" }, "fieldName": "pinned", "description": "Gets whether the column is `pinned`." }, { "name": "summaries", "type": { "text": "any" }, "fieldName": "summaries", "description": "Gets the column `summaries`." }, { "name": "disabled-summaries", "type": { "text": "string[]" }, "fieldName": "disabledSummaries", "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." }, { "name": "filters", "type": { "text": "IgcFilteringOperand" }, "fieldName": "filters", "description": "Gets the column `filters`." }, { "name": "sort-strategy", "type": { "text": "IgcSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets the column `sortStrategy`." }, { "name": "visible-when-collapsed", "type": { "text": "boolean" }, "fieldName": "visibleWhenCollapsed", "description": "Indicates whether the column will be visible when its parent is collapsed." }, { "name": "pipe-args", "type": { "text": "IgcColumnPipeArgs" }, "fieldName": "pipeArgs" }, { "name": "editor-options", "type": { "text": "IgcColumnEditorOptions" }, "fieldName": "editorOptions", "description": "Pass optional properties for the default column editors." }, { "name": "parent", "type": { "text": "IgcColumnComponent" }, "fieldName": "parent", "description": "Sets/gets the parent column." } ], "events": [ { "name": "hiddenChange", "description": "Emitted when the column is hidden or shown.", "type": { "text": "CustomEvent" } }, { "name": "expandedChange", "description": "Emitted when the column expanded or collapsed.", "type": { "text": "CustomEvent" } }, { "name": "widthChange", "description": "Emitted when the column width changes.", "type": { "text": "CustomEvent" } }, { "name": "pinnedChange", "description": "Emitted when the column is pinned/unpinned.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-column-group", "customElement": true }, { "kind": "class", "name": "IgcColumnComponent", "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.", "members": [ { "kind": "field", "privacy": "public", "name": "field", "description": "Sets/gets the `field` value.", "attribute": "field", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "merge", "description": "Sets/gets whether to merge cells in this column.", "attribute": "merge", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "header", "description": "Sets/gets the `header` value.", "attribute": "header", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "title", "description": "Sets/gets the `title` value.", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "sortable", "description": "Sets/gets whether the column is sortable. Default value is `false`.", "attribute": "sortable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selectable", "description": "Returns if the column is selectable.", "attribute": "selectable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "groupable", "description": "Sets/gets whether the column is groupable. Default value is `false`.", "attribute": "groupable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "editable", "description": "Gets whether the column is editable. Default value is `false`.", "attribute": "editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterable", "description": "Sets/gets whether the column is filterable. Default value is `true`.", "attribute": "filterable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "resizable", "description": "Sets/gets whether the column is resizable. Default value is `false`.", "attribute": "resizable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autosizeHeader", "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`.", "attribute": "autosize-header", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hasSummary", "description": "Gets a value indicating whether the summary for the column is enabled.", "attribute": "has-summary", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hidden", "description": "Gets whether the column is hidden.", "attribute": "hidden", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selected", "description": "Returns if the column is selected.", "attribute": "selected", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "disableHiding", "description": "Gets whether the hiding is disabled.", "attribute": "disable-hiding", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "disablePinning", "description": "Gets whether the pinning is disabled.", "attribute": "disable-pinning", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets the `width` of the column.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "maxWidth", "description": "Sets/gets the maximum `width` of the column.", "attribute": "max-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerClasses", "description": "Sets/gets the class selector of the column header.", "attribute": "header-classes", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerStyles", "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.", "attribute": "header-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "headerGroupClasses", "description": "Sets/gets the class selector of the column group header.", "attribute": "header-group-classes", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerGroupStyles", "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.", "attribute": "header-group-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "cellClasses", "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:", "attribute": "cell-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "cellStyles", "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.", "attribute": "cell-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "formatter", "description": "Applies display format to cell values in the column. Does not modify the underlying data.", "attribute": "formatter", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "summaryFormatter", "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.", "attribute": "summary-formatter", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteringIgnoreCase", "description": "Sets/gets whether the column filtering should be case sensitive. Default value is `true`.", "attribute": "filtering-ignore-case", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "sortingIgnoreCase", "description": "Sets/gets whether the column sorting should be case sensitive. Default value is `true`.", "attribute": "sorting-ignore-case", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "searchable", "description": "Sets/gets whether the column is `searchable`. Default value is `true`.", "attribute": "searchable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "dataType", "description": "Sets/gets the data type of the column values. Default value is `string`.", "attribute": "data-type", "type": { "text": "GridColumnDataType" } }, { "kind": "field", "privacy": "public", "name": "rowEnd", "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", "attribute": "row-end", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "colEnd", "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", "attribute": "col-end", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "rowStart", "description": "Row index from which the field is starting.", "attribute": "row-start", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "colStart", "description": "Column index from which the field is starting.", "attribute": "col-start", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "additionalTemplateContext", "description": "Sets/gets custom properties provided in additional template context.", "attribute": "additional-template-context", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "minWidth", "description": "Sets/gets the minimum `width` of the column. Default value is `88`;", "attribute": "min-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "index", "description": "Gets the column index.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinningPosition", "description": "Gets the pinning position of the column.", "attribute": "pinning-position", "type": { "text": "ColumnPinningPosition" } }, { "kind": "field", "privacy": "public", "name": "pinned", "description": "Gets whether the column is `pinned`.", "attribute": "pinned", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "summaries", "description": "Gets the column `summaries`.", "attribute": "summaries", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "disabledSummaries", "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.", "attribute": "disabled-summaries", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "filters", "description": "Gets the column `filters`.", "attribute": "filters", "type": { "text": "IgcFilteringOperand" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets the column `sortStrategy`.", "attribute": "sort-strategy", "type": { "text": "IgcSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "summaryTemplate", "description": "Returns a reference to the `summaryTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "bodyTemplate", "description": "Returns a reference to the `bodyTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerTemplate", "description": "Returns a reference to the header template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "inlineEditorTemplate", "description": "Returns a reference to the inline editor template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "errorTemplate", "description": "Returns a reference to the validation error template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "filterCellTemplate", "description": "Returns a reference to the `filterCellTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "visibleIndex", "description": "Gets the column visible index. If the column is not visible, returns `-1`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnGroup", "description": "Returns a boolean indicating if the column is a `ColumnGroup`.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayout", "description": "Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayoutChild", "description": "Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "childColumns", "description": "A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "level", "description": "Returns the level of the column in a column group. Returns `0` if the column doesn't have a `parent`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "visibleWhenCollapsed", "description": "Indicates whether the column will be visible when its parent is collapsed.", "attribute": "visible-when-collapsed", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "pipeArgs", "attribute": "pipe-args", "type": { "text": "IgcColumnPipeArgs" } }, { "kind": "field", "privacy": "public", "name": "editorOptions", "description": "Pass optional properties for the default column editors.", "attribute": "editor-options", "type": { "text": "IgcColumnEditorOptions" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Returns the filteringExpressionsTree of the column.", "readonly": true, "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "parent", "description": "Sets/gets the parent column.", "attribute": "parent", "type": { "text": "IgcColumnComponent" } }, { "kind": "field", "privacy": "public", "name": "topLevelParent", "description": "Returns a reference to the top level parent column.", "readonly": true, "type": { "text": "IgcColumnComponent" } }, { "kind": "method", "privacy": "public", "name": "pin", "description": "Pins the column in the specified position at the provided index in that pinned area. Defaults to index `0` if not provided, or to the initial index in the pinned area. Returns `true` if the column is successfully pinned. Returns `false` if the column cannot be pinned. Column cannot be pinned if: - Is already pinned - index argument is out of range", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpin", "description": "Unpins the column and place it at the provided index in the unpinned area. Defaults to index `0` if not provided, or to the initial index in the unpinned area. Returns `true` if the column is successfully unpinned. Returns `false` if the column cannot be unpinned. Column cannot be unpinned if: - Is already unpinned - index argument is out of range", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "move", "description": "Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "autosize", "description": "Autosize the column to the longest currently visible cell value, including the header cell.", "parameters": [ { "name": "byHeaderOnly", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "field", "type": { "text": "string" }, "fieldName": "field", "description": "Sets/gets the `field` value." }, { "name": "merge", "type": { "text": "boolean" }, "fieldName": "merge", "description": "Sets/gets whether to merge cells in this column." }, { "name": "header", "type": { "text": "string" }, "fieldName": "header", "description": "Sets/gets the `header` value." }, { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Sets/gets the `title` value." }, { "name": "sortable", "type": { "text": "boolean" }, "fieldName": "sortable", "description": "Sets/gets whether the column is sortable. Default value is `false`." }, { "name": "selectable", "type": { "text": "boolean" }, "fieldName": "selectable", "description": "Returns if the column is selectable." }, { "name": "groupable", "type": { "text": "boolean" }, "fieldName": "groupable", "description": "Sets/gets whether the column is groupable. Default value is `false`." }, { "name": "editable", "type": { "text": "boolean" }, "fieldName": "editable", "description": "Gets whether the column is editable. Default value is `false`." }, { "name": "filterable", "type": { "text": "boolean" }, "fieldName": "filterable", "description": "Sets/gets whether the column is filterable. Default value is `true`." }, { "name": "resizable", "type": { "text": "boolean" }, "fieldName": "resizable", "description": "Sets/gets whether the column is resizable. Default value is `false`." }, { "name": "autosize-header", "type": { "text": "boolean" }, "fieldName": "autosizeHeader", "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`." }, { "name": "has-summary", "type": { "text": "boolean" }, "fieldName": "hasSummary", "description": "Gets a value indicating whether the summary for the column is enabled." }, { "name": "hidden", "type": { "text": "boolean" }, "fieldName": "hidden", "description": "Gets whether the column is hidden." }, { "name": "selected", "type": { "text": "boolean" }, "fieldName": "selected", "description": "Returns if the column is selected." }, { "name": "disable-hiding", "type": { "text": "boolean" }, "fieldName": "disableHiding", "description": "Gets whether the hiding is disabled." }, { "name": "disable-pinning", "type": { "text": "boolean" }, "fieldName": "disablePinning", "description": "Gets whether the pinning is disabled." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets the `width` of the column." }, { "name": "max-width", "type": { "text": "string" }, "fieldName": "maxWidth", "description": "Sets/gets the maximum `width` of the column." }, { "name": "header-classes", "type": { "text": "string" }, "fieldName": "headerClasses", "description": "Sets/gets the class selector of the column header." }, { "name": "header-styles", "type": { "text": "any" }, "fieldName": "headerStyles", "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." }, { "name": "header-group-classes", "type": { "text": "string" }, "fieldName": "headerGroupClasses", "description": "Sets/gets the class selector of the column group header." }, { "name": "header-group-styles", "type": { "text": "any" }, "fieldName": "headerGroupStyles", "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." }, { "name": "cell-classes", "type": { "text": "any" }, "fieldName": "cellClasses", "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:" }, { "name": "cell-styles", "type": { "text": "any" }, "fieldName": "cellStyles", "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." }, { "name": "formatter", "type": { "text": "any" }, "fieldName": "formatter", "description": "Applies display format to cell values in the column. Does not modify the underlying data." }, { "name": "summary-formatter", "type": { "text": "any" }, "fieldName": "summaryFormatter", "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." }, { "name": "filtering-ignore-case", "type": { "text": "boolean" }, "fieldName": "filteringIgnoreCase", "description": "Sets/gets whether the column filtering should be case sensitive. Default value is `true`." }, { "name": "sorting-ignore-case", "type": { "text": "boolean" }, "fieldName": "sortingIgnoreCase", "description": "Sets/gets whether the column sorting should be case sensitive. Default value is `true`." }, { "name": "searchable", "type": { "text": "boolean" }, "fieldName": "searchable", "description": "Sets/gets whether the column is `searchable`. Default value is `true`." }, { "name": "data-type", "type": { "text": "GridColumnDataType" }, "fieldName": "dataType", "description": "Sets/gets the data type of the column values. Default value is `string`." }, { "name": "row-end", "type": { "text": "number" }, "fieldName": "rowEnd", "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" }, { "name": "col-end", "type": { "text": "number" }, "fieldName": "colEnd", "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" }, { "name": "row-start", "type": { "text": "number" }, "fieldName": "rowStart", "description": "Row index from which the field is starting." }, { "name": "col-start", "type": { "text": "number" }, "fieldName": "colStart", "description": "Column index from which the field is starting." }, { "name": "additional-template-context", "type": { "text": "any" }, "fieldName": "additionalTemplateContext", "description": "Sets/gets custom properties provided in additional template context." }, { "name": "min-width", "type": { "text": "string" }, "fieldName": "minWidth", "description": "Sets/gets the minimum `width` of the column. Default value is `88`;" }, { "name": "pinning-position", "type": { "text": "ColumnPinningPosition" }, "fieldName": "pinningPosition", "description": "Gets the pinning position of the column." }, { "name": "pinned", "type": { "text": "boolean" }, "fieldName": "pinned", "description": "Gets whether the column is `pinned`." }, { "name": "summaries", "type": { "text": "any" }, "fieldName": "summaries", "description": "Gets the column `summaries`." }, { "name": "disabled-summaries", "type": { "text": "string[]" }, "fieldName": "disabledSummaries", "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." }, { "name": "filters", "type": { "text": "IgcFilteringOperand" }, "fieldName": "filters", "description": "Gets the column `filters`." }, { "name": "sort-strategy", "type": { "text": "IgcSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets the column `sortStrategy`." }, { "name": "visible-when-collapsed", "type": { "text": "boolean" }, "fieldName": "visibleWhenCollapsed", "description": "Indicates whether the column will be visible when its parent is collapsed." }, { "name": "pipe-args", "type": { "text": "IgcColumnPipeArgs" }, "fieldName": "pipeArgs" }, { "name": "editor-options", "type": { "text": "IgcColumnEditorOptions" }, "fieldName": "editorOptions", "description": "Pass optional properties for the default column editors." }, { "name": "parent", "type": { "text": "IgcColumnComponent" }, "fieldName": "parent", "description": "Sets/gets the parent column." } ], "events": [ { "name": "hiddenChange", "description": "Emitted when the column is hidden or shown.", "type": { "text": "CustomEvent" } }, { "name": "expandedChange", "description": "Emitted when the column expanded or collapsed.", "type": { "text": "CustomEvent" } }, { "name": "widthChange", "description": "Emitted when the column width changes.", "type": { "text": "CustomEvent" } }, { "name": "pinnedChange", "description": "Emitted when the column is pinned/unpinned.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-column", "customElement": true }, { "kind": "class", "name": "IgcColumnLayoutComponent", "description": "Column layout for declaration of Multi-row Layout", "members": [ { "kind": "field", "privacy": "public", "name": "width", "description": "Gets the width of the column layout.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "visibleIndex", "description": "Gets the column visible index. If the column is not visible, returns `-1`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "children", "deprecated": "Use the `childColumns` property instead.", "attribute": "children", "type": { "text": "HTMLCollection" } }, { "kind": "field", "privacy": "public", "name": "collapsible", "description": "Set if the column group is collapsible. Default value is `false`", "attribute": "collapsible", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "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`", "attribute": "expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "summaries", "description": "Gets the column group `summaries`.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filters", "description": "Gets the column group `filters`.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "selectable", "description": "Returns if the column group is selectable", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "collapsibleIndicatorTemplate", "description": "Allows you to define a custom template for expand/collapse indicator", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "hidden", "description": "Gets whether the column group is hidden.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selected", "description": "Returns if the column group is selected.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "childColumns", "description": "A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "columnGroup", "description": "Returns a boolean indicating if the column is a `ColumnGroup`.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayout", "description": "Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets the width of the column group.", "readonly": true, "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "field", "description": "Sets/gets the `field` value.", "attribute": "field", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "merge", "description": "Sets/gets whether to merge cells in this column.", "attribute": "merge", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "header", "description": "Sets/gets the `header` value.", "attribute": "header", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "title", "description": "Sets/gets the `title` value.", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "sortable", "description": "Sets/gets whether the column is sortable. Default value is `false`.", "attribute": "sortable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selectable", "description": "Returns if the column is selectable.", "attribute": "selectable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "groupable", "description": "Sets/gets whether the column is groupable. Default value is `false`.", "attribute": "groupable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "editable", "description": "Gets whether the column is editable. Default value is `false`.", "attribute": "editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterable", "description": "Sets/gets whether the column is filterable. Default value is `true`.", "attribute": "filterable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "resizable", "description": "Sets/gets whether the column is resizable. Default value is `false`.", "attribute": "resizable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autosizeHeader", "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`.", "attribute": "autosize-header", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hasSummary", "description": "Gets a value indicating whether the summary for the column is enabled.", "attribute": "has-summary", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hidden", "description": "Gets whether the column is hidden.", "attribute": "hidden", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selected", "description": "Returns if the column is selected.", "attribute": "selected", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "disableHiding", "description": "Gets whether the hiding is disabled.", "attribute": "disable-hiding", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "disablePinning", "description": "Gets whether the pinning is disabled.", "attribute": "disable-pinning", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets the `width` of the column.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "maxWidth", "description": "Sets/gets the maximum `width` of the column.", "attribute": "max-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerClasses", "description": "Sets/gets the class selector of the column header.", "attribute": "header-classes", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerStyles", "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.", "attribute": "header-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "headerGroupClasses", "description": "Sets/gets the class selector of the column group header.", "attribute": "header-group-classes", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "headerGroupStyles", "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.", "attribute": "header-group-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "cellClasses", "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:", "attribute": "cell-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "cellStyles", "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.", "attribute": "cell-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "formatter", "description": "Applies display format to cell values in the column. Does not modify the underlying data.", "attribute": "formatter", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "summaryFormatter", "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.", "attribute": "summary-formatter", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteringIgnoreCase", "description": "Sets/gets whether the column filtering should be case sensitive. Default value is `true`.", "attribute": "filtering-ignore-case", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "sortingIgnoreCase", "description": "Sets/gets whether the column sorting should be case sensitive. Default value is `true`.", "attribute": "sorting-ignore-case", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "searchable", "description": "Sets/gets whether the column is `searchable`. Default value is `true`.", "attribute": "searchable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "dataType", "description": "Sets/gets the data type of the column values. Default value is `string`.", "attribute": "data-type", "type": { "text": "GridColumnDataType" } }, { "kind": "field", "privacy": "public", "name": "rowEnd", "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", "attribute": "row-end", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "colEnd", "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", "attribute": "col-end", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "rowStart", "description": "Row index from which the field is starting.", "attribute": "row-start", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "colStart", "description": "Column index from which the field is starting.", "attribute": "col-start", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "additionalTemplateContext", "description": "Sets/gets custom properties provided in additional template context.", "attribute": "additional-template-context", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "minWidth", "description": "Sets/gets the minimum `width` of the column. Default value is `88`;", "attribute": "min-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "index", "description": "Gets the column index.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinningPosition", "description": "Gets the pinning position of the column.", "attribute": "pinning-position", "type": { "text": "ColumnPinningPosition" } }, { "kind": "field", "privacy": "public", "name": "pinned", "description": "Gets whether the column is `pinned`.", "attribute": "pinned", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "summaries", "description": "Gets the column `summaries`.", "attribute": "summaries", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "disabledSummaries", "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.", "attribute": "disabled-summaries", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "filters", "description": "Gets the column `filters`.", "attribute": "filters", "type": { "text": "IgcFilteringOperand" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets the column `sortStrategy`.", "attribute": "sort-strategy", "type": { "text": "IgcSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "summaryTemplate", "description": "Returns a reference to the `summaryTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "bodyTemplate", "description": "Returns a reference to the `bodyTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerTemplate", "description": "Returns a reference to the header template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "inlineEditorTemplate", "description": "Returns a reference to the inline editor template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "errorTemplate", "description": "Returns a reference to the validation error template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "filterCellTemplate", "description": "Returns a reference to the `filterCellTemplate`.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "visibleIndex", "description": "Gets the column visible index. If the column is not visible, returns `-1`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnGroup", "description": "Returns a boolean indicating if the column is a `ColumnGroup`.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayout", "description": "Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "columnLayoutChild", "description": "Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "childColumns", "description": "A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "level", "description": "Returns the level of the column in a column group. Returns `0` if the column doesn't have a `parent`.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "visibleWhenCollapsed", "description": "Indicates whether the column will be visible when its parent is collapsed.", "attribute": "visible-when-collapsed", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "pipeArgs", "attribute": "pipe-args", "type": { "text": "IgcColumnPipeArgs" } }, { "kind": "field", "privacy": "public", "name": "editorOptions", "description": "Pass optional properties for the default column editors.", "attribute": "editor-options", "type": { "text": "IgcColumnEditorOptions" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Returns the filteringExpressionsTree of the column.", "readonly": true, "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "parent", "description": "Sets/gets the parent column.", "attribute": "parent", "type": { "text": "IgcColumnComponent" } }, { "kind": "field", "privacy": "public", "name": "topLevelParent", "description": "Returns a reference to the top level parent column.", "readonly": true, "type": { "text": "IgcColumnComponent" } }, { "kind": "method", "privacy": "public", "name": "pin", "description": "Pins the column in the specified position at the provided index in that pinned area. Defaults to index `0` if not provided, or to the initial index in the pinned area. Returns `true` if the column is successfully pinned. Returns `false` if the column cannot be pinned. Column cannot be pinned if: - Is already pinned - index argument is out of range", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpin", "description": "Unpins the column and place it at the provided index in the unpinned area. Defaults to index `0` if not provided, or to the initial index in the unpinned area. Returns `true` if the column is successfully unpinned. Returns `false` if the column cannot be unpinned. Column cannot be unpinned if: - Is already unpinned - index argument is out of range", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "move", "description": "Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "autosize", "description": "Autosize the column to the longest currently visible cell value, including the header cell.", "parameters": [ { "name": "byHeaderOnly", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "children", "type": { "text": "HTMLCollection" }, "fieldName": "children", "deprecated": "Use the `childColumns` property instead." }, { "name": "collapsible", "type": { "text": "boolean" }, "fieldName": "collapsible", "description": "Set if the column group is collapsible. Default value is `false`" }, { "name": "expanded", "type": { "text": "boolean" }, "fieldName": "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`" }, { "name": "field", "type": { "text": "string" }, "fieldName": "field", "description": "Sets/gets the `field` value." }, { "name": "merge", "type": { "text": "boolean" }, "fieldName": "merge", "description": "Sets/gets whether to merge cells in this column." }, { "name": "header", "type": { "text": "string" }, "fieldName": "header", "description": "Sets/gets the `header` value." }, { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Sets/gets the `title` value." }, { "name": "sortable", "type": { "text": "boolean" }, "fieldName": "sortable", "description": "Sets/gets whether the column is sortable. Default value is `false`." }, { "name": "selectable", "type": { "text": "boolean" }, "fieldName": "selectable", "description": "Returns if the column is selectable." }, { "name": "groupable", "type": { "text": "boolean" }, "fieldName": "groupable", "description": "Sets/gets whether the column is groupable. Default value is `false`." }, { "name": "editable", "type": { "text": "boolean" }, "fieldName": "editable", "description": "Gets whether the column is editable. Default value is `false`." }, { "name": "filterable", "type": { "text": "boolean" }, "fieldName": "filterable", "description": "Sets/gets whether the column is filterable. Default value is `true`." }, { "name": "resizable", "type": { "text": "boolean" }, "fieldName": "resizable", "description": "Sets/gets whether the column is resizable. Default value is `false`." }, { "name": "autosize-header", "type": { "text": "boolean" }, "fieldName": "autosizeHeader", "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`." }, { "name": "has-summary", "type": { "text": "boolean" }, "fieldName": "hasSummary", "description": "Gets a value indicating whether the summary for the column is enabled." }, { "name": "hidden", "type": { "text": "boolean" }, "fieldName": "hidden", "description": "Gets whether the column is hidden." }, { "name": "selected", "type": { "text": "boolean" }, "fieldName": "selected", "description": "Returns if the column is selected." }, { "name": "disable-hiding", "type": { "text": "boolean" }, "fieldName": "disableHiding", "description": "Gets whether the hiding is disabled." }, { "name": "disable-pinning", "type": { "text": "boolean" }, "fieldName": "disablePinning", "description": "Gets whether the pinning is disabled." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets the `width` of the column." }, { "name": "max-width", "type": { "text": "string" }, "fieldName": "maxWidth", "description": "Sets/gets the maximum `width` of the column." }, { "name": "header-classes", "type": { "text": "string" }, "fieldName": "headerClasses", "description": "Sets/gets the class selector of the column header." }, { "name": "header-styles", "type": { "text": "any" }, "fieldName": "headerStyles", "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." }, { "name": "header-group-classes", "type": { "text": "string" }, "fieldName": "headerGroupClasses", "description": "Sets/gets the class selector of the column group header." }, { "name": "header-group-styles", "type": { "text": "any" }, "fieldName": "headerGroupStyles", "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." }, { "name": "cell-classes", "type": { "text": "any" }, "fieldName": "cellClasses", "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:" }, { "name": "cell-styles", "type": { "text": "any" }, "fieldName": "cellStyles", "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." }, { "name": "formatter", "type": { "text": "any" }, "fieldName": "formatter", "description": "Applies display format to cell values in the column. Does not modify the underlying data." }, { "name": "summary-formatter", "type": { "text": "any" }, "fieldName": "summaryFormatter", "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." }, { "name": "filtering-ignore-case", "type": { "text": "boolean" }, "fieldName": "filteringIgnoreCase", "description": "Sets/gets whether the column filtering should be case sensitive. Default value is `true`." }, { "name": "sorting-ignore-case", "type": { "text": "boolean" }, "fieldName": "sortingIgnoreCase", "description": "Sets/gets whether the column sorting should be case sensitive. Default value is `true`." }, { "name": "searchable", "type": { "text": "boolean" }, "fieldName": "searchable", "description": "Sets/gets whether the column is `searchable`. Default value is `true`." }, { "name": "data-type", "type": { "text": "GridColumnDataType" }, "fieldName": "dataType", "description": "Sets/gets the data type of the column values. Default value is `string`." }, { "name": "row-end", "type": { "text": "number" }, "fieldName": "rowEnd", "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" }, { "name": "col-end", "type": { "text": "number" }, "fieldName": "colEnd", "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" }, { "name": "row-start", "type": { "text": "number" }, "fieldName": "rowStart", "description": "Row index from which the field is starting." }, { "name": "col-start", "type": { "text": "number" }, "fieldName": "colStart", "description": "Column index from which the field is starting." }, { "name": "additional-template-context", "type": { "text": "any" }, "fieldName": "additionalTemplateContext", "description": "Sets/gets custom properties provided in additional template context." }, { "name": "min-width", "type": { "text": "string" }, "fieldName": "minWidth", "description": "Sets/gets the minimum `width` of the column. Default value is `88`;" }, { "name": "pinning-position", "type": { "text": "ColumnPinningPosition" }, "fieldName": "pinningPosition", "description": "Gets the pinning position of the column." }, { "name": "pinned", "type": { "text": "boolean" }, "fieldName": "pinned", "description": "Gets whether the column is `pinned`." }, { "name": "summaries", "type": { "text": "any" }, "fieldName": "summaries", "description": "Gets the column `summaries`." }, { "name": "disabled-summaries", "type": { "text": "string[]" }, "fieldName": "disabledSummaries", "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." }, { "name": "filters", "type": { "text": "IgcFilteringOperand" }, "fieldName": "filters", "description": "Gets the column `filters`." }, { "name": "sort-strategy", "type": { "text": "IgcSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets the column `sortStrategy`." }, { "name": "visible-when-collapsed", "type": { "text": "boolean" }, "fieldName": "visibleWhenCollapsed", "description": "Indicates whether the column will be visible when its parent is collapsed." }, { "name": "pipe-args", "type": { "text": "IgcColumnPipeArgs" }, "fieldName": "pipeArgs" }, { "name": "editor-options", "type": { "text": "IgcColumnEditorOptions" }, "fieldName": "editorOptions", "description": "Pass optional properties for the default column editors." }, { "name": "parent", "type": { "text": "IgcColumnComponent" }, "fieldName": "parent", "description": "Sets/gets the parent column." } ], "events": [ { "name": "hiddenChange", "description": "Emitted when the column is hidden or shown.", "type": { "text": "CustomEvent" } }, { "name": "expandedChange", "description": "Emitted when the column expanded or collapsed.", "type": { "text": "CustomEvent" } }, { "name": "widthChange", "description": "Emitted when the column width changes.", "type": { "text": "CustomEvent" } }, { "name": "pinnedChange", "description": "Emitted when the column is pinned/unpinned.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-column-layout", "customElement": true }, { "kind": "class", "name": "IgcGridEditingActionsComponent", "description": "Grid Editing Actions for the Action Strip", "members": [ { "kind": "field", "privacy": "public", "name": "addRow", "description": "An input to enable/disable action strip row adding button", "attribute": "add-row", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "editRow", "description": "An input to enable/disable action strip row editing button", "attribute": "edit-row", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "deleteRow", "description": "An input to enable/disable action strip row deleting button", "attribute": "delete-row", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hasChildren", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "addChild", "description": "An input to enable/disable action strip child row adding button", "attribute": "add-child", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "asMenuItems", "description": "Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label.", "attribute": "as-menu-items", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "startEdit", "description": "Enter row or cell edit mode depending the grid rowEditable option", "parameters": [ { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "add-row", "type": { "text": "boolean" }, "fieldName": "addRow", "description": "An input to enable/disable action strip row adding button" }, { "name": "edit-row", "type": { "text": "boolean" }, "fieldName": "editRow", "description": "An input to enable/disable action strip row editing button" }, { "name": "delete-row", "type": { "text": "boolean" }, "fieldName": "deleteRow", "description": "An input to enable/disable action strip row deleting button" }, { "name": "add-child", "type": { "text": "boolean" }, "fieldName": "addChild", "description": "An input to enable/disable action strip child row adding button" }, { "name": "as-menu-items", "type": { "text": "boolean" }, "fieldName": "asMenuItems", "description": "Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label." } ], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-editing-actions", "customElement": true }, { "kind": "class", "name": "IgcGridPinningActionsComponent", "description": "Grid Pinning Actions for the Action Strip", "members": [ { "kind": "field", "privacy": "public", "name": "asMenuItems", "description": "Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label.", "attribute": "as-menu-items", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "pin", "description": "Pin the row according to the context.", "parameters": [ { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "unpin", "description": "Unpin the row according to the context.", "parameters": [ { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "scrollToRow", "parameters": [ { "name": "evt", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "as-menu-items", "type": { "text": "boolean" }, "fieldName": "asMenuItems", "description": "Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label." } ], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-pinning-actions", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarTitleComponent", "description": "Provides a way to template the title portion of the toolbar in the grid.", "members": [], "attributes": [], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar-title", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarActionsComponent", "description": "Provides a way to template the action portion of the toolbar in the grid.", "members": [], "attributes": [], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar-actions", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarAdvancedFilteringComponent", "description": "Provides a pre-configured button to open the advanced filtering dialog of the grid.", "members": [ { "kind": "field", "privacy": "public", "name": "overlaySettings", "attribute": "overlay-settings", "type": { "text": "IgcOverlaySettings" } } ], "attributes": [ { "name": "overlay-settings", "type": { "text": "IgcOverlaySettings" }, "fieldName": "overlaySettings" } ], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar-advanced-filtering", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarExporterComponent", "description": "Provides a pre-configured exporter component for the grid.", "members": [ { "kind": "field", "privacy": "public", "name": "exportCSV", "description": "Show entry for CSV export.", "attribute": "export-csv", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "exportExcel", "description": "Show entry for Excel export.", "attribute": "export-excel", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "exportPDF", "description": "Show entry for PDF export.", "attribute": "export-pdf", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filename", "description": "The name for the exported file.", "attribute": "filename", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "columnListHeight", "description": "Sets the height of the column list in the dropdown.", "attribute": "column-list-height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "title", "description": "Title text for the column action component", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "prompt", "description": "The placeholder text for the search input.", "attribute": "prompt", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "overlaySettings", "description": "Sets overlay settings", "attribute": "overlay-settings", "type": { "text": "IgcOverlaySettings" } }, { "kind": "method", "privacy": "public", "name": "export", "description": "Export the grid's data", "parameters": [ { "name": "type", "type": { "text": "GridToolbarExporterType" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "export-csv", "type": { "text": "boolean" }, "fieldName": "exportCSV", "description": "Show entry for CSV export." }, { "name": "export-excel", "type": { "text": "boolean" }, "fieldName": "exportExcel", "description": "Show entry for Excel export." }, { "name": "export-pdf", "type": { "text": "boolean" }, "fieldName": "exportPDF", "description": "Show entry for PDF export." }, { "name": "filename", "type": { "text": "string" }, "fieldName": "filename", "description": "The name for the exported file." }, { "name": "column-list-height", "type": { "text": "string" }, "fieldName": "columnListHeight", "description": "Sets the height of the column list in the dropdown." }, { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Title text for the column action component" }, { "name": "prompt", "type": { "text": "string" }, "fieldName": "prompt", "description": "The placeholder text for the search input." }, { "name": "overlay-settings", "type": { "text": "IgcOverlaySettings" }, "fieldName": "overlaySettings", "description": "Sets overlay settings" } ], "events": [ { "name": "exportStarted", "description": "Emitted when starting an export operation. Re-emitted additionally by the grid itself.", "type": { "text": "CustomEvent" } }, { "name": "exportEnded", "description": "Emitted on successful ending of an export operation.", "type": { "text": "CustomEvent" } }, { "name": "opening", "description": "Emits an event before the toggle container is opened.", "type": { "text": "CustomEvent" } }, { "name": "opened", "description": "Emits an event after the toggle container is opened.", "type": { "text": "CustomEvent" } }, { "name": "closing", "description": "Emits an event before the toggle container is closed.", "type": { "text": "CustomEvent" } }, { "name": "closed", "description": "Emits an event after the toggle container is closed.", "type": { "text": "CustomEvent" } }, { "name": "columnToggle", "description": "Emits when after a column's checked state is changed", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar-exporter", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarHidingComponent", "description": "Provides a pre-configured column hiding component for the grid.", "members": [ { "kind": "field", "privacy": "public", "name": "columnListHeight", "description": "Sets the height of the column list in the dropdown.", "attribute": "column-list-height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "title", "description": "Title text for the column action component", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "prompt", "description": "The placeholder text for the search input.", "attribute": "prompt", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "overlaySettings", "description": "Sets overlay settings", "attribute": "overlay-settings", "type": { "text": "IgcOverlaySettings" } } ], "attributes": [ { "name": "column-list-height", "type": { "text": "string" }, "fieldName": "columnListHeight", "description": "Sets the height of the column list in the dropdown." }, { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Title text for the column action component" }, { "name": "prompt", "type": { "text": "string" }, "fieldName": "prompt", "description": "The placeholder text for the search input." }, { "name": "overlay-settings", "type": { "text": "IgcOverlaySettings" }, "fieldName": "overlaySettings", "description": "Sets overlay settings" } ], "events": [ { "name": "opening", "description": "Emits an event before the toggle container is opened.", "type": { "text": "CustomEvent" } }, { "name": "opened", "description": "Emits an event after the toggle container is opened.", "type": { "text": "CustomEvent" } }, { "name": "closing", "description": "Emits an event before the toggle container is closed.", "type": { "text": "CustomEvent" } }, { "name": "closed", "description": "Emits an event after the toggle container is closed.", "type": { "text": "CustomEvent" } }, { "name": "columnToggle", "description": "Emits when after a column's checked state is changed", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar-hiding", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarPinningComponent", "description": "Provides a pre-configured column pinning component for the grid.", "members": [ { "kind": "field", "privacy": "public", "name": "columnListHeight", "description": "Sets the height of the column list in the dropdown.", "attribute": "column-list-height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "title", "description": "Title text for the column action component", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "prompt", "description": "The placeholder text for the search input.", "attribute": "prompt", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "overlaySettings", "description": "Sets overlay settings", "attribute": "overlay-settings", "type": { "text": "IgcOverlaySettings" } } ], "attributes": [ { "name": "column-list-height", "type": { "text": "string" }, "fieldName": "columnListHeight", "description": "Sets the height of the column list in the dropdown." }, { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Title text for the column action component" }, { "name": "prompt", "type": { "text": "string" }, "fieldName": "prompt", "description": "The placeholder text for the search input." }, { "name": "overlay-settings", "type": { "text": "IgcOverlaySettings" }, "fieldName": "overlaySettings", "description": "Sets overlay settings" } ], "events": [ { "name": "opening", "description": "Emits an event before the toggle container is opened.", "type": { "text": "CustomEvent" } }, { "name": "opened", "description": "Emits an event after the toggle container is opened.", "type": { "text": "CustomEvent" } }, { "name": "closing", "description": "Emits an event before the toggle container is closed.", "type": { "text": "CustomEvent" } }, { "name": "closed", "description": "Emits an event after the toggle container is closed.", "type": { "text": "CustomEvent" } }, { "name": "columnToggle", "description": "Emits when after a column's checked state is changed", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar-pinning", "customElement": true }, { "kind": "class", "name": "IgcGridComponent", "description": "Grid provides a way to present and manipulate tabular data.", "members": [ { "kind": "field", "privacy": "public", "name": "groupsExpanded", "description": "Gets/Sets whether created groups are rendered expanded or collapsed.", "attribute": "groups-expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "dropAreaTemplate", "description": "Gets/Sets the template that will be rendered as a GroupBy drop area.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "detailTemplate", "description": "Returns a reference to the master-detail template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "id", "description": "Gets/Sets the value of the `id` attribute.", "attribute": "id", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "groupsRecords", "description": "Gets the hierarchical representation of the group by records.", "readonly": true, "type": { "text": "IgcGroupByRecord[]" } }, { "kind": "field", "privacy": "public", "name": "data", "description": "Gets/Sets the array of data that populates the component.", "attribute": "data", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "totalItemCount", "description": "Gets/Sets the total number of records in the data source.", "attribute": "total-item-count", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "groupingExpressions", "description": "Gets/Sets the group by state.", "attribute": "grouping-expressions", "type": { "text": "IgcGroupingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "groupingExpansionState", "description": "Gets/Sets a list of expansion states for group rows.", "attribute": "grouping-expansion-state", "type": { "text": "IgcGroupByExpandState[]" } }, { "kind": "field", "privacy": "public", "name": "hideGroupedColumns", "description": "Gets/Sets whether the grouped columns should be hidden.", "attribute": "hide-grouped-columns", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "groupStrategy", "description": "Gets/Sets the grouping strategy of the grid.", "attribute": "group-strategy", "type": { "text": "IgcGridGroupingStrategy" } }, { "kind": "field", "privacy": "public", "name": "dropAreaMessage", "description": "Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on.", "attribute": "drop-area-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "groupByRowSelectorTemplate", "description": "Gets the group by row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "groupRowTemplate", "description": "Gets/Sets the template reference for the group row.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "showGroupArea", "description": "Returns whether the `IgxGridComponent` has group area.", "attribute": "show-group-area", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selectedCells", "description": "Returns an array of the selected `IgxGridCell`s.", "readonly": true, "type": { "text": "IgcCellType[]" } }, { "kind": "field", "privacy": "public", "name": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification.", "attribute": "snackbar-display-time", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns.", "attribute": "auto-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection", "attribute": "auto-generate-exclude", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "moving", "description": "Controls whether columns moving is enabled in the grid.", "attribute": "moving", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyGridTemplate", "description": "Gets/Sets a custom template when empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "addRowEmptyTemplate", "description": "Gets/Sets a custom template for adding row UI when grid is empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "loadingGridTemplate", "description": "Gets/Sets a custom template when loading.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height", "attribute": "summary-row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode.", "attribute": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" } }, { "kind": "field", "privacy": "public", "name": "clipboardOptions", "description": "Controls the copy behavior of the grid.", "attribute": "clipboard-options", "type": { "text": "IgcClipboardOptions" } }, { "kind": "field", "privacy": "public", "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:", "attribute": "row-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "row-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "primaryKey", "description": "Gets/Sets the primary key.", "attribute": "primary-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "columnList", "attribute": "column-list", "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "actionStripComponents", "attribute": "action-strip-components", "type": { "text": "IgcActionStripToken[]" } }, { "kind": "field", "privacy": "public", "name": "dragGhostCustomTemplate", "description": "Gets the custom template, if any, used for row drag ghost.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditTextTemplate", "description": "Gets the row edit text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowAddTextTemplate", "description": "Gets the row add text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditActionsTemplate", "description": "Gets the row edit actions template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowExpandedIndicatorTemplate", "description": "Gets the row expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerExpandedIndicatorTemplate", "description": "Gets the header expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "excelStyleHeaderIconTemplate", "description": "Gets the excel style header icon.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortHeaderIconTemplate", "description": "Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "toolbar", "attribute": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" } }, { "kind": "field", "privacy": "public", "name": "paginationComponents", "attribute": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcGridResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`.", "attribute": "filtering-logic", "type": { "text": "FilteringLogic" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Gets/Sets the filtering state.", "attribute": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state.", "attribute": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "locale", "description": "Gets/Sets the locale.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pagingMode", "attribute": "paging-mode", "type": { "text": "GridPagingMode" } }, { "kind": "field", "privacy": "public", "name": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden.", "attribute": "hide-row-selectors", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rowDraggable", "description": "Gets/Sets whether rows can be moved.", "attribute": "row-draggable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid.", "attribute": "validation-trigger", "type": { "text": "GridValidationTrigger" } }, { "kind": "field", "privacy": "public", "name": "rowEditable", "description": "Gets/Sets whether the rows are editable.", "attribute": "row-editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "height", "description": "Gets/Sets the height.", "attribute": "height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets/Sets the width of the grid.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "rowHeight", "description": "Gets/Sets the row height.", "attribute": "row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnWidth", "description": "Gets/Sets the default width of the columns.", "attribute": "column-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records.", "attribute": "empty-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator.", "attribute": "is-loading", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead.", "attribute": "should-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered.", "attribute": "empty-filtered-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pinning", "description": "Gets/Sets the initial pinning configuration.", "attribute": "pinning", "type": { "text": "IgcPinningConfig" } }, { "kind": "field", "privacy": "public", "name": "allowFiltering", "description": "Gets/Sets if the filtering is enabled.", "attribute": "allow-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled.", "attribute": "allow-advanced-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterMode", "description": "Gets/Sets the filter mode.", "attribute": "filter-mode", "type": { "text": "FilterMode" } }, { "kind": "field", "privacy": "public", "name": "summaryPosition", "description": "Gets/Sets the summary position.", "attribute": "summary-position", "type": { "text": "GridSummaryPosition" } }, { "kind": "field", "privacy": "public", "name": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode.", "attribute": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" } }, { "kind": "field", "privacy": "public", "name": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed.", "attribute": "show-summary-on-collapse", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid.", "attribute": "filter-strategy", "type": { "text": "IgcFilteringStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid.", "attribute": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid.", "attribute": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties.", "attribute": "sorting-options", "type": { "text": "IgcSortingOptions" } }, { "kind": "field", "privacy": "public", "name": "selectedRows", "description": "Gets/Sets the current selection state.", "attribute": "selected-rows", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "rowList", "description": "A list of `IgxGridRowComponent`.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "dataRowList", "description": "A list of currently rendered `IgxGridRowComponent`'s.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "headSelectorTemplate", "description": "Gets the header row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowSelectorTemplate", "description": "Gets the row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "dragIndicatorIconTemplate", "description": "The custom template, if any, that should be used when rendering the row drag indicator icon", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortingExpressions", "description": "Gets/Sets the sorting state.", "attribute": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "hiddenColumnsCount", "description": "Gets the number of hidden columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumnsCount", "description": "Gets the number of pinned columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "batch-editing", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "cellSelection", "description": "Gets/Sets cell selection mode.", "attribute": "cell-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "cellMergeMode", "description": "Gets/Sets cell merge mode.", "attribute": "cell-merge-mode", "type": { "text": "GridCellMergeMode" } }, { "kind": "field", "privacy": "public", "name": "rowSelection", "description": "Gets/Sets row selection mode", "attribute": "row-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "columnSelection", "description": "Gets/Sets column selection mode", "attribute": "column-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "lastSearchInfo", "description": "Represents the last search information.", "readonly": true, "type": { "text": "IgcSearchInfo" } }, { "kind": "field", "privacy": "public", "name": "filteredData", "description": "Returns an array of objects containing the filtered data.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteredSortedData", "description": "Returns an array containing the filtered sorted data.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "virtualizationState", "description": "Returns the state of the grid virtualization.", "readonly": true, "type": { "text": "IgcForOfState" } }, { "kind": "field", "privacy": "public", "name": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state].", "attribute": "expansion-states", "type": { "text": "Map" } }, { "kind": "field", "privacy": "public", "name": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to.", "attribute": "outlet", "type": { "text": "IgcOverlayOutletDirective" } }, { "kind": "field", "privacy": "public", "name": "defaultRowHeight", "description": "Gets the default row height.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columns", "description": "Gets an array of `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumns", "description": "Gets an array of the pinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedStartColumns", "description": "Gets an array of the pinned to the left `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedEndColumns", "description": "Gets an array of the pinned to the right `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedRows", "description": "Gets an array of the pinned `IgxRowComponent`s.", "readonly": true, "type": { "text": "IgcGridRowComponent[]" } }, { "kind": "field", "privacy": "public", "name": "unpinnedColumns", "description": "Gets an array of unpinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "visibleColumns", "description": "Returns an array of visible `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "totalRecords", "description": "Returns the total number of records.", "attribute": "total-records", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataView", "description": "Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it", "attribute": "select-row-on-click", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "groupBy", "description": "Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one.", "parameters": [ { "name": "expression", "type": { "text": "IgcGroupingExpression[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearGrouping", "description": "Clears grouping for particular column, array of columns or all columns.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "isExpandedGroup", "description": "Returns if a group is expanded or not.", "parameters": [ { "name": "group", "type": { "text": "IgcGroupByRecord" }, "optional": false } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "toggleGroup", "description": "Toggles the expansion state of a group.", "parameters": [ { "name": "groupRow", "type": { "text": "IgcGroupByRecord" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRowsInGroup", "description": "Select all rows within a group.", "parameters": [ { "name": "groupRow", "type": { "text": "IgcGroupByRecord" }, "optional": false }, { "name": "clearPrevSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectRowsInGroup", "description": "Deselect all rows within a group.", "parameters": [ { "name": "groupRow", "type": { "text": "IgcGroupByRecord" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "fullyExpandGroup", "description": "Expands the specified group and all of its parent groups.", "parameters": [ { "name": "groupRow", "type": { "text": "IgcGroupByRecord" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleAllGroupRows", "description": "Toggles the expansion state of all group rows recursively.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "any[]" } } }, { "kind": "method", "privacy": "public", "name": "getRowByIndex", "description": "Returns the `IgxGridRow` by index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getRowByKey", "description": "Returns `IgxGridRow` object by the specified primary key.", "parameters": [ { "name": "key", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getCellByColumn", "description": "Returns a `CellType` object that matches the conditions.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "columnField", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcCellType" } } }, { "kind": "method", "privacy": "public", "name": "getCellByKey", "description": "Returns a `CellType` object that matches the conditions.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "columnField", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcCellType" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "isRecordPinnedByIndex", "description": "Returns whether the record is pinned or not.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleColumnVisibility", "description": "Toggles the specified column's visibility.", "parameters": [ { "name": "args", "type": { "text": "IgcColumnVisibilityChangedEventArgs" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandAll", "description": "Expands all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseAll", "description": "Collapses all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandRow", "description": "Expands the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseRow", "description": "Collapses the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleRow", "description": "Toggles the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getHeaderGroupWidth", "description": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "string" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByName", "description": "Returns the `IgxColumnComponent` by field name.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByVisibleIndex", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "recalculateAutoSizes", "description": "Recalculates all widths of columns that have size set to `auto`.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveColumn", "description": "Places a column before or after the specified target column.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "target", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "pos", "type": { "text": "DropPosition" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "markForCheck", "description": "Triggers change detection for the `IgxGridComponent`. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "addRow", "description": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", "parameters": [ { "name": "data", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deleteRow", "description": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "updateCell", "description": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "column", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "updateRow", "description": "Updates the `IgxGridRowComponent`", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getRowData", "description": "Returns the data that is contained in the row component.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "sort", "description": "Sort a single `IgxColumnComponent`.", "parameters": [ { "name": "expression", "type": { "text": "IgcSortingExpression[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filter", "description": "Filters a single `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false }, { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "conditionOrExpressionTree", "type": { "text": "IgcFilteringExpressionsTree | IgcFilteringOperation" }, "optional": true }, { "name": "ignoreCase", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filterGlobal", "description": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", "deprecated": "", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "condition", "type": { "text": "any" }, "optional": false }, { "name": "ignoreCase", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "enableSummaries", "description": "Enables summaries for the specified column and applies your customSummary.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "disableSummaries", "description": "Disable summaries for the specified column.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearFilter", "description": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearSort", "description": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "pinColumn", "description": "Pins a column by field name.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinColumn", "description": "Unpins a column by field name. Returns whether the operation is successful.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "description": "Pin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "description": "Unpin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "reflow", "description": "Recalculates grid width/height dimensions.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "findNext", "description": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "findPrev", "description": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "refreshSearch", "description": "Reapplies the existing search.", "parameters": [ { "name": "updateActiveInfo", "type": { "text": "boolean" }, "optional": true }, { "name": "endEdit", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "clearSearch", "description": "Removes all the highlights in the cell.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedStartWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedEndWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRows", "description": "Select specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectRows", "description": "Deselect specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllRows", "description": "Selects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllRows", "description": "Deselects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearCellSelection", "description": "Deselect selected cells.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRange", "description": "Select range(s) of cells between certain rows and columns of the grid.", "parameters": [ { "name": "arg", "type": { "text": "IgcGridSelectionRange[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedRanges", "description": "Get the currently selected ranges in the grid.", "parameters": [], "return": { "type": { "text": "IgcGridSelectionRange[]" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectedColumns", "description": "Get current selected columns.", "parameters": [], "return": { "type": { "text": "IgcColumnComponent[]" } } }, { "kind": "method", "privacy": "public", "name": "selectColumns", "description": "Select specified columns.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectColumns", "description": "Deselect specified columns by field.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllColumns", "description": "Deselects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllColumns", "description": "Selects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedColumnsData", "description": "Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "navigateTo", "description": "Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "visibleColIndex", "type": { "text": "number" }, "optional": true }, { "name": "cb", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getNextCell", "description": "Returns `ICellPosition` which defines the next cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "getPreviousCell", "description": "Returns `ICellPosition` which defines the previous cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "openAdvancedFilteringDialog", "description": "Opens the advanced filtering dialog.", "parameters": [ { "name": "overlaySettings", "type": { "text": "IgcOverlaySettings" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "closeAdvancedFilteringDialog", "description": "Closes the advanced filtering dialog.", "parameters": [ { "name": "applyChanges", "type": { "text": "boolean" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "endEdit", "description": "Finishes the row transactions on the current row and returns whether the grid editing was canceled.", "parameters": [ { "name": "commit", "type": { "text": "boolean" }, "optional": true }, { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowById", "description": "Enters add mode by spawning the UI under the specified row by rowID.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "asChild", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowByIndex", "description": "Enters add mode by spawning the UI at the specified index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "groups-expanded", "type": { "text": "boolean" }, "fieldName": "groupsExpanded", "description": "Gets/Sets whether created groups are rendered expanded or collapsed." }, { "name": "id", "type": { "text": "string" }, "fieldName": "id", "description": "Gets/Sets the value of the `id` attribute." }, { "name": "data", "type": { "text": "any[]" }, "fieldName": "data", "description": "Gets/Sets the array of data that populates the component." }, { "name": "total-item-count", "type": { "text": "number" }, "fieldName": "totalItemCount", "description": "Gets/Sets the total number of records in the data source." }, { "name": "grouping-expressions", "type": { "text": "IgcGroupingExpression[]" }, "fieldName": "groupingExpressions", "description": "Gets/Sets the group by state." }, { "name": "grouping-expansion-state", "type": { "text": "IgcGroupByExpandState[]" }, "fieldName": "groupingExpansionState", "description": "Gets/Sets a list of expansion states for group rows." }, { "name": "hide-grouped-columns", "type": { "text": "boolean" }, "fieldName": "hideGroupedColumns", "description": "Gets/Sets whether the grouped columns should be hidden." }, { "name": "group-strategy", "type": { "text": "IgcGridGroupingStrategy" }, "fieldName": "groupStrategy", "description": "Gets/Sets the grouping strategy of the grid." }, { "name": "drop-area-message", "type": { "text": "string" }, "fieldName": "dropAreaMessage", "description": "Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on." }, { "name": "show-group-area", "type": { "text": "boolean" }, "fieldName": "showGroupArea", "description": "Returns whether the `IgxGridComponent` has group area." }, { "name": "snackbar-display-time", "type": { "text": "number" }, "fieldName": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification." }, { "name": "auto-generate", "type": { "text": "boolean" }, "fieldName": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns." }, { "name": "auto-generate-exclude", "type": { "text": "string[]" }, "fieldName": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection" }, { "name": "moving", "type": { "text": "boolean" }, "fieldName": "moving", "description": "Controls whether columns moving is enabled in the grid." }, { "name": "summary-row-height", "type": { "text": "number" }, "fieldName": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height" }, { "name": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" }, "fieldName": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode." }, { "name": "clipboard-options", "type": { "text": "IgcClipboardOptions" }, "fieldName": "clipboardOptions", "description": "Controls the copy behavior of the grid." }, { "name": "row-classes", "type": { "text": "any" }, "fieldName": "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:" }, { "name": "row-styles", "type": { "text": "any" }, "fieldName": "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." }, { "name": "primary-key", "type": { "text": "string" }, "fieldName": "primaryKey", "description": "Gets/Sets the primary key." }, { "name": "column-list", "type": { "text": "IgcColumnComponent[]" }, "fieldName": "columnList" }, { "name": "action-strip-components", "type": { "text": "IgcActionStripToken[]" }, "fieldName": "actionStripComponents" }, { "name": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" }, "fieldName": "toolbar" }, { "name": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" }, "fieldName": "paginationComponents" }, { "name": "resource-strings", "type": { "text": "IgcGridResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." }, { "name": "filtering-logic", "type": { "text": "FilteringLogic" }, "fieldName": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`." }, { "name": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "filteringExpressionsTree", "description": "Gets/Sets the filtering state." }, { "name": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state." }, { "name": "locale", "type": { "text": "string" }, "fieldName": "locale", "description": "Gets/Sets the locale." }, { "name": "paging-mode", "type": { "text": "GridPagingMode" }, "fieldName": "pagingMode" }, { "name": "hide-row-selectors", "type": { "text": "boolean" }, "fieldName": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden." }, { "name": "row-draggable", "type": { "text": "boolean" }, "fieldName": "rowDraggable", "description": "Gets/Sets whether rows can be moved." }, { "name": "validation-trigger", "type": { "text": "GridValidationTrigger" }, "fieldName": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid." }, { "name": "row-editable", "type": { "text": "boolean" }, "fieldName": "rowEditable", "description": "Gets/Sets whether the rows are editable." }, { "name": "height", "type": { "text": "string" }, "fieldName": "height", "description": "Gets/Sets the height." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets/Sets the width of the grid." }, { "name": "row-height", "type": { "text": "number" }, "fieldName": "rowHeight", "description": "Gets/Sets the row height." }, { "name": "column-width", "type": { "text": "string" }, "fieldName": "columnWidth", "description": "Gets/Sets the default width of the columns." }, { "name": "empty-grid-message", "type": { "text": "string" }, "fieldName": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records." }, { "name": "is-loading", "type": { "text": "boolean" }, "fieldName": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator." }, { "name": "should-generate", "type": { "text": "boolean" }, "fieldName": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead." }, { "name": "empty-filtered-grid-message", "type": { "text": "string" }, "fieldName": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered." }, { "name": "pinning", "type": { "text": "IgcPinningConfig" }, "fieldName": "pinning", "description": "Gets/Sets the initial pinning configuration." }, { "name": "allow-filtering", "type": { "text": "boolean" }, "fieldName": "allowFiltering", "description": "Gets/Sets if the filtering is enabled." }, { "name": "allow-advanced-filtering", "type": { "text": "boolean" }, "fieldName": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled." }, { "name": "filter-mode", "type": { "text": "FilterMode" }, "fieldName": "filterMode", "description": "Gets/Sets the filter mode." }, { "name": "summary-position", "type": { "text": "GridSummaryPosition" }, "fieldName": "summaryPosition", "description": "Gets/Sets the summary position." }, { "name": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" }, "fieldName": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode." }, { "name": "show-summary-on-collapse", "type": { "text": "boolean" }, "fieldName": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed." }, { "name": "filter-strategy", "type": { "text": "IgcFilteringStrategy" }, "fieldName": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid." }, { "name": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid." }, { "name": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" }, "fieldName": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid." }, { "name": "sorting-options", "type": { "text": "IgcSortingOptions" }, "fieldName": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties." }, { "name": "selected-rows", "type": { "text": "any[]" }, "fieldName": "selectedRows", "description": "Gets/Sets the current selection state." }, { "name": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" }, "fieldName": "sortingExpressions", "description": "Gets/Sets the sorting state." }, { "name": "batch-editing", "type": { "text": "boolean" }, "fieldName": "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." }, { "name": "cell-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "cellSelection", "description": "Gets/Sets cell selection mode." }, { "name": "cell-merge-mode", "type": { "text": "GridCellMergeMode" }, "fieldName": "cellMergeMode", "description": "Gets/Sets cell merge mode." }, { "name": "row-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "rowSelection", "description": "Gets/Sets row selection mode" }, { "name": "column-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "columnSelection", "description": "Gets/Sets column selection mode" }, { "name": "expansion-states", "type": { "text": "Map" }, "fieldName": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state]." }, { "name": "outlet", "type": { "text": "IgcOverlayOutletDirective" }, "fieldName": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to." }, { "name": "total-records", "type": { "text": "number" }, "fieldName": "totalRecords", "description": "Returns the total number of records." }, { "name": "select-row-on-click", "type": { "text": "boolean" }, "fieldName": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it" } ], "events": [ { "name": "dataPreLoad", "description": "Emitted when a new chunk of data is loaded from virtualization.", "type": { "text": "CustomEvent" } }, { "name": "groupingExpressionsChange", "description": "Emitted when grouping is performed.", "type": { "text": "CustomEvent" } }, { "name": "groupingExpansionStateChange", "description": "Emitted when groups are expanded/collapsed.", "type": { "text": "CustomEvent" } }, { "name": "groupingDone", "description": "Emitted when columns are grouped/ungrouped.", "type": { "text": "CustomEvent" } }, { "name": "filteringExpressionsTreeChange", "description": "Emitted after filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "advancedFilteringExpressionsTreeChange", "description": "Emitted after advanced filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "gridScroll", "description": "Emitted when grid is scrolled horizontally/vertically.", "type": { "text": "CustomEvent" } }, { "name": "cellClick", "description": "Emitted when a cell is clicked.", "type": { "text": "CustomEvent" } }, { "name": "rowClick", "description": "Emitted when a row is clicked.", "type": { "text": "CustomEvent" } }, { "name": "formGroupCreated", "description": "Emitted when formGroup is created on edit of row/cell.", "type": { "text": "CustomEvent" } }, { "name": "validationStatusChange", "description": "Emitted when grid's validation status changes.", "type": { "text": "CustomEvent" } }, { "name": "selected", "description": "Emitted when a cell is selected.", "type": { "text": "CustomEvent" } }, { "name": "rowSelectionChanging", "description": "Emitted when `IgxGridRowComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnSelectionChanging", "description": "Emitted when `IgxColumnComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnPin", "description": "Emitted before `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "columnPinned", "description": "Emitted after `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "cellEditEnter", "description": "Emitted when cell enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEditExit", "description": "Emitted when cell exits edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEdit", "description": "Emitted when cell has been edited.", "type": { "text": "CustomEvent" } }, { "name": "cellEditDone", "description": "Emitted after cell has been edited and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditEnter", "description": "Emitted when a row enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "rowEdit", "description": "Emitted when exiting edit mode for a row.", "type": { "text": "CustomEvent" } }, { "name": "rowEditDone", "description": "Emitted after exiting edit mode for a row and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditExit", "description": "Emitted when row editing is canceled.", "type": { "text": "CustomEvent" } }, { "name": "columnInit", "description": "Emitted when a column is initialized.", "type": { "text": "CustomEvent" } }, { "name": "columnsAutogenerated", "description": "", "type": { "text": "CustomEvent" } }, { "name": "sorting", "description": "Emitted before sorting expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "sortingDone", "description": "Emitted after sorting is completed.", "type": { "text": "CustomEvent" } }, { "name": "filtering", "description": "Emitted before filtering expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "filteringDone", "description": "Emitted after filtering is performed through the UI.", "type": { "text": "CustomEvent" } }, { "name": "rowAdded", "description": "Emitted when a row is added.", "type": { "text": "CustomEvent" } }, { "name": "rowDeleted", "description": "Emitted when a row is deleted.", "type": { "text": "CustomEvent" } }, { "name": "rowDelete", "description": "Emmited when deleting a row.", "type": { "text": "CustomEvent" } }, { "name": "rowAdd", "description": "Emmited just before the newly added row is commited.", "type": { "text": "CustomEvent" } }, { "name": "columnResized", "description": "Emitted after column is resized.", "type": { "text": "CustomEvent" } }, { "name": "contextMenu", "description": "Emitted when a cell or row is right clicked.", "type": { "text": "CustomEvent" } }, { "name": "doubleClick", "description": "Emitted when a cell is double clicked.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanging", "description": "Emitted before column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanged", "description": "Emitted after column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingStart", "description": "Emitted when column moving starts.", "type": { "text": "CustomEvent" } }, { "name": "columnMoving", "description": "Emitted during the column moving operation.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingEnd", "description": "Emitted when column moving ends.", "type": { "text": "CustomEvent" } }, { "name": "gridKeydown", "description": "Emitted when keydown is triggered over element inside grid's body.", "type": { "text": "CustomEvent" } }, { "name": "rowDragStart", "description": "Emitted when start dragging a row.", "type": { "text": "CustomEvent" } }, { "name": "rowDragEnd", "description": "Emitted when dropping a row.", "type": { "text": "CustomEvent" } }, { "name": "gridCopy", "description": "Emitted when a copy operation is executed.", "type": { "text": "CustomEvent" } }, { "name": "expansionStatesChange", "description": "Emitted when the rows are expanded or collapsed.", "type": { "text": "CustomEvent>" } }, { "name": "selectedRowsChange", "description": "Emitted when the rows are selected or deselected.", "type": { "text": "CustomEvent" } }, { "name": "rowToggle", "description": "Emitted when the expanded state of a row gets changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinning", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinned", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "activeNodeChange", "description": "Emitted when the active node is changed.", "type": { "text": "CustomEvent" } }, { "name": "sortingExpressionsChange", "description": "Emitted before sorting is performed.", "type": { "text": "CustomEvent" } }, { "name": "toolbarExporting", "description": "Emitted when an export process is initiated by the user.", "type": { "text": "CustomEvent" } }, { "name": "rangeSelected", "description": "Emitted when making a range selection.", "type": { "text": "CustomEvent" } }, { "name": "rendered", "description": "Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM", "type": { "text": "CustomEvent" } }, { "name": "dataChanging", "description": "Emitted before the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } }, { "name": "dataChanged", "description": "Emitted after the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid", "customElement": true }, { "kind": "class", "name": "IgcHierarchicalGridComponent", "description": "Hierarchical grid", "members": [ { "kind": "field", "privacy": "public", "name": "childLayoutList", "attribute": "child-layout-list", "type": { "text": "IgcRowIslandComponent[]" } }, { "kind": "field", "privacy": "public", "name": "advancedFilteringExpressionsTree", "attribute": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "id", "description": "Gets/Sets the value of the `id` attribute.", "attribute": "id", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "data", "description": "Gets/Sets the array of data that populates the component.", "attribute": "data", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "totalItemCount", "description": "Gets/Sets the total number of records in the data source.", "attribute": "total-item-count", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "expandChildren", "description": "Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed. Default value is false.", "attribute": "expand-children", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcGridResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "foreignKey", "description": "Gets the unique identifier of the parent row. It may be a `string` or `number` if `primaryKey` of the parent grid is set or an object reference of the parent record otherwise.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "selectedCells", "description": "Returns an array of the selected `IgxGridCell`s.", "readonly": true, "type": { "text": "IgcCellType[]" } }, { "kind": "field", "privacy": "public", "name": "hasChildrenKey", "description": "Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.", "attribute": "has-children-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "showExpandAll", "description": "Gets/Sets whether the expand/collapse all button in the header should be rendered.", "attribute": "show-expand-all", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rootGrid", "attribute": "root-grid", "type": { "text": "IgcGridBaseDirective" } }, { "kind": "field", "privacy": "public", "name": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification.", "attribute": "snackbar-display-time", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns.", "attribute": "auto-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection", "attribute": "auto-generate-exclude", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "moving", "description": "Controls whether columns moving is enabled in the grid.", "attribute": "moving", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyGridTemplate", "description": "Gets/Sets a custom template when empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "addRowEmptyTemplate", "description": "Gets/Sets a custom template for adding row UI when grid is empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "loadingGridTemplate", "description": "Gets/Sets a custom template when loading.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height", "attribute": "summary-row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode.", "attribute": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" } }, { "kind": "field", "privacy": "public", "name": "clipboardOptions", "description": "Controls the copy behavior of the grid.", "attribute": "clipboard-options", "type": { "text": "IgcClipboardOptions" } }, { "kind": "field", "privacy": "public", "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:", "attribute": "row-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "row-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "primaryKey", "description": "Gets/Sets the primary key.", "attribute": "primary-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "columnList", "attribute": "column-list", "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "actionStripComponents", "attribute": "action-strip-components", "type": { "text": "IgcActionStripToken[]" } }, { "kind": "field", "privacy": "public", "name": "dragGhostCustomTemplate", "description": "Gets the custom template, if any, used for row drag ghost.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditTextTemplate", "description": "Gets the row edit text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowAddTextTemplate", "description": "Gets the row add text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditActionsTemplate", "description": "Gets the row edit actions template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowExpandedIndicatorTemplate", "description": "Gets the row expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerExpandedIndicatorTemplate", "description": "Gets the header expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "excelStyleHeaderIconTemplate", "description": "Gets the excel style header icon.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortHeaderIconTemplate", "description": "Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "toolbar", "attribute": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" } }, { "kind": "field", "privacy": "public", "name": "paginationComponents", "attribute": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcGridResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`.", "attribute": "filtering-logic", "type": { "text": "FilteringLogic" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Gets/Sets the filtering state.", "attribute": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state.", "attribute": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "locale", "description": "Gets/Sets the locale.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pagingMode", "attribute": "paging-mode", "type": { "text": "GridPagingMode" } }, { "kind": "field", "privacy": "public", "name": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden.", "attribute": "hide-row-selectors", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rowDraggable", "description": "Gets/Sets whether rows can be moved.", "attribute": "row-draggable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid.", "attribute": "validation-trigger", "type": { "text": "GridValidationTrigger" } }, { "kind": "field", "privacy": "public", "name": "rowEditable", "description": "Gets/Sets whether the rows are editable.", "attribute": "row-editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "height", "description": "Gets/Sets the height.", "attribute": "height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets/Sets the width of the grid.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "rowHeight", "description": "Gets/Sets the row height.", "attribute": "row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnWidth", "description": "Gets/Sets the default width of the columns.", "attribute": "column-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records.", "attribute": "empty-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator.", "attribute": "is-loading", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead.", "attribute": "should-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered.", "attribute": "empty-filtered-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pinning", "description": "Gets/Sets the initial pinning configuration.", "attribute": "pinning", "type": { "text": "IgcPinningConfig" } }, { "kind": "field", "privacy": "public", "name": "allowFiltering", "description": "Gets/Sets if the filtering is enabled.", "attribute": "allow-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled.", "attribute": "allow-advanced-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterMode", "description": "Gets/Sets the filter mode.", "attribute": "filter-mode", "type": { "text": "FilterMode" } }, { "kind": "field", "privacy": "public", "name": "summaryPosition", "description": "Gets/Sets the summary position.", "attribute": "summary-position", "type": { "text": "GridSummaryPosition" } }, { "kind": "field", "privacy": "public", "name": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode.", "attribute": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" } }, { "kind": "field", "privacy": "public", "name": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed.", "attribute": "show-summary-on-collapse", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid.", "attribute": "filter-strategy", "type": { "text": "IgcFilteringStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid.", "attribute": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid.", "attribute": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties.", "attribute": "sorting-options", "type": { "text": "IgcSortingOptions" } }, { "kind": "field", "privacy": "public", "name": "selectedRows", "description": "Gets/Sets the current selection state.", "attribute": "selected-rows", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "rowList", "description": "A list of `IgxGridRowComponent`.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "dataRowList", "description": "A list of currently rendered `IgxGridRowComponent`'s.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "headSelectorTemplate", "description": "Gets the header row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowSelectorTemplate", "description": "Gets the row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "dragIndicatorIconTemplate", "description": "The custom template, if any, that should be used when rendering the row drag indicator icon", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortingExpressions", "description": "Gets/Sets the sorting state.", "attribute": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "hiddenColumnsCount", "description": "Gets the number of hidden columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumnsCount", "description": "Gets the number of pinned columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "batch-editing", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "cellSelection", "description": "Gets/Sets cell selection mode.", "attribute": "cell-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "cellMergeMode", "description": "Gets/Sets cell merge mode.", "attribute": "cell-merge-mode", "type": { "text": "GridCellMergeMode" } }, { "kind": "field", "privacy": "public", "name": "rowSelection", "description": "Gets/Sets row selection mode", "attribute": "row-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "columnSelection", "description": "Gets/Sets column selection mode", "attribute": "column-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "lastSearchInfo", "description": "Represents the last search information.", "readonly": true, "type": { "text": "IgcSearchInfo" } }, { "kind": "field", "privacy": "public", "name": "filteredData", "description": "Returns an array of objects containing the filtered data.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteredSortedData", "description": "Returns an array containing the filtered sorted data.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "virtualizationState", "description": "Returns the state of the grid virtualization.", "readonly": true, "type": { "text": "IgcForOfState" } }, { "kind": "field", "privacy": "public", "name": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state].", "attribute": "expansion-states", "type": { "text": "Map" } }, { "kind": "field", "privacy": "public", "name": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to.", "attribute": "outlet", "type": { "text": "IgcOverlayOutletDirective" } }, { "kind": "field", "privacy": "public", "name": "defaultRowHeight", "description": "Gets the default row height.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columns", "description": "Gets an array of `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumns", "description": "Gets an array of the pinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedStartColumns", "description": "Gets an array of the pinned to the left `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedEndColumns", "description": "Gets an array of the pinned to the right `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedRows", "description": "Gets an array of the pinned `IgxRowComponent`s.", "readonly": true, "type": { "text": "IgcGridRowComponent[]" } }, { "kind": "field", "privacy": "public", "name": "unpinnedColumns", "description": "Gets an array of unpinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "visibleColumns", "description": "Returns an array of visible `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "totalRecords", "description": "Returns the total number of records.", "attribute": "total-records", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataView", "description": "Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it", "attribute": "select-row-on-click", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "getRowByIndex", "description": "Returns the `RowType` by index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getRowByKey", "description": "Returns the `RowType` by key.", "parameters": [ { "name": "key", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getCellByColumn", "description": "Returns a `CellType` object that matches the conditions.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "columnField", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcCellType" } } }, { "kind": "method", "privacy": "public", "name": "getCellByKey", "description": "Returns a `CellType` object that matches the conditions.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "columnField", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcCellType" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "getDefaultExpandState", "parameters": [ { "name": "record", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "isRecordPinnedByIndex", "description": "Returns whether the record is pinned or not.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleColumnVisibility", "description": "Toggles the specified column's visibility.", "parameters": [ { "name": "args", "type": { "text": "IgcColumnVisibilityChangedEventArgs" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandAll", "description": "Expands all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseAll", "description": "Collapses all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandRow", "description": "Expands the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseRow", "description": "Collapses the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleRow", "description": "Toggles the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getHeaderGroupWidth", "description": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "string" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByName", "description": "Returns the `IgxColumnComponent` by field name.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByVisibleIndex", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "recalculateAutoSizes", "description": "Recalculates all widths of columns that have size set to `auto`.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveColumn", "description": "Places a column before or after the specified target column.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "target", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "pos", "type": { "text": "DropPosition" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "markForCheck", "description": "Triggers change detection for the `IgxGridComponent`. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "addRow", "description": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", "parameters": [ { "name": "data", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deleteRow", "description": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "updateCell", "description": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "column", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "updateRow", "description": "Updates the `IgxGridRowComponent`", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getRowData", "description": "Returns the data that is contained in the row component.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "sort", "description": "Sort a single `IgxColumnComponent`.", "parameters": [ { "name": "expression", "type": { "text": "IgcSortingExpression[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filter", "description": "Filters a single `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false }, { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "conditionOrExpressionTree", "type": { "text": "IgcFilteringExpressionsTree | IgcFilteringOperation" }, "optional": true }, { "name": "ignoreCase", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filterGlobal", "description": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", "deprecated": "", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "condition", "type": { "text": "any" }, "optional": false }, { "name": "ignoreCase", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "enableSummaries", "description": "Enables summaries for the specified column and applies your customSummary.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "disableSummaries", "description": "Disable summaries for the specified column.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearFilter", "description": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearSort", "description": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "pinColumn", "description": "Pins a column by field name.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinColumn", "description": "Unpins a column by field name. Returns whether the operation is successful.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "description": "Pin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "description": "Unpin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "reflow", "description": "Recalculates grid width/height dimensions.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "findNext", "description": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "findPrev", "description": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "refreshSearch", "description": "Reapplies the existing search.", "parameters": [ { "name": "updateActiveInfo", "type": { "text": "boolean" }, "optional": true }, { "name": "endEdit", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "clearSearch", "description": "Removes all the highlights in the cell.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedStartWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedEndWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRows", "description": "Select specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectRows", "description": "Deselect specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllRows", "description": "Selects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllRows", "description": "Deselects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearCellSelection", "description": "Deselect selected cells.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRange", "description": "Select range(s) of cells between certain rows and columns of the grid.", "parameters": [ { "name": "arg", "type": { "text": "IgcGridSelectionRange[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedRanges", "description": "Get the currently selected ranges in the grid.", "parameters": [], "return": { "type": { "text": "IgcGridSelectionRange[]" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectedColumns", "description": "Get current selected columns.", "parameters": [], "return": { "type": { "text": "IgcColumnComponent[]" } } }, { "kind": "method", "privacy": "public", "name": "selectColumns", "description": "Select specified columns.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectColumns", "description": "Deselect specified columns by field.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllColumns", "description": "Deselects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllColumns", "description": "Selects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedColumnsData", "description": "Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "navigateTo", "description": "Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "visibleColIndex", "type": { "text": "number" }, "optional": true }, { "name": "cb", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getNextCell", "description": "Returns `ICellPosition` which defines the next cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "getPreviousCell", "description": "Returns `ICellPosition` which defines the previous cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "openAdvancedFilteringDialog", "description": "Opens the advanced filtering dialog.", "parameters": [ { "name": "overlaySettings", "type": { "text": "IgcOverlaySettings" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "closeAdvancedFilteringDialog", "description": "Closes the advanced filtering dialog.", "parameters": [ { "name": "applyChanges", "type": { "text": "boolean" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "endEdit", "description": "Finishes the row transactions on the current row and returns whether the grid editing was canceled.", "parameters": [ { "name": "commit", "type": { "text": "boolean" }, "optional": true }, { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowById", "description": "Enters add mode by spawning the UI under the specified row by rowID.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "asChild", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowByIndex", "description": "Enters add mode by spawning the UI at the specified index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "child-layout-list", "type": { "text": "IgcRowIslandComponent[]" }, "fieldName": "childLayoutList" }, { "name": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "advancedFilteringExpressionsTree" }, { "name": "id", "type": { "text": "string" }, "fieldName": "id", "description": "Gets/Sets the value of the `id` attribute." }, { "name": "data", "type": { "text": "any[]" }, "fieldName": "data", "description": "Gets/Sets the array of data that populates the component." }, { "name": "total-item-count", "type": { "text": "number" }, "fieldName": "totalItemCount", "description": "Gets/Sets the total number of records in the data source." }, { "name": "expand-children", "type": { "text": "boolean" }, "fieldName": "expandChildren", "description": "Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed. Default value is false." }, { "name": "resource-strings", "type": { "text": "IgcGridResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." }, { "name": "has-children-key", "type": { "text": "string" }, "fieldName": "hasChildrenKey", "description": "Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator." }, { "name": "show-expand-all", "type": { "text": "boolean" }, "fieldName": "showExpandAll", "description": "Gets/Sets whether the expand/collapse all button in the header should be rendered." }, { "name": "root-grid", "type": { "text": "IgcGridBaseDirective" }, "fieldName": "rootGrid" }, { "name": "snackbar-display-time", "type": { "text": "number" }, "fieldName": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification." }, { "name": "auto-generate", "type": { "text": "boolean" }, "fieldName": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns." }, { "name": "auto-generate-exclude", "type": { "text": "string[]" }, "fieldName": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection" }, { "name": "moving", "type": { "text": "boolean" }, "fieldName": "moving", "description": "Controls whether columns moving is enabled in the grid." }, { "name": "summary-row-height", "type": { "text": "number" }, "fieldName": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height" }, { "name": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" }, "fieldName": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode." }, { "name": "clipboard-options", "type": { "text": "IgcClipboardOptions" }, "fieldName": "clipboardOptions", "description": "Controls the copy behavior of the grid." }, { "name": "row-classes", "type": { "text": "any" }, "fieldName": "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:" }, { "name": "row-styles", "type": { "text": "any" }, "fieldName": "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." }, { "name": "primary-key", "type": { "text": "string" }, "fieldName": "primaryKey", "description": "Gets/Sets the primary key." }, { "name": "column-list", "type": { "text": "IgcColumnComponent[]" }, "fieldName": "columnList" }, { "name": "action-strip-components", "type": { "text": "IgcActionStripToken[]" }, "fieldName": "actionStripComponents" }, { "name": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" }, "fieldName": "toolbar" }, { "name": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" }, "fieldName": "paginationComponents" }, { "name": "resource-strings", "type": { "text": "IgcGridResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." }, { "name": "filtering-logic", "type": { "text": "FilteringLogic" }, "fieldName": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`." }, { "name": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "filteringExpressionsTree", "description": "Gets/Sets the filtering state." }, { "name": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state." }, { "name": "locale", "type": { "text": "string" }, "fieldName": "locale", "description": "Gets/Sets the locale." }, { "name": "paging-mode", "type": { "text": "GridPagingMode" }, "fieldName": "pagingMode" }, { "name": "hide-row-selectors", "type": { "text": "boolean" }, "fieldName": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden." }, { "name": "row-draggable", "type": { "text": "boolean" }, "fieldName": "rowDraggable", "description": "Gets/Sets whether rows can be moved." }, { "name": "validation-trigger", "type": { "text": "GridValidationTrigger" }, "fieldName": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid." }, { "name": "row-editable", "type": { "text": "boolean" }, "fieldName": "rowEditable", "description": "Gets/Sets whether the rows are editable." }, { "name": "height", "type": { "text": "string" }, "fieldName": "height", "description": "Gets/Sets the height." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets/Sets the width of the grid." }, { "name": "row-height", "type": { "text": "number" }, "fieldName": "rowHeight", "description": "Gets/Sets the row height." }, { "name": "column-width", "type": { "text": "string" }, "fieldName": "columnWidth", "description": "Gets/Sets the default width of the columns." }, { "name": "empty-grid-message", "type": { "text": "string" }, "fieldName": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records." }, { "name": "is-loading", "type": { "text": "boolean" }, "fieldName": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator." }, { "name": "should-generate", "type": { "text": "boolean" }, "fieldName": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead." }, { "name": "empty-filtered-grid-message", "type": { "text": "string" }, "fieldName": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered." }, { "name": "pinning", "type": { "text": "IgcPinningConfig" }, "fieldName": "pinning", "description": "Gets/Sets the initial pinning configuration." }, { "name": "allow-filtering", "type": { "text": "boolean" }, "fieldName": "allowFiltering", "description": "Gets/Sets if the filtering is enabled." }, { "name": "allow-advanced-filtering", "type": { "text": "boolean" }, "fieldName": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled." }, { "name": "filter-mode", "type": { "text": "FilterMode" }, "fieldName": "filterMode", "description": "Gets/Sets the filter mode." }, { "name": "summary-position", "type": { "text": "GridSummaryPosition" }, "fieldName": "summaryPosition", "description": "Gets/Sets the summary position." }, { "name": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" }, "fieldName": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode." }, { "name": "show-summary-on-collapse", "type": { "text": "boolean" }, "fieldName": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed." }, { "name": "filter-strategy", "type": { "text": "IgcFilteringStrategy" }, "fieldName": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid." }, { "name": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid." }, { "name": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" }, "fieldName": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid." }, { "name": "sorting-options", "type": { "text": "IgcSortingOptions" }, "fieldName": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties." }, { "name": "selected-rows", "type": { "text": "any[]" }, "fieldName": "selectedRows", "description": "Gets/Sets the current selection state." }, { "name": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" }, "fieldName": "sortingExpressions", "description": "Gets/Sets the sorting state." }, { "name": "batch-editing", "type": { "text": "boolean" }, "fieldName": "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." }, { "name": "cell-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "cellSelection", "description": "Gets/Sets cell selection mode." }, { "name": "cell-merge-mode", "type": { "text": "GridCellMergeMode" }, "fieldName": "cellMergeMode", "description": "Gets/Sets cell merge mode." }, { "name": "row-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "rowSelection", "description": "Gets/Sets row selection mode" }, { "name": "column-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "columnSelection", "description": "Gets/Sets column selection mode" }, { "name": "expansion-states", "type": { "text": "Map" }, "fieldName": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state]." }, { "name": "outlet", "type": { "text": "IgcOverlayOutletDirective" }, "fieldName": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to." }, { "name": "total-records", "type": { "text": "number" }, "fieldName": "totalRecords", "description": "Returns the total number of records." }, { "name": "select-row-on-click", "type": { "text": "boolean" }, "fieldName": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it" } ], "events": [ { "name": "dataPreLoad", "description": "Emitted when a new chunk of data is loaded from virtualization.", "type": { "text": "CustomEvent" } }, { "name": "filteringExpressionsTreeChange", "description": "Emitted after filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "advancedFilteringExpressionsTreeChange", "description": "Emitted after advanced filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "gridScroll", "description": "Emitted when grid is scrolled horizontally/vertically.", "type": { "text": "CustomEvent" } }, { "name": "cellClick", "description": "Emitted when a cell is clicked.", "type": { "text": "CustomEvent" } }, { "name": "rowClick", "description": "Emitted when a row is clicked.", "type": { "text": "CustomEvent" } }, { "name": "formGroupCreated", "description": "Emitted when formGroup is created on edit of row/cell.", "type": { "text": "CustomEvent" } }, { "name": "validationStatusChange", "description": "Emitted when grid's validation status changes.", "type": { "text": "CustomEvent" } }, { "name": "selected", "description": "Emitted when a cell is selected.", "type": { "text": "CustomEvent" } }, { "name": "rowSelectionChanging", "description": "Emitted when `IgxGridRowComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnSelectionChanging", "description": "Emitted when `IgxColumnComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnPin", "description": "Emitted before `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "columnPinned", "description": "Emitted after `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "cellEditEnter", "description": "Emitted when cell enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEditExit", "description": "Emitted when cell exits edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEdit", "description": "Emitted when cell has been edited.", "type": { "text": "CustomEvent" } }, { "name": "cellEditDone", "description": "Emitted after cell has been edited and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditEnter", "description": "Emitted when a row enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "rowEdit", "description": "Emitted when exiting edit mode for a row.", "type": { "text": "CustomEvent" } }, { "name": "rowEditDone", "description": "Emitted after exiting edit mode for a row and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditExit", "description": "Emitted when row editing is canceled.", "type": { "text": "CustomEvent" } }, { "name": "columnInit", "description": "Emitted when a column is initialized.", "type": { "text": "CustomEvent" } }, { "name": "columnsAutogenerated", "description": "", "type": { "text": "CustomEvent" } }, { "name": "sorting", "description": "Emitted before sorting expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "sortingDone", "description": "Emitted after sorting is completed.", "type": { "text": "CustomEvent" } }, { "name": "filtering", "description": "Emitted before filtering expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "filteringDone", "description": "Emitted after filtering is performed through the UI.", "type": { "text": "CustomEvent" } }, { "name": "rowAdded", "description": "Emitted when a row is added.", "type": { "text": "CustomEvent" } }, { "name": "rowDeleted", "description": "Emitted when a row is deleted.", "type": { "text": "CustomEvent" } }, { "name": "rowDelete", "description": "Emmited when deleting a row.", "type": { "text": "CustomEvent" } }, { "name": "rowAdd", "description": "Emmited just before the newly added row is commited.", "type": { "text": "CustomEvent" } }, { "name": "columnResized", "description": "Emitted after column is resized.", "type": { "text": "CustomEvent" } }, { "name": "contextMenu", "description": "Emitted when a cell or row is right clicked.", "type": { "text": "CustomEvent" } }, { "name": "doubleClick", "description": "Emitted when a cell is double clicked.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanging", "description": "Emitted before column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanged", "description": "Emitted after column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingStart", "description": "Emitted when column moving starts.", "type": { "text": "CustomEvent" } }, { "name": "columnMoving", "description": "Emitted during the column moving operation.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingEnd", "description": "Emitted when column moving ends.", "type": { "text": "CustomEvent" } }, { "name": "gridKeydown", "description": "Emitted when keydown is triggered over element inside grid's body.", "type": { "text": "CustomEvent" } }, { "name": "rowDragStart", "description": "Emitted when start dragging a row.", "type": { "text": "CustomEvent" } }, { "name": "rowDragEnd", "description": "Emitted when dropping a row.", "type": { "text": "CustomEvent" } }, { "name": "gridCopy", "description": "Emitted when a copy operation is executed.", "type": { "text": "CustomEvent" } }, { "name": "expansionStatesChange", "description": "Emitted when the rows are expanded or collapsed.", "type": { "text": "CustomEvent>" } }, { "name": "selectedRowsChange", "description": "Emitted when the rows are selected or deselected.", "type": { "text": "CustomEvent" } }, { "name": "rowToggle", "description": "Emitted when the expanded state of a row gets changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinning", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinned", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "activeNodeChange", "description": "Emitted when the active node is changed.", "type": { "text": "CustomEvent" } }, { "name": "sortingExpressionsChange", "description": "Emitted before sorting is performed.", "type": { "text": "CustomEvent" } }, { "name": "toolbarExporting", "description": "Emitted when an export process is initiated by the user.", "type": { "text": "CustomEvent" } }, { "name": "rangeSelected", "description": "Emitted when making a range selection.", "type": { "text": "CustomEvent" } }, { "name": "rendered", "description": "Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM", "type": { "text": "CustomEvent" } }, { "name": "dataChanging", "description": "Emitted before the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } }, { "name": "dataChanged", "description": "Emitted after the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-hierarchical-grid", "customElement": true }, { "kind": "class", "name": "IgcRowIslandComponent", "description": "Row island", "members": [ { "kind": "field", "privacy": "public", "name": "childDataKey", "description": "Sets the key of the row island by which child data would be taken from the row data if such is provided.", "attribute": "child-data-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcGridResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "childLayoutList", "attribute": "child-layout-list", "type": { "text": "IgcRowIslandComponent[]" } }, { "kind": "field", "privacy": "public", "name": "toolbarTemplate", "description": "Sets/Gets the toolbar template for each child grid created from this row island.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "paginatorTemplate", "description": "Sets/Gets the paginator template for each child grid created from this row island.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "actionStripComponents", "attribute": "action-strip-components", "type": { "text": "IgcActionStripToken[]" } }, { "kind": "field", "privacy": "public", "name": "expandChildren", "description": "Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed.", "attribute": "expand-children", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "hasChildrenKey", "description": "Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.", "attribute": "has-children-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "showExpandAll", "description": "Gets/Sets whether the expand/collapse all button in the header should be rendered.", "attribute": "show-expand-all", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "batchEditing", "attribute": "batch-editing", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification.", "attribute": "snackbar-display-time", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns.", "attribute": "auto-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection", "attribute": "auto-generate-exclude", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "moving", "description": "Controls whether columns moving is enabled in the grid.", "attribute": "moving", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyGridTemplate", "description": "Gets/Sets a custom template when empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "addRowEmptyTemplate", "description": "Gets/Sets a custom template for adding row UI when grid is empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "loadingGridTemplate", "description": "Gets/Sets a custom template when loading.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height", "attribute": "summary-row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode.", "attribute": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" } }, { "kind": "field", "privacy": "public", "name": "clipboardOptions", "description": "Controls the copy behavior of the grid.", "attribute": "clipboard-options", "type": { "text": "IgcClipboardOptions" } }, { "kind": "field", "privacy": "public", "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:", "attribute": "row-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "row-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "primaryKey", "description": "Gets/Sets the primary key.", "attribute": "primary-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "columnList", "attribute": "column-list", "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "dragGhostCustomTemplate", "description": "Gets the custom template, if any, used for row drag ghost.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditTextTemplate", "description": "Gets the row edit text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowAddTextTemplate", "description": "Gets the row add text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditActionsTemplate", "description": "Gets the row edit actions template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowExpandedIndicatorTemplate", "description": "Gets the row expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerExpandedIndicatorTemplate", "description": "Gets the header expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "excelStyleHeaderIconTemplate", "description": "Gets the excel style header icon.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortHeaderIconTemplate", "description": "Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "toolbar", "attribute": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" } }, { "kind": "field", "privacy": "public", "name": "paginationComponents", "attribute": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" } }, { "kind": "field", "privacy": "public", "name": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`.", "attribute": "filtering-logic", "type": { "text": "FilteringLogic" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Gets/Sets the filtering state.", "attribute": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state.", "attribute": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "locale", "description": "Gets/Sets the locale.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pagingMode", "attribute": "paging-mode", "type": { "text": "GridPagingMode" } }, { "kind": "field", "privacy": "public", "name": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden.", "attribute": "hide-row-selectors", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rowDraggable", "description": "Gets/Sets whether rows can be moved.", "attribute": "row-draggable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid.", "attribute": "validation-trigger", "type": { "text": "GridValidationTrigger" } }, { "kind": "field", "privacy": "public", "name": "rowEditable", "description": "Gets/Sets whether the rows are editable.", "attribute": "row-editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "height", "description": "Gets/Sets the height.", "attribute": "height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets/Sets the width of the grid.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "rowHeight", "description": "Gets/Sets the row height.", "attribute": "row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnWidth", "description": "Gets/Sets the default width of the columns.", "attribute": "column-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records.", "attribute": "empty-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator.", "attribute": "is-loading", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead.", "attribute": "should-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered.", "attribute": "empty-filtered-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pinning", "description": "Gets/Sets the initial pinning configuration.", "attribute": "pinning", "type": { "text": "IgcPinningConfig" } }, { "kind": "field", "privacy": "public", "name": "allowFiltering", "description": "Gets/Sets if the filtering is enabled.", "attribute": "allow-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled.", "attribute": "allow-advanced-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterMode", "description": "Gets/Sets the filter mode.", "attribute": "filter-mode", "type": { "text": "FilterMode" } }, { "kind": "field", "privacy": "public", "name": "summaryPosition", "description": "Gets/Sets the summary position.", "attribute": "summary-position", "type": { "text": "GridSummaryPosition" } }, { "kind": "field", "privacy": "public", "name": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode.", "attribute": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" } }, { "kind": "field", "privacy": "public", "name": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed.", "attribute": "show-summary-on-collapse", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid.", "attribute": "filter-strategy", "type": { "text": "IgcFilteringStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid.", "attribute": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid.", "attribute": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties.", "attribute": "sorting-options", "type": { "text": "IgcSortingOptions" } }, { "kind": "field", "privacy": "public", "name": "selectedRows", "description": "Gets/Sets the current selection state.", "attribute": "selected-rows", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "rowList", "description": "A list of `IgxGridRowComponent`.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "dataRowList", "description": "A list of currently rendered `IgxGridRowComponent`'s.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "headSelectorTemplate", "description": "Gets the header row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowSelectorTemplate", "description": "Gets the row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "dragIndicatorIconTemplate", "description": "The custom template, if any, that should be used when rendering the row drag indicator icon", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortingExpressions", "description": "Gets/Sets the sorting state.", "attribute": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "cellSelection", "description": "Gets/Sets cell selection mode.", "attribute": "cell-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "cellMergeMode", "description": "Gets/Sets cell merge mode.", "attribute": "cell-merge-mode", "type": { "text": "GridCellMergeMode" } }, { "kind": "field", "privacy": "public", "name": "rowSelection", "description": "Gets/Sets row selection mode", "attribute": "row-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "columnSelection", "description": "Gets/Sets column selection mode", "attribute": "column-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state].", "attribute": "expansion-states", "type": { "text": "Map" } }, { "kind": "field", "privacy": "public", "name": "defaultRowHeight", "description": "Gets the default row height.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columns", "description": "Gets an array of `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedRows", "description": "Gets an array of the pinned `IgxRowComponent`s.", "readonly": true, "type": { "text": "IgcGridRowComponent[]" } }, { "kind": "field", "privacy": "public", "name": "totalRecords", "description": "Returns the total number of records.", "attribute": "total-records", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it", "attribute": "select-row-on-click", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "isRecordPinnedByIndex", "description": "Returns whether the record is pinned or not.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleColumnVisibility", "description": "Toggles the specified column's visibility.", "parameters": [ { "name": "args", "type": { "text": "IgcColumnVisibilityChangedEventArgs" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandAll", "description": "Expands all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseAll", "description": "Collapses all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandRow", "description": "Expands the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseRow", "description": "Collapses the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleRow", "description": "Toggles the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getHeaderGroupWidth", "description": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "string" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByName", "description": "Returns the `IgxColumnComponent` by field name.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByVisibleIndex", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "recalculateAutoSizes", "description": "Recalculates all widths of columns that have size set to `auto`.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveColumn", "description": "Places a column before or after the specified target column.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "target", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "pos", "type": { "text": "DropPosition" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "markForCheck", "description": "Triggers change detection for the `IgxGridComponent`. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "addRow", "description": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", "parameters": [ { "name": "data", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deleteRow", "description": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "updateCell", "description": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "column", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "updateRow", "description": "Updates the `IgxGridRowComponent`", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getRowData", "description": "Returns the data that is contained in the row component.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "sort", "description": "Sort a single `IgxColumnComponent`.", "parameters": [ { "name": "expression", "type": { "text": "IgcSortingExpression[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filter", "description": "Filters a single `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false }, { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "conditionOrExpressionTree", "type": { "text": "IgcFilteringExpressionsTree | IgcFilteringOperation" }, "optional": true }, { "name": "ignoreCase", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filterGlobal", "description": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", "deprecated": "", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "condition", "type": { "text": "any" }, "optional": false }, { "name": "ignoreCase", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "enableSummaries", "description": "Enables summaries for the specified column and applies your customSummary.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "disableSummaries", "description": "Disable summaries for the specified column.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearFilter", "description": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearSort", "description": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "pinColumn", "description": "Pins a column by field name.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinColumn", "description": "Unpins a column by field name. Returns whether the operation is successful.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "description": "Pin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "description": "Unpin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "findNext", "description": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "findPrev", "description": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "refreshSearch", "description": "Reapplies the existing search.", "parameters": [ { "name": "updateActiveInfo", "type": { "text": "boolean" }, "optional": true }, { "name": "endEdit", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "clearSearch", "description": "Removes all the highlights in the cell.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedStartWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedEndWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRows", "description": "Select specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectRows", "description": "Deselect specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllRows", "description": "Selects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllRows", "description": "Deselects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearCellSelection", "description": "Deselect selected cells.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRange", "description": "Select range(s) of cells between certain rows and columns of the grid.", "parameters": [ { "name": "arg", "type": { "text": "IgcGridSelectionRange[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedRanges", "description": "Get the currently selected ranges in the grid.", "parameters": [], "return": { "type": { "text": "IgcGridSelectionRange[]" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectedColumns", "description": "Get current selected columns.", "parameters": [], "return": { "type": { "text": "IgcColumnComponent[]" } } }, { "kind": "method", "privacy": "public", "name": "selectColumns", "description": "Select specified columns.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectColumns", "description": "Deselect specified columns by field.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllColumns", "description": "Deselects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllColumns", "description": "Selects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedColumnsData", "description": "Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "navigateTo", "description": "Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "visibleColIndex", "type": { "text": "number" }, "optional": true }, { "name": "cb", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getNextCell", "description": "Returns `ICellPosition` which defines the next cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "getPreviousCell", "description": "Returns `ICellPosition` which defines the previous cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "openAdvancedFilteringDialog", "description": "Opens the advanced filtering dialog.", "parameters": [ { "name": "overlaySettings", "type": { "text": "IgcOverlaySettings" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "closeAdvancedFilteringDialog", "description": "Closes the advanced filtering dialog.", "parameters": [ { "name": "applyChanges", "type": { "text": "boolean" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "endEdit", "description": "Finishes the row transactions on the current row and returns whether the grid editing was canceled.", "parameters": [ { "name": "commit", "type": { "text": "boolean" }, "optional": true }, { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowById", "description": "Enters add mode by spawning the UI under the specified row by rowID.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "asChild", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowByIndex", "description": "Enters add mode by spawning the UI at the specified index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "child-data-key", "type": { "text": "string" }, "fieldName": "childDataKey", "description": "Sets the key of the row island by which child data would be taken from the row data if such is provided." }, { "name": "resource-strings", "type": { "text": "IgcGridResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." }, { "name": "child-layout-list", "type": { "text": "IgcRowIslandComponent[]" }, "fieldName": "childLayoutList" }, { "name": "action-strip-components", "type": { "text": "IgcActionStripToken[]" }, "fieldName": "actionStripComponents" }, { "name": "expand-children", "type": { "text": "boolean" }, "fieldName": "expandChildren", "description": "Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed." }, { "name": "has-children-key", "type": { "text": "string" }, "fieldName": "hasChildrenKey", "description": "Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator." }, { "name": "show-expand-all", "type": { "text": "boolean" }, "fieldName": "showExpandAll", "description": "Gets/Sets whether the expand/collapse all button in the header should be rendered." }, { "name": "batch-editing", "type": { "text": "boolean" }, "fieldName": "batchEditing" }, { "name": "snackbar-display-time", "type": { "text": "number" }, "fieldName": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification." }, { "name": "auto-generate", "type": { "text": "boolean" }, "fieldName": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns." }, { "name": "auto-generate-exclude", "type": { "text": "string[]" }, "fieldName": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection" }, { "name": "moving", "type": { "text": "boolean" }, "fieldName": "moving", "description": "Controls whether columns moving is enabled in the grid." }, { "name": "summary-row-height", "type": { "text": "number" }, "fieldName": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height" }, { "name": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" }, "fieldName": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode." }, { "name": "clipboard-options", "type": { "text": "IgcClipboardOptions" }, "fieldName": "clipboardOptions", "description": "Controls the copy behavior of the grid." }, { "name": "row-classes", "type": { "text": "any" }, "fieldName": "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:" }, { "name": "row-styles", "type": { "text": "any" }, "fieldName": "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." }, { "name": "primary-key", "type": { "text": "string" }, "fieldName": "primaryKey", "description": "Gets/Sets the primary key." }, { "name": "column-list", "type": { "text": "IgcColumnComponent[]" }, "fieldName": "columnList" }, { "name": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" }, "fieldName": "toolbar" }, { "name": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" }, "fieldName": "paginationComponents" }, { "name": "filtering-logic", "type": { "text": "FilteringLogic" }, "fieldName": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`." }, { "name": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "filteringExpressionsTree", "description": "Gets/Sets the filtering state." }, { "name": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state." }, { "name": "locale", "type": { "text": "string" }, "fieldName": "locale", "description": "Gets/Sets the locale." }, { "name": "paging-mode", "type": { "text": "GridPagingMode" }, "fieldName": "pagingMode" }, { "name": "hide-row-selectors", "type": { "text": "boolean" }, "fieldName": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden." }, { "name": "row-draggable", "type": { "text": "boolean" }, "fieldName": "rowDraggable", "description": "Gets/Sets whether rows can be moved." }, { "name": "validation-trigger", "type": { "text": "GridValidationTrigger" }, "fieldName": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid." }, { "name": "row-editable", "type": { "text": "boolean" }, "fieldName": "rowEditable", "description": "Gets/Sets whether the rows are editable." }, { "name": "height", "type": { "text": "string" }, "fieldName": "height", "description": "Gets/Sets the height." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets/Sets the width of the grid." }, { "name": "row-height", "type": { "text": "number" }, "fieldName": "rowHeight", "description": "Gets/Sets the row height." }, { "name": "column-width", "type": { "text": "string" }, "fieldName": "columnWidth", "description": "Gets/Sets the default width of the columns." }, { "name": "empty-grid-message", "type": { "text": "string" }, "fieldName": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records." }, { "name": "is-loading", "type": { "text": "boolean" }, "fieldName": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator." }, { "name": "should-generate", "type": { "text": "boolean" }, "fieldName": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead." }, { "name": "empty-filtered-grid-message", "type": { "text": "string" }, "fieldName": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered." }, { "name": "pinning", "type": { "text": "IgcPinningConfig" }, "fieldName": "pinning", "description": "Gets/Sets the initial pinning configuration." }, { "name": "allow-filtering", "type": { "text": "boolean" }, "fieldName": "allowFiltering", "description": "Gets/Sets if the filtering is enabled." }, { "name": "allow-advanced-filtering", "type": { "text": "boolean" }, "fieldName": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled." }, { "name": "filter-mode", "type": { "text": "FilterMode" }, "fieldName": "filterMode", "description": "Gets/Sets the filter mode." }, { "name": "summary-position", "type": { "text": "GridSummaryPosition" }, "fieldName": "summaryPosition", "description": "Gets/Sets the summary position." }, { "name": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" }, "fieldName": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode." }, { "name": "show-summary-on-collapse", "type": { "text": "boolean" }, "fieldName": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed." }, { "name": "filter-strategy", "type": { "text": "IgcFilteringStrategy" }, "fieldName": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid." }, { "name": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid." }, { "name": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" }, "fieldName": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid." }, { "name": "sorting-options", "type": { "text": "IgcSortingOptions" }, "fieldName": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties." }, { "name": "selected-rows", "type": { "text": "any[]" }, "fieldName": "selectedRows", "description": "Gets/Sets the current selection state." }, { "name": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" }, "fieldName": "sortingExpressions", "description": "Gets/Sets the sorting state." }, { "name": "cell-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "cellSelection", "description": "Gets/Sets cell selection mode." }, { "name": "cell-merge-mode", "type": { "text": "GridCellMergeMode" }, "fieldName": "cellMergeMode", "description": "Gets/Sets cell merge mode." }, { "name": "row-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "rowSelection", "description": "Gets/Sets row selection mode" }, { "name": "column-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "columnSelection", "description": "Gets/Sets column selection mode" }, { "name": "expansion-states", "type": { "text": "Map" }, "fieldName": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state]." }, { "name": "total-records", "type": { "text": "number" }, "fieldName": "totalRecords", "description": "Returns the total number of records." }, { "name": "select-row-on-click", "type": { "text": "boolean" }, "fieldName": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it" } ], "events": [ { "name": "gridCreated", "description": "Event emitted when a grid is being created based on this row island.", "type": { "text": "CustomEvent" } }, { "name": "gridInitialized", "description": "Emitted after a grid is being initialized for this row island. The emitting is done in `ngAfterViewInit`.", "type": { "text": "CustomEvent" } }, { "name": "dataPreLoad", "description": "Emitted when a new chunk of data is loaded from virtualization.", "type": { "text": "CustomEvent" } }, { "name": "filteringExpressionsTreeChange", "description": "Emitted after filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "advancedFilteringExpressionsTreeChange", "description": "Emitted after advanced filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "gridScroll", "description": "Emitted when grid is scrolled horizontally/vertically.", "type": { "text": "CustomEvent" } }, { "name": "cellClick", "description": "Emitted when a cell is clicked.", "type": { "text": "CustomEvent" } }, { "name": "rowClick", "description": "Emitted when a row is clicked.", "type": { "text": "CustomEvent" } }, { "name": "formGroupCreated", "description": "Emitted when formGroup is created on edit of row/cell.", "type": { "text": "CustomEvent" } }, { "name": "validationStatusChange", "description": "Emitted when grid's validation status changes.", "type": { "text": "CustomEvent" } }, { "name": "selected", "description": "Emitted when a cell is selected.", "type": { "text": "CustomEvent" } }, { "name": "rowSelectionChanging", "description": "Emitted when `IgxGridRowComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnSelectionChanging", "description": "Emitted when `IgxColumnComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnPin", "description": "Emitted before `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "columnPinned", "description": "Emitted after `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "cellEditEnter", "description": "Emitted when cell enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEditExit", "description": "Emitted when cell exits edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEdit", "description": "Emitted when cell has been edited.", "type": { "text": "CustomEvent" } }, { "name": "cellEditDone", "description": "Emitted after cell has been edited and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditEnter", "description": "Emitted when a row enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "rowEdit", "description": "Emitted when exiting edit mode for a row.", "type": { "text": "CustomEvent" } }, { "name": "rowEditDone", "description": "Emitted after exiting edit mode for a row and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditExit", "description": "Emitted when row editing is canceled.", "type": { "text": "CustomEvent" } }, { "name": "columnInit", "description": "Emitted when a column is initialized.", "type": { "text": "CustomEvent" } }, { "name": "columnsAutogenerated", "description": "", "type": { "text": "CustomEvent" } }, { "name": "sorting", "description": "Emitted before sorting expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "sortingDone", "description": "Emitted after sorting is completed.", "type": { "text": "CustomEvent" } }, { "name": "filtering", "description": "Emitted before filtering expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "filteringDone", "description": "Emitted after filtering is performed through the UI.", "type": { "text": "CustomEvent" } }, { "name": "rowAdded", "description": "Emitted when a row is added.", "type": { "text": "CustomEvent" } }, { "name": "rowDeleted", "description": "Emitted when a row is deleted.", "type": { "text": "CustomEvent" } }, { "name": "rowDelete", "description": "Emmited when deleting a row.", "type": { "text": "CustomEvent" } }, { "name": "rowAdd", "description": "Emmited just before the newly added row is commited.", "type": { "text": "CustomEvent" } }, { "name": "columnResized", "description": "Emitted after column is resized.", "type": { "text": "CustomEvent" } }, { "name": "contextMenu", "description": "Emitted when a cell or row is right clicked.", "type": { "text": "CustomEvent" } }, { "name": "doubleClick", "description": "Emitted when a cell is double clicked.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanging", "description": "Emitted before column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanged", "description": "Emitted after column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingStart", "description": "Emitted when column moving starts.", "type": { "text": "CustomEvent" } }, { "name": "columnMoving", "description": "Emitted during the column moving operation.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingEnd", "description": "Emitted when column moving ends.", "type": { "text": "CustomEvent" } }, { "name": "gridKeydown", "description": "Emitted when keydown is triggered over element inside grid's body.", "type": { "text": "CustomEvent" } }, { "name": "rowDragStart", "description": "Emitted when start dragging a row.", "type": { "text": "CustomEvent" } }, { "name": "rowDragEnd", "description": "Emitted when dropping a row.", "type": { "text": "CustomEvent" } }, { "name": "gridCopy", "description": "Emitted when a copy operation is executed.", "type": { "text": "CustomEvent" } }, { "name": "expansionStatesChange", "description": "Emitted when the rows are expanded or collapsed.", "type": { "text": "CustomEvent>" } }, { "name": "selectedRowsChange", "description": "Emitted when the rows are selected or deselected.", "type": { "text": "CustomEvent" } }, { "name": "rowToggle", "description": "Emitted when the expanded state of a row gets changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinning", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinned", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "activeNodeChange", "description": "Emitted when the active node is changed.", "type": { "text": "CustomEvent" } }, { "name": "sortingExpressionsChange", "description": "Emitted before sorting is performed.", "type": { "text": "CustomEvent" } }, { "name": "toolbarExporting", "description": "Emitted when an export process is initiated by the user.", "type": { "text": "CustomEvent" } }, { "name": "rangeSelected", "description": "Emitted when making a range selection.", "type": { "text": "CustomEvent" } }, { "name": "rendered", "description": "Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM", "type": { "text": "CustomEvent" } }, { "name": "dataChanging", "description": "Emitted before the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } }, { "name": "dataChanged", "description": "Emitted after the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-row-island", "customElement": true }, { "kind": "class", "name": "IgcPivotDataSelectorComponent", "description": "Pivot Data Selector provides means to configure the pivot state of the Pivot Grid via a vertical panel UI", "members": [ { "kind": "field", "privacy": "public", "name": "columnsExpanded", "description": "Gets/sets whether the columns panel is expanded Get", "attribute": "columns-expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rowsExpanded", "description": "Gets/sets whether the rows panel is expanded Get", "attribute": "rows-expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filtersExpanded", "description": "Gets/sets whether the filters panel is expanded Get", "attribute": "filters-expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "valuesExpanded", "description": "Gets/sets whether the values panel is expanded Get", "attribute": "values-expanded", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "grid", "description": "Sets the grid.", "attribute": "grid", "type": { "text": "IgcPivotGridComponent" } } ], "attributes": [ { "name": "columns-expanded", "type": { "text": "boolean" }, "fieldName": "columnsExpanded", "description": "Gets/sets whether the columns panel is expanded Get" }, { "name": "rows-expanded", "type": { "text": "boolean" }, "fieldName": "rowsExpanded", "description": "Gets/sets whether the rows panel is expanded Get" }, { "name": "filters-expanded", "type": { "text": "boolean" }, "fieldName": "filtersExpanded", "description": "Gets/sets whether the filters panel is expanded Get" }, { "name": "values-expanded", "type": { "text": "boolean" }, "fieldName": "valuesExpanded", "description": "Gets/sets whether the values panel is expanded Get" }, { "name": "grid", "type": { "text": "IgcPivotGridComponent" }, "fieldName": "grid", "description": "Sets the grid." } ], "events": [ { "name": "columnsExpandedChange", "description": "Emitted when the columns panel is expanded or collapsed.", "type": { "text": "CustomEvent" } }, { "name": "rowsExpandedChange", "description": "Emitted when the rows panel is expanded or collapsed.", "type": { "text": "CustomEvent" } }, { "name": "filtersExpandedChange", "description": "Emitted when the filters panel is expanded or collapsed.", "type": { "text": "CustomEvent" } }, { "name": "valuesExpandedChange", "description": "Emitted when the values panel is expanded or collapsed.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-pivot-data-selector", "customElement": true }, { "kind": "class", "name": "IgcPivotGridComponent", "description": "Pivot Grid provides a way to present and manipulate data in a pivot table view.", "members": [ { "kind": "field", "privacy": "public", "name": "dimensionsSortingExpressions", "description": "Gets the sorting expressions generated for the dimensions.", "readonly": true, "type": { "text": "IgcSortingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "valueChipTemplate", "description": "Gets/Sets a custom template for the value chips.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowDimensionHeaderTemplate", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "pivotConfiguration", "description": "Gets/Sets the pivot configuration with all related dimensions and values.", "attribute": "pivot-configuration", "type": { "text": "IgcPivotConfiguration" } }, { "kind": "field", "privacy": "public", "name": "autoGenerateConfig", "description": "Gets/Sets whether to auto-generate the pivot configuration based on the provided data.", "attribute": "auto-generate-config", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "pivotUI", "attribute": "pivot-ui", "type": { "text": "IgcPivotUISettings" } }, { "kind": "field", "privacy": "public", "name": "superCompactMode", "description": "Enables a super compact theme for the component.", "attribute": "super-compact-mode", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "defaultExpandState", "description": "Gets/Sets the default expand state for all rows.", "attribute": "default-expand-state", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selectedRows", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "allDimensions", "description": "Gets the full list of dimensions.", "readonly": true, "type": { "text": "IgcPivotDimension[]" } }, { "kind": "field", "privacy": "public", "name": "data", "description": "Gets/Sets the array of data that populates the component.", "attribute": "data", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "emptyPivotGridTemplate", "description": "Gets/Sets a custom template when pivot grid is empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification.", "attribute": "snackbar-display-time", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns.", "attribute": "auto-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection", "attribute": "auto-generate-exclude", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "moving", "description": "Controls whether columns moving is enabled in the grid.", "attribute": "moving", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyGridTemplate", "description": "Gets/Sets a custom template when empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "addRowEmptyTemplate", "description": "Gets/Sets a custom template for adding row UI when grid is empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "loadingGridTemplate", "description": "Gets/Sets a custom template when loading.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height", "attribute": "summary-row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode.", "attribute": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" } }, { "kind": "field", "privacy": "public", "name": "clipboardOptions", "description": "Controls the copy behavior of the grid.", "attribute": "clipboard-options", "type": { "text": "IgcClipboardOptions" } }, { "kind": "field", "privacy": "public", "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:", "attribute": "row-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "row-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "primaryKey", "description": "Gets/Sets the primary key.", "attribute": "primary-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "columnList", "attribute": "column-list", "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "actionStripComponents", "attribute": "action-strip-components", "type": { "text": "IgcActionStripToken[]" } }, { "kind": "field", "privacy": "public", "name": "dragGhostCustomTemplate", "description": "Gets the custom template, if any, used for row drag ghost.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditTextTemplate", "description": "Gets the row edit text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowAddTextTemplate", "description": "Gets the row add text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditActionsTemplate", "description": "Gets the row edit actions template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowExpandedIndicatorTemplate", "description": "Gets the row expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerExpandedIndicatorTemplate", "description": "Gets the header expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "excelStyleHeaderIconTemplate", "description": "Gets the excel style header icon.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortHeaderIconTemplate", "description": "Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "toolbar", "attribute": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" } }, { "kind": "field", "privacy": "public", "name": "paginationComponents", "attribute": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcGridResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`.", "attribute": "filtering-logic", "type": { "text": "FilteringLogic" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Gets/Sets the filtering state.", "attribute": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state.", "attribute": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "locale", "description": "Gets/Sets the locale.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pagingMode", "attribute": "paging-mode", "type": { "text": "GridPagingMode" } }, { "kind": "field", "privacy": "public", "name": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden.", "attribute": "hide-row-selectors", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rowDraggable", "description": "Gets/Sets whether rows can be moved.", "attribute": "row-draggable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid.", "attribute": "validation-trigger", "type": { "text": "GridValidationTrigger" } }, { "kind": "field", "privacy": "public", "name": "rowEditable", "description": "Gets/Sets whether the rows are editable.", "attribute": "row-editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "height", "description": "Gets/Sets the height.", "attribute": "height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets/Sets the width of the grid.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "rowHeight", "description": "Gets/Sets the row height.", "attribute": "row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnWidth", "description": "Gets/Sets the default width of the columns.", "attribute": "column-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records.", "attribute": "empty-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator.", "attribute": "is-loading", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead.", "attribute": "should-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered.", "attribute": "empty-filtered-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pinning", "description": "Gets/Sets the initial pinning configuration.", "attribute": "pinning", "type": { "text": "IgcPinningConfig" } }, { "kind": "field", "privacy": "public", "name": "allowFiltering", "description": "Gets/Sets if the filtering is enabled.", "attribute": "allow-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled.", "attribute": "allow-advanced-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterMode", "description": "Gets/Sets the filter mode.", "attribute": "filter-mode", "type": { "text": "FilterMode" } }, { "kind": "field", "privacy": "public", "name": "summaryPosition", "description": "Gets/Sets the summary position.", "attribute": "summary-position", "type": { "text": "GridSummaryPosition" } }, { "kind": "field", "privacy": "public", "name": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode.", "attribute": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" } }, { "kind": "field", "privacy": "public", "name": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed.", "attribute": "show-summary-on-collapse", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid.", "attribute": "filter-strategy", "type": { "text": "IgcFilteringStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid.", "attribute": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid.", "attribute": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties.", "attribute": "sorting-options", "type": { "text": "IgcSortingOptions" } }, { "kind": "field", "privacy": "public", "name": "selectedRows", "description": "Gets/Sets the current selection state.", "attribute": "selected-rows", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "rowList", "description": "A list of `IgxGridRowComponent`.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "dataRowList", "description": "A list of currently rendered `IgxGridRowComponent`'s.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "headSelectorTemplate", "description": "Gets the header row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowSelectorTemplate", "description": "Gets the row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "dragIndicatorIconTemplate", "description": "The custom template, if any, that should be used when rendering the row drag indicator icon", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortingExpressions", "description": "Gets/Sets the sorting state.", "attribute": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "hiddenColumnsCount", "description": "Gets the number of hidden columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumnsCount", "description": "Gets the number of pinned columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "batch-editing", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "cellSelection", "description": "Gets/Sets cell selection mode.", "attribute": "cell-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "cellMergeMode", "description": "Gets/Sets cell merge mode.", "attribute": "cell-merge-mode", "type": { "text": "GridCellMergeMode" } }, { "kind": "field", "privacy": "public", "name": "rowSelection", "description": "Gets/Sets row selection mode", "attribute": "row-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "columnSelection", "description": "Gets/Sets column selection mode", "attribute": "column-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "lastSearchInfo", "description": "Represents the last search information.", "readonly": true, "type": { "text": "IgcSearchInfo" } }, { "kind": "field", "privacy": "public", "name": "filteredData", "description": "Returns an array of objects containing the filtered data.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteredSortedData", "description": "Returns an array containing the filtered sorted data.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "virtualizationState", "description": "Returns the state of the grid virtualization.", "readonly": true, "type": { "text": "IgcForOfState" } }, { "kind": "field", "privacy": "public", "name": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state].", "attribute": "expansion-states", "type": { "text": "Map" } }, { "kind": "field", "privacy": "public", "name": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to.", "attribute": "outlet", "type": { "text": "IgcOverlayOutletDirective" } }, { "kind": "field", "privacy": "public", "name": "defaultRowHeight", "description": "Gets the default row height.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columns", "description": "Gets an array of `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumns", "description": "Gets an array of the pinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedStartColumns", "description": "Gets an array of the pinned to the left `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedEndColumns", "description": "Gets an array of the pinned to the right `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedRows", "description": "Gets an array of the pinned `IgxRowComponent`s.", "readonly": true, "type": { "text": "IgcGridRowComponent[]" } }, { "kind": "field", "privacy": "public", "name": "unpinnedColumns", "description": "Gets an array of unpinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "visibleColumns", "description": "Returns an array of visible `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "totalRecords", "description": "Returns the total number of records.", "attribute": "total-records", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataView", "description": "Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it", "attribute": "select-row-on-click", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "notifyDimensionChange", "description": "Notifies for dimension change.", "parameters": [ { "name": "regenerateColumns", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleColumn", "parameters": [ { "name": "col", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getColumnGroupExpandState", "parameters": [ { "name": "col", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleRowGroup", "parameters": [ { "name": "col", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "newState", "type": { "text": "boolean" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "autoSizeRowDimension", "description": "Auto-sizes row dimension cells.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "insertDimensionAt", "description": "Inserts dimension in target collection by type at specified index or at the collection's end.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false }, { "name": "targetCollectionType", "type": { "text": "PivotDimensionType" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveDimension", "description": "Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false }, { "name": "targetCollectionType", "type": { "text": "PivotDimensionType" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "removeDimension", "description": "Removes dimension from its currently collection.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleDimension", "description": "Toggles the dimension's enabled state on or off.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "insertValueAt", "description": "Inserts value at specified index or at the end.", "parameters": [ { "name": "value", "type": { "text": "IgcPivotValue" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveValue", "description": "Move value from its currently at specified index or at the end.", "parameters": [ { "name": "value", "type": { "text": "IgcPivotValue" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "removeValue", "description": "Removes value from collection.", "parameters": [ { "name": "value", "type": { "text": "IgcPivotValue" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleValue", "description": "Toggles the value's enabled state on or off.", "parameters": [ { "name": "value", "type": { "text": "IgcPivotValue" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "sortDimension", "description": "Sort the dimension and its children in the provided direction.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false }, { "name": "sortDirection", "type": { "text": "SortingDirection" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filterDimension", "description": "Filters a single `IPivotDimension`.", "parameters": [ { "name": "dimension", "type": { "text": "IgcPivotDimension" }, "optional": false }, { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "conditionOrExpressionTree", "type": { "text": "IgcFilteringExpressionsTree | IgcFilteringOperation" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "isRecordPinnedByIndex", "description": "Returns whether the record is pinned or not.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleColumnVisibility", "description": "Toggles the specified column's visibility.", "parameters": [ { "name": "args", "type": { "text": "IgcColumnVisibilityChangedEventArgs" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandAll", "description": "Expands all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseAll", "description": "Collapses all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandRow", "description": "Expands the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseRow", "description": "Collapses the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleRow", "description": "Toggles the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getHeaderGroupWidth", "description": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "string" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByName", "description": "Returns the `IgxColumnComponent` by field name.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByVisibleIndex", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "recalculateAutoSizes", "description": "Recalculates all widths of columns that have size set to `auto`.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveColumn", "description": "Places a column before or after the specified target column.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "target", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "pos", "type": { "text": "DropPosition" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "markForCheck", "description": "Triggers change detection for the `IgxGridComponent`. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "addRow", "description": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", "parameters": [ { "name": "data", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deleteRow", "description": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "updateCell", "description": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "column", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "updateRow", "description": "Updates the `IgxGridRowComponent`", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getRowData", "description": "Returns the data that is contained in the row component.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "sort", "description": "Sort a single `IgxColumnComponent`.", "parameters": [ { "name": "expression", "type": { "text": "IgcSortingExpression[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filter", "description": "Filters a single `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false }, { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "conditionOrExpressionTree", "type": { "text": "IgcFilteringExpressionsTree | IgcFilteringOperation" }, "optional": true }, { "name": "ignoreCase", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filterGlobal", "description": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", "deprecated": "", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "condition", "type": { "text": "any" }, "optional": false }, { "name": "ignoreCase", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "enableSummaries", "description": "Enables summaries for the specified column and applies your customSummary.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "disableSummaries", "description": "Disable summaries for the specified column.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearFilter", "description": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearSort", "description": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "pinColumn", "description": "Pins a column by field name.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinColumn", "description": "Unpins a column by field name. Returns whether the operation is successful.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "description": "Pin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "description": "Unpin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "reflow", "description": "Recalculates grid width/height dimensions.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "findNext", "description": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "findPrev", "description": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "refreshSearch", "description": "Reapplies the existing search.", "parameters": [ { "name": "updateActiveInfo", "type": { "text": "boolean" }, "optional": true }, { "name": "endEdit", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "clearSearch", "description": "Removes all the highlights in the cell.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedStartWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedEndWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRows", "description": "Select specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectRows", "description": "Deselect specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllRows", "description": "Selects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllRows", "description": "Deselects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearCellSelection", "description": "Deselect selected cells.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRange", "description": "Select range(s) of cells between certain rows and columns of the grid.", "parameters": [ { "name": "arg", "type": { "text": "IgcGridSelectionRange[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedRanges", "description": "Get the currently selected ranges in the grid.", "parameters": [], "return": { "type": { "text": "IgcGridSelectionRange[]" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectedColumns", "description": "Get current selected columns.", "parameters": [], "return": { "type": { "text": "IgcColumnComponent[]" } } }, { "kind": "method", "privacy": "public", "name": "selectColumns", "description": "Select specified columns.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectColumns", "description": "Deselect specified columns by field.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllColumns", "description": "Deselects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllColumns", "description": "Selects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedColumnsData", "description": "Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "navigateTo", "description": "Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "visibleColIndex", "type": { "text": "number" }, "optional": true }, { "name": "cb", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getNextCell", "description": "Returns `ICellPosition` which defines the next cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "getPreviousCell", "description": "Returns `ICellPosition` which defines the previous cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "openAdvancedFilteringDialog", "description": "Opens the advanced filtering dialog.", "parameters": [ { "name": "overlaySettings", "type": { "text": "IgcOverlaySettings" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "closeAdvancedFilteringDialog", "description": "Closes the advanced filtering dialog.", "parameters": [ { "name": "applyChanges", "type": { "text": "boolean" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "endEdit", "description": "Finishes the row transactions on the current row and returns whether the grid editing was canceled.", "parameters": [ { "name": "commit", "type": { "text": "boolean" }, "optional": true }, { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowById", "description": "Enters add mode by spawning the UI under the specified row by rowID.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "asChild", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowByIndex", "description": "Enters add mode by spawning the UI at the specified index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "pivot-configuration", "type": { "text": "IgcPivotConfiguration" }, "fieldName": "pivotConfiguration", "description": "Gets/Sets the pivot configuration with all related dimensions and values." }, { "name": "auto-generate-config", "type": { "text": "boolean" }, "fieldName": "autoGenerateConfig", "description": "Gets/Sets whether to auto-generate the pivot configuration based on the provided data." }, { "name": "pivot-ui", "type": { "text": "IgcPivotUISettings" }, "fieldName": "pivotUI" }, { "name": "super-compact-mode", "type": { "text": "boolean" }, "fieldName": "superCompactMode", "description": "Enables a super compact theme for the component." }, { "name": "default-expand-state", "type": { "text": "boolean" }, "fieldName": "defaultExpandState", "description": "Gets/Sets the default expand state for all rows." }, { "name": "data", "type": { "text": "any[]" }, "fieldName": "data", "description": "Gets/Sets the array of data that populates the component." }, { "name": "snackbar-display-time", "type": { "text": "number" }, "fieldName": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification." }, { "name": "auto-generate", "type": { "text": "boolean" }, "fieldName": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns." }, { "name": "auto-generate-exclude", "type": { "text": "string[]" }, "fieldName": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection" }, { "name": "moving", "type": { "text": "boolean" }, "fieldName": "moving", "description": "Controls whether columns moving is enabled in the grid." }, { "name": "summary-row-height", "type": { "text": "number" }, "fieldName": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height" }, { "name": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" }, "fieldName": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode." }, { "name": "clipboard-options", "type": { "text": "IgcClipboardOptions" }, "fieldName": "clipboardOptions", "description": "Controls the copy behavior of the grid." }, { "name": "row-classes", "type": { "text": "any" }, "fieldName": "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:" }, { "name": "row-styles", "type": { "text": "any" }, "fieldName": "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." }, { "name": "primary-key", "type": { "text": "string" }, "fieldName": "primaryKey", "description": "Gets/Sets the primary key." }, { "name": "column-list", "type": { "text": "IgcColumnComponent[]" }, "fieldName": "columnList" }, { "name": "action-strip-components", "type": { "text": "IgcActionStripToken[]" }, "fieldName": "actionStripComponents" }, { "name": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" }, "fieldName": "toolbar" }, { "name": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" }, "fieldName": "paginationComponents" }, { "name": "resource-strings", "type": { "text": "IgcGridResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." }, { "name": "filtering-logic", "type": { "text": "FilteringLogic" }, "fieldName": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`." }, { "name": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "filteringExpressionsTree", "description": "Gets/Sets the filtering state." }, { "name": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state." }, { "name": "locale", "type": { "text": "string" }, "fieldName": "locale", "description": "Gets/Sets the locale." }, { "name": "paging-mode", "type": { "text": "GridPagingMode" }, "fieldName": "pagingMode" }, { "name": "hide-row-selectors", "type": { "text": "boolean" }, "fieldName": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden." }, { "name": "row-draggable", "type": { "text": "boolean" }, "fieldName": "rowDraggable", "description": "Gets/Sets whether rows can be moved." }, { "name": "validation-trigger", "type": { "text": "GridValidationTrigger" }, "fieldName": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid." }, { "name": "row-editable", "type": { "text": "boolean" }, "fieldName": "rowEditable", "description": "Gets/Sets whether the rows are editable." }, { "name": "height", "type": { "text": "string" }, "fieldName": "height", "description": "Gets/Sets the height." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets/Sets the width of the grid." }, { "name": "row-height", "type": { "text": "number" }, "fieldName": "rowHeight", "description": "Gets/Sets the row height." }, { "name": "column-width", "type": { "text": "string" }, "fieldName": "columnWidth", "description": "Gets/Sets the default width of the columns." }, { "name": "empty-grid-message", "type": { "text": "string" }, "fieldName": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records." }, { "name": "is-loading", "type": { "text": "boolean" }, "fieldName": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator." }, { "name": "should-generate", "type": { "text": "boolean" }, "fieldName": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead." }, { "name": "empty-filtered-grid-message", "type": { "text": "string" }, "fieldName": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered." }, { "name": "pinning", "type": { "text": "IgcPinningConfig" }, "fieldName": "pinning", "description": "Gets/Sets the initial pinning configuration." }, { "name": "allow-filtering", "type": { "text": "boolean" }, "fieldName": "allowFiltering", "description": "Gets/Sets if the filtering is enabled." }, { "name": "allow-advanced-filtering", "type": { "text": "boolean" }, "fieldName": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled." }, { "name": "filter-mode", "type": { "text": "FilterMode" }, "fieldName": "filterMode", "description": "Gets/Sets the filter mode." }, { "name": "summary-position", "type": { "text": "GridSummaryPosition" }, "fieldName": "summaryPosition", "description": "Gets/Sets the summary position." }, { "name": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" }, "fieldName": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode." }, { "name": "show-summary-on-collapse", "type": { "text": "boolean" }, "fieldName": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed." }, { "name": "filter-strategy", "type": { "text": "IgcFilteringStrategy" }, "fieldName": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid." }, { "name": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid." }, { "name": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" }, "fieldName": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid." }, { "name": "sorting-options", "type": { "text": "IgcSortingOptions" }, "fieldName": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties." }, { "name": "selected-rows", "type": { "text": "any[]" }, "fieldName": "selectedRows", "description": "Gets/Sets the current selection state." }, { "name": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" }, "fieldName": "sortingExpressions", "description": "Gets/Sets the sorting state." }, { "name": "batch-editing", "type": { "text": "boolean" }, "fieldName": "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." }, { "name": "cell-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "cellSelection", "description": "Gets/Sets cell selection mode." }, { "name": "cell-merge-mode", "type": { "text": "GridCellMergeMode" }, "fieldName": "cellMergeMode", "description": "Gets/Sets cell merge mode." }, { "name": "row-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "rowSelection", "description": "Gets/Sets row selection mode" }, { "name": "column-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "columnSelection", "description": "Gets/Sets column selection mode" }, { "name": "expansion-states", "type": { "text": "Map" }, "fieldName": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state]." }, { "name": "outlet", "type": { "text": "IgcOverlayOutletDirective" }, "fieldName": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to." }, { "name": "total-records", "type": { "text": "number" }, "fieldName": "totalRecords", "description": "Returns the total number of records." }, { "name": "select-row-on-click", "type": { "text": "boolean" }, "fieldName": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it" } ], "events": [ { "name": "dimensionsChange", "description": "Emitted when the dimension collection is changed via the grid chip area.", "type": { "text": "CustomEvent" } }, { "name": "pivotConfigurationChange", "description": "Emitted when any of the pivotConfiguration properties is changed via the grid chip area.", "type": { "text": "CustomEvent" } }, { "name": "dimensionInit", "description": "Emitted when the dimension is initialized.", "type": { "text": "CustomEvent" } }, { "name": "valueInit", "description": "Emitted when the value is initialized.", "type": { "text": "CustomEvent" } }, { "name": "dimensionsSortingExpressionsChange", "description": "Emitted when a dimension is sorted.", "type": { "text": "CustomEvent" } }, { "name": "valuesChange", "description": "Emitted when the values collection is changed via the grid chip area.", "type": { "text": "CustomEvent" } }, { "name": "filteringExpressionsTreeChange", "description": "Emitted after filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "advancedFilteringExpressionsTreeChange", "description": "Emitted after advanced filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "gridScroll", "description": "Emitted when grid is scrolled horizontally/vertically.", "type": { "text": "CustomEvent" } }, { "name": "cellClick", "description": "Emitted when a cell is clicked.", "type": { "text": "CustomEvent" } }, { "name": "rowClick", "description": "Emitted when a row is clicked.", "type": { "text": "CustomEvent" } }, { "name": "formGroupCreated", "description": "Emitted when formGroup is created on edit of row/cell.", "type": { "text": "CustomEvent" } }, { "name": "validationStatusChange", "description": "Emitted when grid's validation status changes.", "type": { "text": "CustomEvent" } }, { "name": "selected", "description": "Emitted when a cell is selected.", "type": { "text": "CustomEvent" } }, { "name": "rowSelectionChanging", "description": "Emitted when `IgxGridRowComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnSelectionChanging", "description": "Emitted when `IgxColumnComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnPin", "description": "Emitted before `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "columnPinned", "description": "Emitted after `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "cellEditEnter", "description": "Emitted when cell enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEditExit", "description": "Emitted when cell exits edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEdit", "description": "Emitted when cell has been edited.", "type": { "text": "CustomEvent" } }, { "name": "cellEditDone", "description": "Emitted after cell has been edited and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditEnter", "description": "Emitted when a row enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "rowEdit", "description": "Emitted when exiting edit mode for a row.", "type": { "text": "CustomEvent" } }, { "name": "rowEditDone", "description": "Emitted after exiting edit mode for a row and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditExit", "description": "Emitted when row editing is canceled.", "type": { "text": "CustomEvent" } }, { "name": "columnInit", "description": "Emitted when a column is initialized.", "type": { "text": "CustomEvent" } }, { "name": "columnsAutogenerated", "description": "", "type": { "text": "CustomEvent" } }, { "name": "sorting", "description": "Emitted before sorting expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "sortingDone", "description": "Emitted after sorting is completed.", "type": { "text": "CustomEvent" } }, { "name": "filtering", "description": "Emitted before filtering expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "filteringDone", "description": "Emitted after filtering is performed through the UI.", "type": { "text": "CustomEvent" } }, { "name": "rowAdded", "description": "Emitted when a row is added.", "type": { "text": "CustomEvent" } }, { "name": "rowDeleted", "description": "Emitted when a row is deleted.", "type": { "text": "CustomEvent" } }, { "name": "rowDelete", "description": "Emmited when deleting a row.", "type": { "text": "CustomEvent" } }, { "name": "rowAdd", "description": "Emmited just before the newly added row is commited.", "type": { "text": "CustomEvent" } }, { "name": "columnResized", "description": "Emitted after column is resized.", "type": { "text": "CustomEvent" } }, { "name": "contextMenu", "description": "Emitted when a cell or row is right clicked.", "type": { "text": "CustomEvent" } }, { "name": "doubleClick", "description": "Emitted when a cell is double clicked.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanging", "description": "Emitted before column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanged", "description": "Emitted after column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingStart", "description": "Emitted when column moving starts.", "type": { "text": "CustomEvent" } }, { "name": "columnMoving", "description": "Emitted during the column moving operation.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingEnd", "description": "Emitted when column moving ends.", "type": { "text": "CustomEvent" } }, { "name": "gridKeydown", "description": "Emitted when keydown is triggered over element inside grid's body.", "type": { "text": "CustomEvent" } }, { "name": "rowDragStart", "description": "Emitted when start dragging a row.", "type": { "text": "CustomEvent" } }, { "name": "rowDragEnd", "description": "Emitted when dropping a row.", "type": { "text": "CustomEvent" } }, { "name": "gridCopy", "description": "Emitted when a copy operation is executed.", "type": { "text": "CustomEvent" } }, { "name": "expansionStatesChange", "description": "Emitted when the rows are expanded or collapsed.", "type": { "text": "CustomEvent>" } }, { "name": "selectedRowsChange", "description": "Emitted when the rows are selected or deselected.", "type": { "text": "CustomEvent" } }, { "name": "rowToggle", "description": "Emitted when the expanded state of a row gets changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinning", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinned", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "activeNodeChange", "description": "Emitted when the active node is changed.", "type": { "text": "CustomEvent" } }, { "name": "sortingExpressionsChange", "description": "Emitted before sorting is performed.", "type": { "text": "CustomEvent" } }, { "name": "toolbarExporting", "description": "Emitted when an export process is initiated by the user.", "type": { "text": "CustomEvent" } }, { "name": "rangeSelected", "description": "Emitted when making a range selection.", "type": { "text": "CustomEvent" } }, { "name": "rendered", "description": "Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM", "type": { "text": "CustomEvent" } }, { "name": "dataChanging", "description": "Emitted before the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } }, { "name": "dataChanged", "description": "Emitted after the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-pivot-grid", "customElement": true }, { "kind": "class", "name": "IgcTreeGridComponent", "description": "**Ignite UI for Angular Tree Grid** - [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid) The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding. Example:", "members": [ { "kind": "field", "privacy": "public", "name": "childDataKey", "description": "Sets the child data key of the `IgxTreeGridComponent`.", "attribute": "child-data-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "foreignKey", "description": "Sets the foreign key of the `IgxTreeGridComponent`.", "attribute": "foreign-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "hasChildrenKey", "description": "Sets the key indicating whether a row has children. This property is only used for load on demand scenarios.", "attribute": "has-children-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "cascadeOnDelete", "description": "Sets whether child records should be deleted when their parent gets deleted. By default it is set to true and deletes all children along with the parent.", "attribute": "cascade-on-delete", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "loadChildrenOnDemand", "description": "Sets a callback for loading child rows on demand.", "attribute": "load-children-on-demand", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "id", "description": "Sets the value of the `id` attribute. If not provided it will be automatically generated.", "attribute": "id", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "rootRecords", "description": "Returns an array of the root level `ITreeGridRecord`s.", "attribute": "root-records", "type": { "text": "IgcTreeGridRecord[]" } }, { "kind": "field", "privacy": "public", "name": "processedRootRecords", "description": "Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s.", "attribute": "processed-root-records", "type": { "text": "IgcTreeGridRecord[]" } }, { "kind": "field", "privacy": "public", "name": "data", "description": "Gets/Sets the array of data that populates the component.", "attribute": "data", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "expansionDepth", "description": "Sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is set to `Infinity` which means all levels would be expanded.", "attribute": "expansion-depth", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "rowLoadingIndicatorTemplate", "description": "Template for the row loading indicator when load on demand is enabled.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "selectedCells", "description": "Returns an array of the selected `IgxGridCell`s.", "readonly": true, "type": { "text": "IgcCellType[]" } }, { "kind": "field", "privacy": "public", "name": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification.", "attribute": "snackbar-display-time", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns.", "attribute": "auto-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection", "attribute": "auto-generate-exclude", "type": { "text": "string[]" } }, { "kind": "field", "privacy": "public", "name": "moving", "description": "Controls whether columns moving is enabled in the grid.", "attribute": "moving", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyGridTemplate", "description": "Gets/Sets a custom template when empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "addRowEmptyTemplate", "description": "Gets/Sets a custom template for adding row UI when grid is empty.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "loadingGridTemplate", "description": "Gets/Sets a custom template when loading.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height", "attribute": "summary-row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode.", "attribute": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" } }, { "kind": "field", "privacy": "public", "name": "clipboardOptions", "description": "Controls the copy behavior of the grid.", "attribute": "clipboard-options", "type": { "text": "IgcClipboardOptions" } }, { "kind": "field", "privacy": "public", "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:", "attribute": "row-classes", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "row-styles", "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "primaryKey", "description": "Gets/Sets the primary key.", "attribute": "primary-key", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "columnList", "attribute": "column-list", "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "actionStripComponents", "attribute": "action-strip-components", "type": { "text": "IgcActionStripToken[]" } }, { "kind": "field", "privacy": "public", "name": "dragGhostCustomTemplate", "description": "Gets the custom template, if any, used for row drag ghost.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditTextTemplate", "description": "Gets the row edit text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowAddTextTemplate", "description": "Gets the row add text template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowEditActionsTemplate", "description": "Gets the row edit actions template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowExpandedIndicatorTemplate", "description": "Gets the row expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerExpandedIndicatorTemplate", "description": "Gets the header expand indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "headerCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "excelStyleHeaderIconTemplate", "description": "Gets the excel style header icon.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "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": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortHeaderIconTemplate", "description": "Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "toolbar", "attribute": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" } }, { "kind": "field", "privacy": "public", "name": "paginationComponents", "attribute": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Gets/Sets the resource strings.", "attribute": "resource-strings", "type": { "text": "IgcGridResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`.", "attribute": "filtering-logic", "type": { "text": "FilteringLogic" } }, { "kind": "field", "privacy": "public", "name": "filteringExpressionsTree", "description": "Gets/Sets the filtering state.", "attribute": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state.", "attribute": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" } }, { "kind": "field", "privacy": "public", "name": "locale", "description": "Gets/Sets the locale.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pagingMode", "attribute": "paging-mode", "type": { "text": "GridPagingMode" } }, { "kind": "field", "privacy": "public", "name": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden.", "attribute": "hide-row-selectors", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "rowDraggable", "description": "Gets/Sets whether rows can be moved.", "attribute": "row-draggable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid.", "attribute": "validation-trigger", "type": { "text": "GridValidationTrigger" } }, { "kind": "field", "privacy": "public", "name": "rowEditable", "description": "Gets/Sets whether the rows are editable.", "attribute": "row-editable", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "height", "description": "Gets/Sets the height.", "attribute": "height", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "width", "description": "Gets/Sets the width of the grid.", "attribute": "width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "rowHeight", "description": "Gets/Sets the row height.", "attribute": "row-height", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columnWidth", "description": "Gets/Sets the default width of the columns.", "attribute": "column-width", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records.", "attribute": "empty-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator.", "attribute": "is-loading", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead.", "attribute": "should-generate", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered.", "attribute": "empty-filtered-grid-message", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "pinning", "description": "Gets/Sets the initial pinning configuration.", "attribute": "pinning", "type": { "text": "IgcPinningConfig" } }, { "kind": "field", "privacy": "public", "name": "allowFiltering", "description": "Gets/Sets if the filtering is enabled.", "attribute": "allow-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled.", "attribute": "allow-advanced-filtering", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterMode", "description": "Gets/Sets the filter mode.", "attribute": "filter-mode", "type": { "text": "FilterMode" } }, { "kind": "field", "privacy": "public", "name": "summaryPosition", "description": "Gets/Sets the summary position.", "attribute": "summary-position", "type": { "text": "GridSummaryPosition" } }, { "kind": "field", "privacy": "public", "name": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode.", "attribute": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" } }, { "kind": "field", "privacy": "public", "name": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed.", "attribute": "show-summary-on-collapse", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid.", "attribute": "filter-strategy", "type": { "text": "IgcFilteringStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid.", "attribute": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" } }, { "kind": "field", "privacy": "public", "name": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid.", "attribute": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" } }, { "kind": "field", "privacy": "public", "name": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties.", "attribute": "sorting-options", "type": { "text": "IgcSortingOptions" } }, { "kind": "field", "privacy": "public", "name": "selectedRows", "description": "Gets/Sets the current selection state.", "attribute": "selected-rows", "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "rowList", "description": "A list of `IgxGridRowComponent`.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "dataRowList", "description": "A list of currently rendered `IgxGridRowComponent`'s.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "headSelectorTemplate", "description": "Gets the header row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "rowSelectorTemplate", "description": "Gets the row selector template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "dragIndicatorIconTemplate", "description": "The custom template, if any, that should be used when rendering the row drag indicator icon", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "sortingExpressions", "description": "Gets/Sets the sorting state.", "attribute": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" } }, { "kind": "field", "privacy": "public", "name": "hiddenColumnsCount", "description": "Gets the number of hidden columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumnsCount", "description": "Gets the number of pinned columns.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "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.", "attribute": "batch-editing", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "cellSelection", "description": "Gets/Sets cell selection mode.", "attribute": "cell-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "cellMergeMode", "description": "Gets/Sets cell merge mode.", "attribute": "cell-merge-mode", "type": { "text": "GridCellMergeMode" } }, { "kind": "field", "privacy": "public", "name": "rowSelection", "description": "Gets/Sets row selection mode", "attribute": "row-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "columnSelection", "description": "Gets/Sets column selection mode", "attribute": "column-selection", "type": { "text": "GridSelectionMode" } }, { "kind": "field", "privacy": "public", "name": "lastSearchInfo", "description": "Represents the last search information.", "readonly": true, "type": { "text": "IgcSearchInfo" } }, { "kind": "field", "privacy": "public", "name": "filteredData", "description": "Returns an array of objects containing the filtered data.", "readonly": true, "type": { "text": "any" } }, { "kind": "field", "privacy": "public", "name": "filteredSortedData", "description": "Returns an array containing the filtered sorted data.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "virtualizationState", "description": "Returns the state of the grid virtualization.", "readonly": true, "type": { "text": "IgcForOfState" } }, { "kind": "field", "privacy": "public", "name": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state].", "attribute": "expansion-states", "type": { "text": "Map" } }, { "kind": "field", "privacy": "public", "name": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to.", "attribute": "outlet", "type": { "text": "IgcOverlayOutletDirective" } }, { "kind": "field", "privacy": "public", "name": "defaultRowHeight", "description": "Gets the default row height.", "readonly": true, "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "columns", "description": "Gets an array of `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumns", "description": "Gets an array of the pinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedStartColumns", "description": "Gets an array of the pinned to the left `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedEndColumns", "description": "Gets an array of the pinned to the right `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedRows", "description": "Gets an array of the pinned `IgxRowComponent`s.", "readonly": true, "type": { "text": "IgcGridRowComponent[]" } }, { "kind": "field", "privacy": "public", "name": "unpinnedColumns", "description": "Gets an array of unpinned `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "visibleColumns", "description": "Returns an array of visible `IgxColumnComponent`s.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "totalRecords", "description": "Returns the total number of records.", "attribute": "total-records", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "dataView", "description": "Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.", "readonly": true, "type": { "text": "any[]" } }, { "kind": "field", "privacy": "public", "name": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it", "attribute": "select-row-on-click", "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "getDefaultExpandState", "parameters": [ { "name": "record", "type": { "text": "IgcTreeGridRecord" }, "optional": false } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "expandAll", "description": "Expands all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseAll", "description": "Collapses all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "addRow", "description": "Creates a new `IgxTreeGridRowComponent` with the given data. If a parentRowID is not specified, the newly created row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches the specified parentRowID. If the parentRowID does not exist, an error would be thrown.", "parameters": [ { "name": "data", "type": { "text": "any" }, "optional": false }, { "name": "parentRowID", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowByIndex", "description": "Enters add mode by spawning the UI with the context of the specified row by index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false }, { "name": "asChild", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "any[]" } } }, { "kind": "method", "privacy": "public", "name": "getRowByIndex", "description": "Returns the `IgxTreeGridRow` by index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getRowByKey", "description": "Returns the `RowType` object by the specified primary key.", "parameters": [ { "name": "key", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getCellByColumn", "description": "Returns a `CellType` object that matches the conditions.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "columnField", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcCellType" } } }, { "kind": "method", "privacy": "public", "name": "getCellByKey", "description": "Returns a `CellType` object that matches the conditions.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "columnField", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcCellType" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "isRecordPinnedByIndex", "description": "Returns whether the record is pinned or not.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleColumnVisibility", "description": "Toggles the specified column's visibility.", "parameters": [ { "name": "args", "type": { "text": "IgcColumnVisibilityChangedEventArgs" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandAll", "description": "Expands all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseAll", "description": "Collapses all rows.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "expandRow", "description": "Expands the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "collapseRow", "description": "Collapses the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "toggleRow", "description": "Toggles the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getHeaderGroupWidth", "description": "Gets the `width` to be set on `IgxGridHeaderGroupComponent`.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false } ], "return": { "type": { "text": "string" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByName", "description": "Returns the `IgxColumnComponent` by field name.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "getColumnByVisibleIndex", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcColumnComponent" } } }, { "kind": "method", "privacy": "public", "name": "recalculateAutoSizes", "description": "Recalculates all widths of columns that have size set to `auto`.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "moveColumn", "description": "Places a column before or after the specified target column.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "target", "type": { "text": "IgcColumnComponent" }, "optional": false }, { "name": "pos", "type": { "text": "DropPosition" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "markForCheck", "description": "Triggers change detection for the `IgxGridComponent`. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused:", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "addRow", "description": "Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source.", "parameters": [ { "name": "data", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deleteRow", "description": "Removes the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "updateCell", "description": "Updates the `IgxGridRowComponent` and the corresponding data record by primary key.", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false }, { "name": "column", "type": { "text": "string" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "updateRow", "description": "Updates the `IgxGridRowComponent`", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getRowData", "description": "Returns the data that is contained in the row component.", "parameters": [ { "name": "rowSelector", "type": { "text": "any" }, "optional": false } ], "return": { "type": { "text": "any" } } }, { "kind": "method", "privacy": "public", "name": "sort", "description": "Sort a single `IgxColumnComponent`.", "parameters": [ { "name": "expression", "type": { "text": "IgcSortingExpression[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filter", "description": "Filters a single `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": false }, { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "conditionOrExpressionTree", "type": { "text": "IgcFilteringExpressionsTree | IgcFilteringOperation" }, "optional": true }, { "name": "ignoreCase", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "filterGlobal", "description": "Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition.", "deprecated": "", "parameters": [ { "name": "value", "type": { "text": "any" }, "optional": false }, { "name": "condition", "type": { "text": "any" }, "optional": false }, { "name": "ignoreCase", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "enableSummaries", "description": "Enables summaries for the specified column and applies your customSummary.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "disableSummaries", "description": "Disable summaries for the specified column.", "parameters": [ { "name": "rest", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearFilter", "description": "If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearSort", "description": "If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`.", "parameters": [ { "name": "name", "type": { "text": "string" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "pinColumn", "description": "Pins a column by field name.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "pinningPosition", "type": { "text": "ColumnPinningPosition" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinColumn", "description": "Unpins a column by field name. Returns whether the operation is successful.", "parameters": [ { "name": "columnName", "type": { "text": "string" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "pinRow", "description": "Pin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "index", "type": { "text": "number" }, "optional": true }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "unpinRow", "description": "Unpin the row by its id.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "row", "type": { "text": "IgcRowType" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "reflow", "description": "Recalculates grid width/height dimensions.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "findNext", "description": "Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "findPrev", "description": "Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.", "parameters": [ { "name": "text", "type": { "text": "string" }, "optional": false }, { "name": "caseSensitive", "type": { "text": "boolean" }, "optional": true }, { "name": "exactMatch", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "refreshSearch", "description": "Reapplies the existing search.", "parameters": [ { "name": "updateActiveInfo", "type": { "text": "boolean" }, "optional": true }, { "name": "endEdit", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "number" } } }, { "kind": "method", "privacy": "public", "name": "clearSearch", "description": "Removes all the highlights in the cell.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedStartWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getPinnedEndWidth", "description": "Gets calculated width of the pinned areas.", "parameters": [ { "name": "takeHidden", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRows", "description": "Select specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectRows", "description": "Deselect specified rows by ID.", "parameters": [ { "name": "rowIDs", "type": { "text": "any[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllRows", "description": "Selects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllRows", "description": "Deselects all rows", "parameters": [ { "name": "onlyFilterData", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "clearCellSelection", "description": "Deselect selected cells.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectRange", "description": "Select range(s) of cells between certain rows and columns of the grid.", "parameters": [ { "name": "arg", "type": { "text": "IgcGridSelectionRange[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedRanges", "description": "Get the currently selected ranges in the grid.", "parameters": [], "return": { "type": { "text": "IgcGridSelectionRange[]" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedData", "description": "Returns an array of the current cell selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectedColumns", "description": "Get current selected columns.", "parameters": [], "return": { "type": { "text": "IgcColumnComponent[]" } } }, { "kind": "method", "privacy": "public", "name": "selectColumns", "description": "Select specified columns.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false }, { "name": "clearCurrentSelection", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectColumns", "description": "Deselect specified columns by field.", "parameters": [ { "name": "columns", "type": { "text": "string[] | IgcColumnComponent[]" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "deselectAllColumns", "description": "Deselects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "selectAllColumns", "description": "Selects all columns", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getSelectedColumnsData", "description": "Returns an array of the current columns selection in the form of `[{ column.field: cell.value }, ...]`.", "parameters": [ { "name": "formatters", "type": { "text": "boolean" }, "optional": true }, { "name": "headers", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "navigateTo", "description": "Navigates to a position in the grid based on provided `rowindex` and `visibleColumnIndex`.", "parameters": [ { "name": "rowIndex", "type": { "text": "number" }, "optional": false }, { "name": "visibleColIndex", "type": { "text": "number" }, "optional": true }, { "name": "cb", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "getNextCell", "description": "Returns `ICellPosition` which defines the next cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "getPreviousCell", "description": "Returns `ICellPosition` which defines the previous cell, according to the current position, that match specific criteria.", "parameters": [ { "name": "currRowIndex", "type": { "text": "number" }, "optional": false }, { "name": "curVisibleColIndex", "type": { "text": "number" }, "optional": false }, { "name": "callback", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "IgcCellPosition" } } }, { "kind": "method", "privacy": "public", "name": "openAdvancedFilteringDialog", "description": "Opens the advanced filtering dialog.", "parameters": [ { "name": "overlaySettings", "type": { "text": "IgcOverlaySettings" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "closeAdvancedFilteringDialog", "description": "Closes the advanced filtering dialog.", "parameters": [ { "name": "applyChanges", "type": { "text": "boolean" }, "optional": false } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "endEdit", "description": "Finishes the row transactions on the current row and returns whether the grid editing was canceled.", "parameters": [ { "name": "commit", "type": { "text": "boolean" }, "optional": true }, { "name": "evt", "type": { "text": "any" }, "optional": true } ], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowById", "description": "Enters add mode by spawning the UI under the specified row by rowID.", "parameters": [ { "name": "rowID", "type": { "text": "any" }, "optional": false }, { "name": "asChild", "type": { "text": "boolean" }, "optional": true } ], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "beginAddRowByIndex", "description": "Enters add mode by spawning the UI at the specified index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "child-data-key", "type": { "text": "string" }, "fieldName": "childDataKey", "description": "Sets the child data key of the `IgxTreeGridComponent`." }, { "name": "foreign-key", "type": { "text": "string" }, "fieldName": "foreignKey", "description": "Sets the foreign key of the `IgxTreeGridComponent`." }, { "name": "has-children-key", "type": { "text": "string" }, "fieldName": "hasChildrenKey", "description": "Sets the key indicating whether a row has children. This property is only used for load on demand scenarios." }, { "name": "cascade-on-delete", "type": { "text": "boolean" }, "fieldName": "cascadeOnDelete", "description": "Sets whether child records should be deleted when their parent gets deleted. By default it is set to true and deletes all children along with the parent." }, { "name": "load-children-on-demand", "type": { "text": "any" }, "fieldName": "loadChildrenOnDemand", "description": "Sets a callback for loading child rows on demand." }, { "name": "id", "type": { "text": "string" }, "fieldName": "id", "description": "Sets the value of the `id` attribute. If not provided it will be automatically generated." }, { "name": "root-records", "type": { "text": "IgcTreeGridRecord[]" }, "fieldName": "rootRecords", "description": "Returns an array of the root level `ITreeGridRecord`s." }, { "name": "processed-root-records", "type": { "text": "IgcTreeGridRecord[]" }, "fieldName": "processedRootRecords", "description": "Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s." }, { "name": "data", "type": { "text": "any[]" }, "fieldName": "data", "description": "Gets/Sets the array of data that populates the component." }, { "name": "expansion-depth", "type": { "text": "number" }, "fieldName": "expansionDepth", "description": "Sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is set to `Infinity` which means all levels would be expanded." }, { "name": "snackbar-display-time", "type": { "text": "number" }, "fieldName": "snackbarDisplayTime", "description": "Gets/Sets the display time for the row adding snackbar notification." }, { "name": "auto-generate", "type": { "text": "boolean" }, "fieldName": "autoGenerate", "description": "Gets/Sets whether to auto-generate the columns." }, { "name": "auto-generate-exclude", "type": { "text": "string[]" }, "fieldName": "autoGenerateExclude", "description": "Gets/Sets a list of property keys to be excluded from the generated column collection" }, { "name": "moving", "type": { "text": "boolean" }, "fieldName": "moving", "description": "Controls whether columns moving is enabled in the grid." }, { "name": "summary-row-height", "type": { "text": "number" }, "fieldName": "summaryRowHeight", "description": "Get/Set IgxSummaryRow height" }, { "name": "data-clone-strategy", "type": { "text": "IgcDataCloneStrategy" }, "fieldName": "dataCloneStrategy", "description": "Gets/Sets the data clone strategy of the grid when in edit mode." }, { "name": "clipboard-options", "type": { "text": "IgcClipboardOptions" }, "fieldName": "clipboardOptions", "description": "Controls the copy behavior of the grid." }, { "name": "row-classes", "type": { "text": "any" }, "fieldName": "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:" }, { "name": "row-styles", "type": { "text": "any" }, "fieldName": "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." }, { "name": "primary-key", "type": { "text": "string" }, "fieldName": "primaryKey", "description": "Gets/Sets the primary key." }, { "name": "column-list", "type": { "text": "IgcColumnComponent[]" }, "fieldName": "columnList" }, { "name": "action-strip-components", "type": { "text": "IgcActionStripToken[]" }, "fieldName": "actionStripComponents" }, { "name": "toolbar", "type": { "text": "IgcGridToolbarComponent[]" }, "fieldName": "toolbar" }, { "name": "pagination-components", "type": { "text": "IgcPaginatorComponent[]" }, "fieldName": "paginationComponents" }, { "name": "resource-strings", "type": { "text": "IgcGridResourceStrings" }, "fieldName": "resourceStrings", "description": "Gets/Sets the resource strings." }, { "name": "filtering-logic", "type": { "text": "FilteringLogic" }, "fieldName": "filteringLogic", "description": "Gets/Sets the filtering logic of the `IgxGridComponent`." }, { "name": "filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "filteringExpressionsTree", "description": "Gets/Sets the filtering state." }, { "name": "advanced-filtering-expressions-tree", "type": { "text": "IgcFilteringExpressionsTree" }, "fieldName": "advancedFilteringExpressionsTree", "description": "Gets/Sets the advanced filtering state." }, { "name": "locale", "type": { "text": "string" }, "fieldName": "locale", "description": "Gets/Sets the locale." }, { "name": "paging-mode", "type": { "text": "GridPagingMode" }, "fieldName": "pagingMode" }, { "name": "hide-row-selectors", "type": { "text": "boolean" }, "fieldName": "hideRowSelectors", "description": "Gets/Sets if the row selectors are hidden." }, { "name": "row-draggable", "type": { "text": "boolean" }, "fieldName": "rowDraggable", "description": "Gets/Sets whether rows can be moved." }, { "name": "validation-trigger", "type": { "text": "GridValidationTrigger" }, "fieldName": "validationTrigger", "description": "Gets/Sets the trigger for validators used when editing the grid." }, { "name": "row-editable", "type": { "text": "boolean" }, "fieldName": "rowEditable", "description": "Gets/Sets whether the rows are editable." }, { "name": "height", "type": { "text": "string" }, "fieldName": "height", "description": "Gets/Sets the height." }, { "name": "width", "type": { "text": "string" }, "fieldName": "width", "description": "Gets/Sets the width of the grid." }, { "name": "row-height", "type": { "text": "number" }, "fieldName": "rowHeight", "description": "Gets/Sets the row height." }, { "name": "column-width", "type": { "text": "string" }, "fieldName": "columnWidth", "description": "Gets/Sets the default width of the columns." }, { "name": "empty-grid-message", "type": { "text": "string" }, "fieldName": "emptyGridMessage", "description": "Get/Sets the message displayed when there are no records." }, { "name": "is-loading", "type": { "text": "boolean" }, "fieldName": "isLoading", "description": "Gets/Sets whether the grid is going to show a loading indicator." }, { "name": "should-generate", "type": { "text": "boolean" }, "fieldName": "shouldGenerate", "description": "Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid", "deprecated": "Column re-creation now relies on `autoGenerate` instead." }, { "name": "empty-filtered-grid-message", "type": { "text": "string" }, "fieldName": "emptyFilteredGridMessage", "description": "Gets/Sets the message displayed when there are no records and the grid is filtered." }, { "name": "pinning", "type": { "text": "IgcPinningConfig" }, "fieldName": "pinning", "description": "Gets/Sets the initial pinning configuration." }, { "name": "allow-filtering", "type": { "text": "boolean" }, "fieldName": "allowFiltering", "description": "Gets/Sets if the filtering is enabled." }, { "name": "allow-advanced-filtering", "type": { "text": "boolean" }, "fieldName": "allowAdvancedFiltering", "description": "Gets/Sets a value indicating whether the advanced filtering is enabled." }, { "name": "filter-mode", "type": { "text": "FilterMode" }, "fieldName": "filterMode", "description": "Gets/Sets the filter mode." }, { "name": "summary-position", "type": { "text": "GridSummaryPosition" }, "fieldName": "summaryPosition", "description": "Gets/Sets the summary position." }, { "name": "summary-calculation-mode", "type": { "text": "GridSummaryCalculationMode" }, "fieldName": "summaryCalculationMode", "description": "Gets/Sets the summary calculation mode." }, { "name": "show-summary-on-collapse", "type": { "text": "boolean" }, "fieldName": "showSummaryOnCollapse", "description": "Controls whether the summary row is visible when groupBy/parent row is collapsed." }, { "name": "filter-strategy", "type": { "text": "IgcFilteringStrategy" }, "fieldName": "filterStrategy", "description": "Gets/Sets the filtering strategy of the grid." }, { "name": "sort-strategy", "type": { "text": "IgcGridSortingStrategy" }, "fieldName": "sortStrategy", "description": "Gets/Sets the sorting strategy of the grid." }, { "name": "merge-strategy", "type": { "text": "IgcGridMergeStrategy" }, "fieldName": "mergeStrategy", "description": "Gets/Sets the merge strategy of the grid." }, { "name": "sorting-options", "type": { "text": "IgcSortingOptions" }, "fieldName": "sortingOptions", "description": "Gets/Sets the sorting options - single or multiple sorting. Accepts an `ISortingOptions` object with any of the `mode` properties." }, { "name": "selected-rows", "type": { "text": "any[]" }, "fieldName": "selectedRows", "description": "Gets/Sets the current selection state." }, { "name": "sorting-expressions", "type": { "text": "IgcSortingExpression[]" }, "fieldName": "sortingExpressions", "description": "Gets/Sets the sorting state." }, { "name": "batch-editing", "type": { "text": "boolean" }, "fieldName": "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." }, { "name": "cell-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "cellSelection", "description": "Gets/Sets cell selection mode." }, { "name": "cell-merge-mode", "type": { "text": "GridCellMergeMode" }, "fieldName": "cellMergeMode", "description": "Gets/Sets cell merge mode." }, { "name": "row-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "rowSelection", "description": "Gets/Sets row selection mode" }, { "name": "column-selection", "type": { "text": "GridSelectionMode" }, "fieldName": "columnSelection", "description": "Gets/Sets column selection mode" }, { "name": "expansion-states", "type": { "text": "Map" }, "fieldName": "expansionStates", "description": "Gets/Sets a list of key-value pairs [row ID, expansion state]." }, { "name": "outlet", "type": { "text": "IgcOverlayOutletDirective" }, "fieldName": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to." }, { "name": "total-records", "type": { "text": "number" }, "fieldName": "totalRecords", "description": "Returns the total number of records." }, { "name": "select-row-on-click", "type": { "text": "boolean" }, "fieldName": "selectRowOnClick", "description": "Gets/Sets whether clicking over a row should select/deselect it" } ], "events": [ { "name": "filteringExpressionsTreeChange", "description": "Emitted after filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "advancedFilteringExpressionsTreeChange", "description": "Emitted after advanced filtering is performed.", "type": { "text": "CustomEvent" } }, { "name": "gridScroll", "description": "Emitted when grid is scrolled horizontally/vertically.", "type": { "text": "CustomEvent" } }, { "name": "cellClick", "description": "Emitted when a cell is clicked.", "type": { "text": "CustomEvent" } }, { "name": "rowClick", "description": "Emitted when a row is clicked.", "type": { "text": "CustomEvent" } }, { "name": "formGroupCreated", "description": "Emitted when formGroup is created on edit of row/cell.", "type": { "text": "CustomEvent" } }, { "name": "validationStatusChange", "description": "Emitted when grid's validation status changes.", "type": { "text": "CustomEvent" } }, { "name": "selected", "description": "Emitted when a cell is selected.", "type": { "text": "CustomEvent" } }, { "name": "rowSelectionChanging", "description": "Emitted when `IgxGridRowComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnSelectionChanging", "description": "Emitted when `IgxColumnComponent` is selected.", "type": { "text": "CustomEvent" } }, { "name": "columnPin", "description": "Emitted before `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "columnPinned", "description": "Emitted after `IgxColumnComponent` is pinned.", "type": { "text": "CustomEvent" } }, { "name": "cellEditEnter", "description": "Emitted when cell enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEditExit", "description": "Emitted when cell exits edit mode.", "type": { "text": "CustomEvent" } }, { "name": "cellEdit", "description": "Emitted when cell has been edited.", "type": { "text": "CustomEvent" } }, { "name": "cellEditDone", "description": "Emitted after cell has been edited and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditEnter", "description": "Emitted when a row enters edit mode.", "type": { "text": "CustomEvent" } }, { "name": "rowEdit", "description": "Emitted when exiting edit mode for a row.", "type": { "text": "CustomEvent" } }, { "name": "rowEditDone", "description": "Emitted after exiting edit mode for a row and editing has been committed.", "type": { "text": "CustomEvent" } }, { "name": "rowEditExit", "description": "Emitted when row editing is canceled.", "type": { "text": "CustomEvent" } }, { "name": "columnInit", "description": "Emitted when a column is initialized.", "type": { "text": "CustomEvent" } }, { "name": "columnsAutogenerated", "description": "", "type": { "text": "CustomEvent" } }, { "name": "sorting", "description": "Emitted before sorting expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "sortingDone", "description": "Emitted after sorting is completed.", "type": { "text": "CustomEvent" } }, { "name": "filtering", "description": "Emitted before filtering expressions are applied.", "type": { "text": "CustomEvent" } }, { "name": "filteringDone", "description": "Emitted after filtering is performed through the UI.", "type": { "text": "CustomEvent" } }, { "name": "rowAdded", "description": "Emitted when a row is added.", "type": { "text": "CustomEvent" } }, { "name": "rowDeleted", "description": "Emitted when a row is deleted.", "type": { "text": "CustomEvent" } }, { "name": "rowDelete", "description": "Emmited when deleting a row.", "type": { "text": "CustomEvent" } }, { "name": "rowAdd", "description": "Emmited just before the newly added row is commited.", "type": { "text": "CustomEvent" } }, { "name": "columnResized", "description": "Emitted after column is resized.", "type": { "text": "CustomEvent" } }, { "name": "contextMenu", "description": "Emitted when a cell or row is right clicked.", "type": { "text": "CustomEvent" } }, { "name": "doubleClick", "description": "Emitted when a cell is double clicked.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanging", "description": "Emitted before column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnVisibilityChanged", "description": "Emitted after column visibility is changed.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingStart", "description": "Emitted when column moving starts.", "type": { "text": "CustomEvent" } }, { "name": "columnMoving", "description": "Emitted during the column moving operation.", "type": { "text": "CustomEvent" } }, { "name": "columnMovingEnd", "description": "Emitted when column moving ends.", "type": { "text": "CustomEvent" } }, { "name": "gridKeydown", "description": "Emitted when keydown is triggered over element inside grid's body.", "type": { "text": "CustomEvent" } }, { "name": "rowDragStart", "description": "Emitted when start dragging a row.", "type": { "text": "CustomEvent" } }, { "name": "rowDragEnd", "description": "Emitted when dropping a row.", "type": { "text": "CustomEvent" } }, { "name": "gridCopy", "description": "Emitted when a copy operation is executed.", "type": { "text": "CustomEvent" } }, { "name": "expansionStatesChange", "description": "Emitted when the rows are expanded or collapsed.", "type": { "text": "CustomEvent>" } }, { "name": "selectedRowsChange", "description": "Emitted when the rows are selected or deselected.", "type": { "text": "CustomEvent" } }, { "name": "rowToggle", "description": "Emitted when the expanded state of a row gets changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinning", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "rowPinned", "description": "Emitted when the pinned state of a row is changed.", "type": { "text": "CustomEvent" } }, { "name": "activeNodeChange", "description": "Emitted when the active node is changed.", "type": { "text": "CustomEvent" } }, { "name": "sortingExpressionsChange", "description": "Emitted before sorting is performed.", "type": { "text": "CustomEvent" } }, { "name": "toolbarExporting", "description": "Emitted when an export process is initiated by the user.", "type": { "text": "CustomEvent" } }, { "name": "rangeSelected", "description": "Emitted when making a range selection.", "type": { "text": "CustomEvent" } }, { "name": "rendered", "description": "Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM", "type": { "text": "CustomEvent" } }, { "name": "dataChanging", "description": "Emitted before the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } }, { "name": "dataChanged", "description": "Emitted after the grid's data view is changed because of a data operation, rebinding, etc.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-tree-grid", "customElement": true }, { "kind": "class", "name": "IgcQueryBuilderHeaderComponent", "description": "", "members": [ { "kind": "field", "privacy": "public", "name": "title", "description": "Sets the title of the `IgxQueryBuilderHeaderComponent`.", "attribute": "title", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "showLegend", "description": "Show/hide the legend.", "deprecated": "", "attribute": "show-legend", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Sets the resource strings. By default it uses EN resources.", "deprecated": "", "attribute": "resource-strings", "type": { "text": "IgcQueryBuilderResourceStrings" } } ], "attributes": [ { "name": "title", "type": { "text": "string" }, "fieldName": "title", "description": "Sets the title of the `IgxQueryBuilderHeaderComponent`." }, { "name": "show-legend", "type": { "text": "boolean" }, "fieldName": "showLegend", "description": "Show/hide the legend.", "deprecated": "" }, { "name": "resource-strings", "type": { "text": "IgcQueryBuilderResourceStrings" }, "fieldName": "resourceStrings", "description": "Sets the resource strings. By default it uses EN resources.", "deprecated": "" } ], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-query-builder-header", "customElement": true }, { "kind": "class", "name": "IgcQueryBuilderComponent", "description": "A component used for operating with complex filters by creating or editing conditions and grouping them using AND/OR logic. It is used internally in the Advanced Filtering of the Grid.", "members": [ { "kind": "field", "privacy": "public", "name": "showEntityChangeDialog", "description": "Gets/sets whether the confirmation dialog should be shown when changing entity. Default value is `true`.", "attribute": "show-entity-change-dialog", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "entities", "description": "Gets the list of entities available for the IgxQueryBuilderComponent. Each entity describes a logical group of fields that can be used in queries. An entity can optionally have child entities, allowing nested sub-queries.", "attribute": "entities", "type": { "text": "IgcEntityType[]" } }, { "kind": "field", "privacy": "public", "name": "expressionTree", "description": "Returns the expression tree.", "attribute": "expression-tree", "type": { "text": "IgcExpressionTree" } }, { "kind": "field", "privacy": "public", "name": "locale", "description": "Gets the `locale` of the query builder. If not set, defaults to application's locale.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "Sets the resource strings. By default it uses EN resources.", "attribute": "resource-strings", "type": { "text": "IgcQueryBuilderResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "disableEntityChange", "description": "Disables subsequent entity changes at the root level after the initial selection.", "attribute": "disable-entity-change", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "searchValueTemplate", "description": "Sets/gets the search value template.", "type": { "text": "IgcRenderFunction" } }, { "kind": "field", "privacy": "public", "name": "disableReturnFieldsChange", "description": "Disables return fields changes at the root level.", "attribute": "disable-return-fields-change", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "queryBuilderHeaderCollection", "attribute": "query-builder-header-collection", "type": { "text": "IgcQueryBuilderHeaderComponent[]" } }, { "kind": "method", "privacy": "public", "name": "canCommit", "description": "Returns whether the expression tree can be committed in the current state.", "parameters": [], "return": { "type": { "text": "boolean" } } }, { "kind": "method", "privacy": "public", "name": "commit", "description": "Commits the expression tree in the current state if it is valid. If not throws an exception.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "discard", "description": "Discards all unsaved changes to the expression tree.", "parameters": [], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "show-entity-change-dialog", "type": { "text": "boolean" }, "fieldName": "showEntityChangeDialog", "description": "Gets/sets whether the confirmation dialog should be shown when changing entity. Default value is `true`." }, { "name": "entities", "type": { "text": "IgcEntityType[]" }, "fieldName": "entities", "description": "Gets the list of entities available for the IgxQueryBuilderComponent. Each entity describes a logical group of fields that can be used in queries. An entity can optionally have child entities, allowing nested sub-queries." }, { "name": "expression-tree", "type": { "text": "IgcExpressionTree" }, "fieldName": "expressionTree", "description": "Returns the expression tree." }, { "name": "locale", "type": { "text": "string" }, "fieldName": "locale", "description": "Gets the `locale` of the query builder. If not set, defaults to application's locale." }, { "name": "resource-strings", "type": { "text": "IgcQueryBuilderResourceStrings" }, "fieldName": "resourceStrings", "description": "Sets the resource strings. By default it uses EN resources." }, { "name": "disable-entity-change", "type": { "text": "boolean" }, "fieldName": "disableEntityChange", "description": "Disables subsequent entity changes at the root level after the initial selection." }, { "name": "disable-return-fields-change", "type": { "text": "boolean" }, "fieldName": "disableReturnFieldsChange", "description": "Disables return fields changes at the root level." }, { "name": "query-builder-header-collection", "type": { "text": "IgcQueryBuilderHeaderComponent[]" }, "fieldName": "queryBuilderHeaderCollection" } ], "events": [ { "name": "expressionTreeChange", "description": "Event fired as the expression tree is changed.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-query-builder", "customElement": true }, { "kind": "class", "name": "IgcGridToolbarComponent", "description": "Provides a context-aware container component for UI operations for the grid components.", "members": [ { "kind": "field", "privacy": "public", "name": "showProgress", "description": "When enabled, shows the indeterminate progress bar.", "attribute": "show-progress", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "grid", "description": "Gets/sets the grid component for the toolbar component.", "deprecated": "No longer required to be set for the Hierarchical Grid child grid template", "attribute": "grid", "type": { "text": "IgcGridBaseDirective" } } ], "attributes": [ { "name": "show-progress", "type": { "text": "boolean" }, "fieldName": "showProgress", "description": "When enabled, shows the indeterminate progress bar." }, { "name": "grid", "type": { "text": "IgcGridBaseDirective" }, "fieldName": "grid", "description": "Gets/sets the grid component for the toolbar component.", "deprecated": "No longer required to be set for the Hierarchical Grid child grid template" } ], "events": [], "superclass": { "name": "HTMLElement" }, "tagName": "igc-grid-toolbar", "customElement": true }, { "kind": "class", "name": "IgcPaginatorComponent", "description": "Paginator component description", "members": [ { "kind": "field", "privacy": "public", "name": "totalPages", "description": "Total pages calculated from totalRecords and perPage", "attribute": "total-pages", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "page", "description": "Gets/Sets the current page of the paginator. The default is 0.", "attribute": "page", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "perPage", "description": "Gets/Sets the number of visible items per page in the paginator. The default is 15.", "attribute": "per-page", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "totalRecords", "description": "Sets the total records.", "attribute": "total-records", "type": { "text": "number" } }, { "kind": "field", "privacy": "public", "name": "selectOptions", "description": "Sets custom options in the select of the paginator", "attribute": "select-options", "type": { "text": "number[]" } }, { "kind": "field", "privacy": "public", "name": "overlaySettings", "description": "Sets custom OverlaySettings.", "attribute": "overlay-settings", "type": { "text": "IgcOverlaySettings" } }, { "kind": "field", "privacy": "public", "name": "resourceStrings", "description": "An accessor that sets the resource strings. By default it uses EN resources.", "attribute": "resource-strings", "type": { "text": "IgcPaginatorResourceStrings" } }, { "kind": "field", "privacy": "public", "name": "isLastPage", "description": "Returns if the current page is the last page.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "isFirstPage", "description": "Returns if the current page is the first page.", "readonly": true, "type": { "text": "boolean" } }, { "kind": "method", "privacy": "public", "name": "nextPage", "description": "Goes to the next page of the `IgxPaginatorComponent`, if the paginator is not already at the last page.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "previousPage", "description": "Goes to the previous page of the `IgxPaginatorComponent`, if the paginator is not already at the first page.", "parameters": [], "return": { "type": { "text": "void" } } }, { "kind": "method", "privacy": "public", "name": "paginate", "description": "Goes to the desired page index.", "parameters": [ { "name": "val", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "total-pages", "type": { "text": "number" }, "fieldName": "totalPages", "description": "Total pages calculated from totalRecords and perPage" }, { "name": "page", "type": { "text": "number" }, "fieldName": "page", "description": "Gets/Sets the current page of the paginator. The default is 0." }, { "name": "per-page", "type": { "text": "number" }, "fieldName": "perPage", "description": "Gets/Sets the number of visible items per page in the paginator. The default is 15." }, { "name": "total-records", "type": { "text": "number" }, "fieldName": "totalRecords", "description": "Sets the total records." }, { "name": "select-options", "type": { "text": "number[]" }, "fieldName": "selectOptions", "description": "Sets custom options in the select of the paginator" }, { "name": "overlay-settings", "type": { "text": "IgcOverlaySettings" }, "fieldName": "overlaySettings", "description": "Sets custom OverlaySettings." }, { "name": "resource-strings", "type": { "text": "IgcPaginatorResourceStrings" }, "fieldName": "resourceStrings", "description": "An accessor that sets the resource strings. By default it uses EN resources." } ], "events": [ { "name": "perPageChange", "description": "Emitted when `perPage` property value of the paginator is changed.", "type": { "text": "CustomEvent" } }, { "name": "pageChange", "description": "Emitted after the current page is changed.", "type": { "text": "CustomEvent" } }, { "name": "paging", "description": "Emitted before paging is performed.", "type": { "text": "CustomEvent" } }, { "name": "pagingDone", "description": "Emitted after paging is performed.", "type": { "text": "CustomEvent" } } ], "superclass": { "name": "HTMLElement" }, "tagName": "igc-paginator", "customElement": true } ], "exports": [ { "kind": "js", "name": "IgcGridStateComponent", "declaration": { "name": "IgcGridStateComponent" } }, { "kind": "js", "name": "IgcGridStateBaseDirective", "declaration": { "name": "IgcGridStateBaseDirective" } }, { "kind": "js", "name": "IgcGridStateInfo", "declaration": { "name": "IgcGridStateInfo" } }, { "kind": "js", "name": "IgcActionStripComponent", "declaration": { "name": "IgcActionStripComponent" } }, { "kind": "js", "name": "IgcActionStripResourceStrings", "declaration": { "name": "IgcActionStripResourceStrings" } }, { "kind": "js", "name": "IgcBooleanFilteringOperand", "declaration": { "name": "IgcBooleanFilteringOperand" } }, { "kind": "js", "name": "IgcFilteringOperand", "declaration": { "name": "IgcFilteringOperand" } }, { "kind": "js", "name": "IgcDateFilteringOperand", "declaration": { "name": "IgcDateFilteringOperand" } }, { "kind": "js", "name": "IgcBaseDateTimeFilteringOperand", "declaration": { "name": "IgcBaseDateTimeFilteringOperand" } }, { "kind": "js", "name": "IgcDateTimeFilteringOperand", "declaration": { "name": "IgcDateTimeFilteringOperand" } }, { "kind": "js", "name": "IgcTimeFilteringOperand", "declaration": { "name": "IgcTimeFilteringOperand" } }, { "kind": "js", "name": "IgcNumberFilteringOperand", "declaration": { "name": "IgcNumberFilteringOperand" } }, { "kind": "js", "name": "IgcStringFilteringOperand", "declaration": { "name": "IgcStringFilteringOperand" } }, { "kind": "js", "name": "IgcFilteringExpression", "declaration": { "name": "IgcFilteringExpression" } }, { "kind": "js", "name": "IgcFilteringOperation", "declaration": { "name": "IgcFilteringOperation" } }, { "kind": "js", "name": "IgcExpressionTree", "declaration": { "name": "IgcExpressionTree" } }, { "kind": "js", "name": "IgcNoopFilteringStrategy", "declaration": { "name": "IgcNoopFilteringStrategy" } }, { "kind": "js", "name": "IgcBaseFilteringStrategy", "declaration": { "name": "IgcBaseFilteringStrategy" } }, { "kind": "js", "name": "IgcFilteringExpressionsTree", "declaration": { "name": "IgcFilteringExpressionsTree" } }, { "kind": "js", "name": "IgcNoopSortingStrategy", "declaration": { "name": "IgcNoopSortingStrategy" } }, { "kind": "js", "name": "IgcSummaryExpression", "declaration": { "name": "IgcSummaryExpression" } }, { "kind": "js", "name": "IgcGroupByResult", "declaration": { "name": "IgcGroupByResult" } }, { "kind": "js", "name": "IgcGroupByRecord", "declaration": { "name": "IgcGroupByRecord" } }, { "kind": "js", "name": "IgcDefaultTreeGridMergeStrategy", "declaration": { "name": "IgcDefaultTreeGridMergeStrategy" } }, { "kind": "js", "name": "IgcDefaultMergeStrategy", "declaration": { "name": "IgcDefaultMergeStrategy" } }, { "kind": "js", "name": "IgcByLevelTreeGridMergeStrategy", "declaration": { "name": "IgcByLevelTreeGridMergeStrategy" } }, { "kind": "js", "name": "IgcColumnGroupComponent", "declaration": { "name": "IgcColumnGroupComponent" } }, { "kind": "js", "name": "IgcColumnComponent", "declaration": { "name": "IgcColumnComponent" } }, { "kind": "js", "name": "IgcColumnTemplateContext", "declaration": { "name": "IgcColumnTemplateContext" } }, { "kind": "js", "name": "IgcColumnLayoutComponent", "declaration": { "name": "IgcColumnLayoutComponent" } }, { "kind": "js", "name": "IgcNoopPivotDimensionsStrategy", "declaration": { "name": "IgcNoopPivotDimensionsStrategy" } }, { "kind": "js", "name": "IgcPivotDimension", "declaration": { "name": "IgcPivotDimension" } }, { "kind": "js", "name": "IgcPivotValue", "declaration": { "name": "IgcPivotValue" } }, { "kind": "js", "name": "IgcGridEditingActionsComponent", "declaration": { "name": "IgcGridEditingActionsComponent" } }, { "kind": "js", "name": "IgcGridActionsBaseDirective", "declaration": { "name": "IgcGridActionsBaseDirective" } }, { "kind": "js", "name": "IgcGridPinningActionsComponent", "declaration": { "name": "IgcGridPinningActionsComponent" } }, { "kind": "js", "name": "IgcPivotDateDimension", "declaration": { "name": "IgcPivotDateDimension" } }, { "kind": "js", "name": "GridColumnDataType", "declaration": { "name": "GridColumnDataType" } }, { "kind": "js", "name": "IgcGridResourceStrings", "declaration": { "name": "IgcGridResourceStrings" } }, { "kind": "js", "name": "IgcPivotDateDimensionOptions", "declaration": { "name": "IgcPivotDateDimensionOptions" } }, { "kind": "js", "name": "IgcSummaryOperand", "declaration": { "name": "IgcSummaryOperand" } }, { "kind": "js", "name": "IgcSummaryResult", "declaration": { "name": "IgcSummaryResult" } }, { "kind": "js", "name": "IgcNumberSummaryOperand", "declaration": { "name": "IgcNumberSummaryOperand" } }, { "kind": "js", "name": "IgcDateSummaryOperand", "declaration": { "name": "IgcDateSummaryOperand" } }, { "kind": "js", "name": "IgcTimeSummaryOperand", "declaration": { "name": "IgcTimeSummaryOperand" } }, { "kind": "js", "name": "IgcGridToolbarTitleComponent", "declaration": { "name": "IgcGridToolbarTitleComponent" } }, { "kind": "js", "name": "IgcGridToolbarActionsComponent", "declaration": { "name": "IgcGridToolbarActionsComponent" } }, { "kind": "js", "name": "IgcGridToolbarAdvancedFilteringComponent", "declaration": { "name": "IgcGridToolbarAdvancedFilteringComponent" } }, { "kind": "js", "name": "IgcOverlaySettings", "declaration": { "name": "IgcOverlaySettings" } }, { "kind": "js", "name": "IgcGridToolbarExporterComponent", "declaration": { "name": "IgcGridToolbarExporterComponent" } }, { "kind": "js", "name": "IgcBaseToolbarDirective", "declaration": { "name": "IgcBaseToolbarDirective" } }, { "kind": "js", "name": "IgcExporterEventArgs", "declaration": { "name": "IgcExporterEventArgs" } }, { "kind": "js", "name": "GridToolbarExporterType", "declaration": { "name": "GridToolbarExporterType" } }, { "kind": "js", "name": "IgcGridToolbarHidingComponent", "declaration": { "name": "IgcGridToolbarHidingComponent" } }, { "kind": "js", "name": "IgcBaseToolbarColumnActionsDirective", "declaration": { "name": "IgcBaseToolbarColumnActionsDirective" } }, { "kind": "js", "name": "IgcGridToolbarPinningComponent", "declaration": { "name": "IgcGridToolbarPinningComponent" } }, { "kind": "js", "name": "IgcToggleViewCancelableEventArgs", "declaration": { "name": "IgcToggleViewCancelableEventArgs" } }, { "kind": "js", "name": "IgcToggleViewEventArgs", "declaration": { "name": "IgcToggleViewEventArgs" } }, { "kind": "js", "name": "IgcColumnToggledEventArgs", "declaration": { "name": "IgcColumnToggledEventArgs" } }, { "kind": "js", "name": "IgcGridComponent", "declaration": { "name": "IgcGridComponent" } }, { "kind": "js", "name": "IgcGridBaseDirective", "declaration": { "name": "IgcGridBaseDirective" } }, { "kind": "js", "name": "IgcForOfState", "declaration": { "name": "IgcForOfState" } }, { "kind": "js", "name": "IgcGroupingExpression", "declaration": { "name": "IgcGroupingExpression" } }, { "kind": "js", "name": "IgcGroupByExpandState", "declaration": { "name": "IgcGroupByExpandState" } }, { "kind": "js", "name": "IgcGroupingDoneEventArgs", "declaration": { "name": "IgcGroupingDoneEventArgs" } }, { "kind": "js", "name": "IgcGridMasterDetailContext", "declaration": { "name": "IgcGridMasterDetailContext" } }, { "kind": "js", "name": "IgcGridGroupingStrategy", "declaration": { "name": "IgcGridGroupingStrategy" } }, { "kind": "js", "name": "IgcGroupByRowSelectorTemplateContext", "declaration": { "name": "IgcGroupByRowSelectorTemplateContext" } }, { "kind": "js", "name": "IgcGroupByRowTemplateContext", "declaration": { "name": "IgcGroupByRowTemplateContext" } }, { "kind": "js", "name": "IgcRowType", "declaration": { "name": "IgcRowType" } }, { "kind": "js", "name": "IgcCellType", "declaration": { "name": "IgcCellType" } }, { "kind": "js", "name": "IgcHierarchicalGridComponent", "declaration": { "name": "IgcHierarchicalGridComponent" } }, { "kind": "js", "name": "IgcHierarchicalGridBaseDirective", "declaration": { "name": "IgcHierarchicalGridBaseDirective" } }, { "kind": "js", "name": "IgcRowIslandComponent", "declaration": { "name": "IgcRowIslandComponent" } }, { "kind": "js", "name": "IgcPivotDataSelectorComponent", "declaration": { "name": "IgcPivotDataSelectorComponent" } }, { "kind": "js", "name": "IgcPivotGridComponent", "declaration": { "name": "IgcPivotGridComponent" } }, { "kind": "js", "name": "IgcDimensionsChange", "declaration": { "name": "IgcDimensionsChange" } }, { "kind": "js", "name": "IgcPivotConfigurationChangedEventArgs", "declaration": { "name": "IgcPivotConfigurationChangedEventArgs" } }, { "kind": "js", "name": "IgcSortingExpression", "declaration": { "name": "IgcSortingExpression" } }, { "kind": "js", "name": "IgcValuesChange", "declaration": { "name": "IgcValuesChange" } }, { "kind": "js", "name": "IgcPivotGridValueTemplateContext", "declaration": { "name": "IgcPivotGridValueTemplateContext" } }, { "kind": "js", "name": "IgcPivotConfiguration", "declaration": { "name": "IgcPivotConfiguration" } }, { "kind": "js", "name": "IgcPivotUISettings", "declaration": { "name": "IgcPivotUISettings" } }, { "kind": "js", "name": "PivotDimensionType", "declaration": { "name": "PivotDimensionType" } }, { "kind": "js", "name": "SortingDirection", "declaration": { "name": "SortingDirection" } }, { "kind": "js", "name": "IgcTreeGridComponent", "declaration": { "name": "IgcTreeGridComponent" } }, { "kind": "js", "name": "IgcTreeGridRecord", "declaration": { "name": "IgcTreeGridRecord" } }, { "kind": "js", "name": "IgcQueryBuilderHeaderComponent", "declaration": { "name": "IgcQueryBuilderHeaderComponent" } }, { "kind": "js", "name": "IgcQueryBuilderResourceStrings", "declaration": { "name": "IgcQueryBuilderResourceStrings" } }, { "kind": "js", "name": "IgcQueryBuilderComponent", "declaration": { "name": "IgcQueryBuilderComponent" } }, { "kind": "js", "name": "IgcEntityType", "declaration": { "name": "IgcEntityType" } }, { "kind": "js", "name": "IgcQueryBuilderSearchValueContext", "declaration": { "name": "IgcQueryBuilderSearchValueContext" } }, { "kind": "js", "name": "IgcGridStateOptions", "declaration": { "name": "IgcGridStateOptions" } }, { "kind": "js", "name": "IgcColumnState", "declaration": { "name": "IgcColumnState" } }, { "kind": "js", "name": "IgcPagingState", "declaration": { "name": "IgcPagingState" } }, { "kind": "js", "name": "IgcGroupingState", "declaration": { "name": "IgcGroupingState" } }, { "kind": "js", "name": "IgcGridSelectionRange", "declaration": { "name": "IgcGridSelectionRange" } }, { "kind": "js", "name": "IgcPinningConfig", "declaration": { "name": "IgcPinningConfig" } }, { "kind": "js", "name": "IgcGridStateCollection", "declaration": { "name": "IgcGridStateCollection" } }, { "kind": "js", "name": "FilteringLogic", "declaration": { "name": "FilteringLogic" } }, { "kind": "js", "name": "IgcFilterItem", "declaration": { "name": "IgcFilterItem" } }, { "kind": "js", "name": "IgcBaseEventArgs", "declaration": { "name": "IgcBaseEventArgs" } }, { "kind": "js", "name": "FilteringExpressionsTreeType", "declaration": { "name": "FilteringExpressionsTreeType" } }, { "kind": "js", "name": "IgcGroupedRecords", "declaration": { "name": "IgcGroupedRecords" } }, { "kind": "js", "name": "ColumnPinningPosition", "declaration": { "name": "ColumnPinningPosition" } }, { "kind": "js", "name": "IgcSortingStrategy", "declaration": { "name": "IgcSortingStrategy" } }, { "kind": "js", "name": "IgcSummaryTemplateContext", "declaration": { "name": "IgcSummaryTemplateContext" } }, { "kind": "js", "name": "IgcCellTemplateContext", "declaration": { "name": "IgcCellTemplateContext" } }, { "kind": "js", "name": "IgcColumnPipeArgs", "declaration": { "name": "IgcColumnPipeArgs" } }, { "kind": "js", "name": "IgcColumnEditorOptions", "declaration": { "name": "IgcColumnEditorOptions" } }, { "kind": "js", "name": "IgcPivotAggregator", "declaration": { "name": "IgcPivotAggregator" } }, { "kind": "js", "name": "IgcPivotGridRecord", "declaration": { "name": "IgcPivotGridRecord" } }, { "kind": "js", "name": "IgcPivotGridColumn", "declaration": { "name": "IgcPivotGridColumn" } }, { "kind": "js", "name": "IgcValidationResourceStrings", "declaration": { "name": "IgcValidationResourceStrings" } }, { "kind": "js", "name": "IgcPositionStrategy", "declaration": { "name": "IgcPositionStrategy" } }, { "kind": "js", "name": "IgcScrollStrategy", "declaration": { "name": "IgcScrollStrategy" } }, { "kind": "js", "name": "IgcBaseExporter", "declaration": { "name": "IgcBaseExporter" } }, { "kind": "js", "name": "IgcExporterOptions", "declaration": { "name": "IgcExporterOptions" } }, { "kind": "js", "name": "IgcCancelableBrowserEventArgs", "declaration": { "name": "IgcCancelableBrowserEventArgs" } }, { "kind": "js", "name": "IgcGridTemplateContext", "declaration": { "name": "IgcGridTemplateContext" } }, { "kind": "js", "name": "IgcDataCloneStrategy", "declaration": { "name": "IgcDataCloneStrategy" } }, { "kind": "js", "name": "IgcClipboardOptions", "declaration": { "name": "IgcClipboardOptions" } }, { "kind": "js", "name": "IgcGridScrollEventArgs", "declaration": { "name": "IgcGridScrollEventArgs" } }, { "kind": "js", "name": "IgcGridCellEventArgs", "declaration": { "name": "IgcGridCellEventArgs" } }, { "kind": "js", "name": "IgcGridRowEventArgs", "declaration": { "name": "IgcGridRowEventArgs" } }, { "kind": "js", "name": "IgcGridFormGroupCreatedEventArgs", "declaration": { "name": "IgcGridFormGroupCreatedEventArgs" } }, { "kind": "js", "name": "IgcGridValidationStatusEventArgs", "declaration": { "name": "IgcGridValidationStatusEventArgs" } }, { "kind": "js", "name": "IgcRowSelectionEventArgs", "declaration": { "name": "IgcRowSelectionEventArgs" } }, { "kind": "js", "name": "IgcColumnSelectionEventArgs", "declaration": { "name": "IgcColumnSelectionEventArgs" } }, { "kind": "js", "name": "IgcPinColumnCancellableEventArgs", "declaration": { "name": "IgcPinColumnCancellableEventArgs" } }, { "kind": "js", "name": "IgcPinColumnEventArgs", "declaration": { "name": "IgcPinColumnEventArgs" } }, { "kind": "js", "name": "IgcGridEditEventArgs", "declaration": { "name": "IgcGridEditEventArgs" } }, { "kind": "js", "name": "IgcGridEditDoneEventArgs", "declaration": { "name": "IgcGridEditDoneEventArgs" } }, { "kind": "js", "name": "IgcColumnsAutoGeneratedEventArgs", "declaration": { "name": "IgcColumnsAutoGeneratedEventArgs" } }, { "kind": "js", "name": "IgcSortingEventArgs", "declaration": { "name": "IgcSortingEventArgs" } }, { "kind": "js", "name": "IgcFilteringEventArgs", "declaration": { "name": "IgcFilteringEventArgs" } }, { "kind": "js", "name": "IgcRowDataEventArgs", "declaration": { "name": "IgcRowDataEventArgs" } }, { "kind": "js", "name": "IgcRowDataCancelableEventArgs", "declaration": { "name": "IgcRowDataCancelableEventArgs" } }, { "kind": "js", "name": "IgcColumnResizeEventArgs", "declaration": { "name": "IgcColumnResizeEventArgs" } }, { "kind": "js", "name": "IgcGridContextMenuEventArgs", "declaration": { "name": "IgcGridContextMenuEventArgs" } }, { "kind": "js", "name": "IgcColumnVisibilityChangingEventArgs", "declaration": { "name": "IgcColumnVisibilityChangingEventArgs" } }, { "kind": "js", "name": "IgcColumnVisibilityChangedEventArgs", "declaration": { "name": "IgcColumnVisibilityChangedEventArgs" } }, { "kind": "js", "name": "IgcColumnMovingStartEventArgs", "declaration": { "name": "IgcColumnMovingStartEventArgs" } }, { "kind": "js", "name": "IgcColumnMovingEventArgs", "declaration": { "name": "IgcColumnMovingEventArgs" } }, { "kind": "js", "name": "IgcColumnMovingEndEventArgs", "declaration": { "name": "IgcColumnMovingEndEventArgs" } }, { "kind": "js", "name": "IgcGridKeydownEventArgs", "declaration": { "name": "IgcGridKeydownEventArgs" } }, { "kind": "js", "name": "IgcRowDragStartEventArgs", "declaration": { "name": "IgcRowDragStartEventArgs" } }, { "kind": "js", "name": "IgcRowDragEndEventArgs", "declaration": { "name": "IgcRowDragEndEventArgs" } }, { "kind": "js", "name": "IgcGridClipboardEvent", "declaration": { "name": "IgcGridClipboardEvent" } }, { "kind": "js", "name": "IgcRowToggleEventArgs", "declaration": { "name": "IgcRowToggleEventArgs" } }, { "kind": "js", "name": "IgcPinRowEventArgs", "declaration": { "name": "IgcPinRowEventArgs" } }, { "kind": "js", "name": "IgcActiveNodeChangeEventArgs", "declaration": { "name": "IgcActiveNodeChangeEventArgs" } }, { "kind": "js", "name": "IgcGridToolbarExportEventArgs", "declaration": { "name": "IgcGridToolbarExportEventArgs" } }, { "kind": "js", "name": "IgcForOfDataChangeEventArgs", "declaration": { "name": "IgcForOfDataChangeEventArgs" } }, { "kind": "js", "name": "IgcActionStripToken", "declaration": { "name": "IgcActionStripToken" } }, { "kind": "js", "name": "IgcGridRowDragGhostContext", "declaration": { "name": "IgcGridRowDragGhostContext" } }, { "kind": "js", "name": "IgcGridRowEditTextTemplateContext", "declaration": { "name": "IgcGridRowEditTextTemplateContext" } }, { "kind": "js", "name": "IgcGridEmptyTemplateContext", "declaration": { "name": "IgcGridEmptyTemplateContext" } }, { "kind": "js", "name": "IgcGridRowEditActionsTemplateContext", "declaration": { "name": "IgcGridRowEditActionsTemplateContext" } }, { "kind": "js", "name": "IgcGridRowTemplateContext", "declaration": { "name": "IgcGridRowTemplateContext" } }, { "kind": "js", "name": "IgcGridHeaderTemplateContext", "declaration": { "name": "IgcGridHeaderTemplateContext" } }, { "kind": "js", "name": "IgcGridToolbarComponent", "declaration": { "name": "IgcGridToolbarComponent" } }, { "kind": "js", "name": "IgcPaginatorComponent", "declaration": { "name": "IgcPaginatorComponent" } }, { "kind": "js", "name": "GridPagingMode", "declaration": { "name": "GridPagingMode" } }, { "kind": "js", "name": "GridValidationTrigger", "declaration": { "name": "GridValidationTrigger" } }, { "kind": "js", "name": "FilterMode", "declaration": { "name": "FilterMode" } }, { "kind": "js", "name": "GridSummaryPosition", "declaration": { "name": "GridSummaryPosition" } }, { "kind": "js", "name": "GridSummaryCalculationMode", "declaration": { "name": "GridSummaryCalculationMode" } }, { "kind": "js", "name": "IgcFilteringStrategy", "declaration": { "name": "IgcFilteringStrategy" } }, { "kind": "js", "name": "IgcGridSortingStrategy", "declaration": { "name": "IgcGridSortingStrategy" } }, { "kind": "js", "name": "IgcGridMergeStrategy", "declaration": { "name": "IgcGridMergeStrategy" } }, { "kind": "js", "name": "IgcSortingOptions", "declaration": { "name": "IgcSortingOptions" } }, { "kind": "js", "name": "IgcRowDirective", "declaration": { "name": "IgcRowDirective" } }, { "kind": "js", "name": "IgcHeadSelectorTemplateContext", "declaration": { "name": "IgcHeadSelectorTemplateContext" } }, { "kind": "js", "name": "IgcRowSelectorTemplateContext", "declaration": { "name": "IgcRowSelectorTemplateContext" } }, { "kind": "js", "name": "GridSelectionMode", "declaration": { "name": "GridSelectionMode" } }, { "kind": "js", "name": "GridCellMergeMode", "declaration": { "name": "GridCellMergeMode" } }, { "kind": "js", "name": "IgcSearchInfo", "declaration": { "name": "IgcSearchInfo" } }, { "kind": "js", "name": "IgcOverlayOutletDirective", "declaration": { "name": "IgcOverlayOutletDirective" } }, { "kind": "js", "name": "IgcGridRowComponent", "declaration": { "name": "IgcGridRowComponent" } }, { "kind": "js", "name": "DropPosition", "declaration": { "name": "DropPosition" } }, { "kind": "js", "name": "IgcCellPosition", "declaration": { "name": "IgcCellPosition" } }, { "kind": "js", "name": "IgcGroupByKey", "declaration": { "name": "IgcGroupByKey" } }, { "kind": "js", "name": "IgcGroupByRowSelectorTemplateDetails", "declaration": { "name": "IgcGroupByRowSelectorTemplateDetails" } }, { "kind": "js", "name": "IgcGridValidationState", "declaration": { "name": "IgcGridValidationState" } }, { "kind": "js", "name": "IgcGridToolbarTemplateContext", "declaration": { "name": "IgcGridToolbarTemplateContext" } }, { "kind": "js", "name": "IgcGridPaginatorTemplateContext", "declaration": { "name": "IgcGridPaginatorTemplateContext" } }, { "kind": "js", "name": "IgcGridCreatedEventArgs", "declaration": { "name": "IgcGridCreatedEventArgs" } }, { "kind": "js", "name": "IgcPivotDimensionStrategy", "declaration": { "name": "IgcPivotDimensionStrategy" } }, { "kind": "js", "name": "IgcPivotKeys", "declaration": { "name": "IgcPivotKeys" } }, { "kind": "js", "name": "PivotRowLayoutType", "declaration": { "name": "PivotRowLayoutType" } }, { "kind": "js", "name": "PivotSummaryPosition", "declaration": { "name": "PivotSummaryPosition" } }, { "kind": "js", "name": "IgcFieldType", "declaration": { "name": "IgcFieldType" } }, { "kind": "js", "name": "RowPinningPosition", "declaration": { "name": "RowPinningPosition" } }, { "kind": "js", "name": "IgcFieldPipeArgs", "declaration": { "name": "IgcFieldPipeArgs" } }, { "kind": "js", "name": "IgcFieldEditorOptions", "declaration": { "name": "IgcFieldEditorOptions" } }, { "kind": "js", "name": "PivotAggregationType", "declaration": { "name": "PivotAggregationType" } }, { "kind": "js", "name": "IgcPositionSettings", "declaration": { "name": "IgcPositionSettings" } }, { "kind": "js", "name": "IgcRowExportingEventArgs", "declaration": { "name": "IgcRowExportingEventArgs" } }, { "kind": "js", "name": "IgcColumnExportingEventArgs", "declaration": { "name": "IgcColumnExportingEventArgs" } }, { "kind": "js", "name": "IgcExporterOptionsBase", "declaration": { "name": "IgcExporterOptionsBase" } }, { "kind": "js", "name": "IgcCancelableEventArgs", "declaration": { "name": "IgcCancelableEventArgs" } }, { "kind": "js", "name": "ValidationStatus", "declaration": { "name": "ValidationStatus" } }, { "kind": "js", "name": "GridKeydownTargetType", "declaration": { "name": "GridKeydownTargetType" } }, { "kind": "js", "name": "IgcForOfDataChangingEventArgs", "declaration": { "name": "IgcForOfDataChangingEventArgs" } }, { "kind": "js", "name": "IgcHeaderType", "declaration": { "name": "IgcHeaderType" } }, { "kind": "js", "name": "IgcPageCancellableEventArgs", "declaration": { "name": "IgcPageCancellableEventArgs" } }, { "kind": "js", "name": "IgcPageEventArgs", "declaration": { "name": "IgcPageEventArgs" } }, { "kind": "js", "name": "IgcPaginatorResourceStrings", "declaration": { "name": "IgcPaginatorResourceStrings" } }, { "kind": "js", "name": "SortingOptionsMode", "declaration": { "name": "SortingOptionsMode" } }, { "kind": "js", "name": "IgcHeadSelectorTemplateDetails", "declaration": { "name": "IgcHeadSelectorTemplateDetails" } }, { "kind": "js", "name": "IgcRowSelectorTemplateDetails", "declaration": { "name": "IgcRowSelectorTemplateDetails" } }, { "kind": "js", "name": "IgcBaseSearchInfo", "declaration": { "name": "IgcBaseSearchInfo" } }, { "kind": "js", "name": "IgcValidationErrors", "declaration": { "name": "IgcValidationErrors" } }, { "kind": "js", "name": "HorizontalAlignment", "declaration": { "name": "HorizontalAlignment" } }, { "kind": "js", "name": "VerticalAlignment", "declaration": { "name": "VerticalAlignment" } }, { "kind": "js", "name": "IgcSize", "declaration": { "name": "IgcSize" } } ] } ] }