igniteui-webcomponents-grids

{ "schemaVersion": "1.0.0", "modules": [ { "kind": "javascript-module", "path": "grids/index.ts", "declarations": [ { "kind": "class", "name": "IgcGridComponent", "description": "Grid provides a way to present and manipulate tabular data.", "members": [ { "kind": "field", "privacy": "public", "name": "actionStripComponents", "attribute": "action-strip-components", "type": { "text": "IgcActionStripToken[]" } }, { "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<void>" } }, { "kind": "field", "privacy": "public", "name": "detailTemplate", "description": "Returns a reference to the master-detail template.", "type": { "text": "IgcRenderFunction<IgcGridMasterDetailContext>" } }, { "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.\n \n /* treatAsRef */", "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<IgcGroupByRowSelectorTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "groupRowTemplate", "description": "Gets/Sets the template reference for the group row.", "type": { "text": "IgcRenderFunction<IgcGroupByRowTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "showGroupArea", "description": "Returns whether the grid has group area.", "attribute": "show-group-area", "type": { "text": "boolean" } }, { "kind": "field", "privacy": "public", "name": "selectedCells", "description": "Returns an array of the selected grid cells.", "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<IgcGridTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "addRowEmptyTemplate", "description": "Gets/Sets a custom template for adding row UI when grid is empty.", "type": { "text": "IgcRenderFunction<void>" } }, { "kind": "field", "privacy": "public", "name": "loadingGridTemplate", "description": "Gets/Sets a custom template when loading.", "type": { "text": "IgcRenderFunction<IgcGridTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "summaryRowHeight", "description": "Get/Set summary row 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<IgcGridRowDragGhostContext>" } }, { "kind": "field", "privacy": "public", "name": "rowEditTextTemplate", "description": "Gets the row edit text template.", "type": { "text": "IgcRenderFunction<IgcGridRowEditTextTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "rowAddTextTemplate", "description": "Gets the row add text template.", "type": { "text": "IgcRenderFunction<IgcGridEmptyTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "rowEditActionsTemplate", "description": "Gets the row edit actions template.", "type": { "text": "IgcRenderFunction<IgcGridRowEditActionsTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "rowExpandedIndicatorTemplate", "description": "Gets the row expand indicator template.", "type": { "text": "IgcRenderFunction<IgcGridRowTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "rowCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction<IgcGridRowTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "headerExpandedIndicatorTemplate", "description": "Gets the header expand indicator template.", "type": { "text": "IgcRenderFunction<IgcGridTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "headerCollapsedIndicatorTemplate", "description": "Gets the row collapse indicator template.", "type": { "text": "IgcRenderFunction<IgcGridTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "excelStyleHeaderIconTemplate", "description": "Gets the excel style header icon.", "type": { "text": "IgcRenderFunction<IgcGridHeaderTemplateContext>" } }, { "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<IgcGridHeaderTemplateContext>" } }, { "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<IgcGridHeaderTemplateContext>" } }, { "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<IgcGridHeaderTemplateContext>" } }, { "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 grid.", "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 grid row.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "dataRowList", "description": "A list of currently rendered grid row's.", "readonly": true, "type": { "text": "IgcRowDirective[]" } }, { "kind": "field", "privacy": "public", "name": "headSelectorTemplate", "description": "Gets the header row selector template.", "type": { "text": "IgcRenderFunction<IgcHeadSelectorTemplateContext>" } }, { "kind": "field", "privacy": "public", "name": "rowSelectorTemplate", "description": "Gets the row selector template.", "type": { "text": "IgcRenderFunction<IgcRowSelectorTemplateContext>" } }, { "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<IgcGridEmptyTemplateContext>" } }, { "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": "transactions", "description": "Get transactions service for the grid.", "readonly": true, "type": { "text": "TransactionService" } }, { "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<any, boolean>" } }, { "kind": "field", "privacy": "public", "name": "outlet", "description": "Gets/Sets the outlet used to attach the grid's overlays to.", "deprecated": "Overlays now use the HTML Popover API and no longer move to the document body by default, so using outlet is also no longer needed.", "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 columns.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedColumns", "description": "Gets an array of the pinned columns.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedStartColumns", "description": "Gets an array of the pinned to the left columns.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedEndColumns", "description": "Gets an array of the pinned to the right columns.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "pinnedRows", "description": "Gets an array of the pinned rows.", "readonly": true, "type": { "text": "IgcGridRowComponent[]" } }, { "kind": "field", "privacy": "public", "name": "unpinnedColumns", "description": "Gets an array of unpinned columns.", "readonly": true, "type": { "text": "IgcColumnComponent[]" } }, { "kind": "field", "privacy": "public", "name": "visibleColumns", "description": "Returns an array of visible columns.", "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 column 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 grid row by index.", "parameters": [ { "name": "index", "type": { "text": "number" }, "optional": false } ], "return": { "type": { "text": "IgcRowType" } } }, { "kind": "method", "privacy": "public", "name": "getRowByKey", "description": "Returns grid row 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 grid header group.", "parameters": [ { "name": "column", "type": { "text": "IgcColumnComponent"