igniteui-webcomponents-grids/custom-elements.json

Ignite UI Web Components grid components.

{
  "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<IgcGridStateInfo>"
              }
            }
          ],
          "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": "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": "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<IgcColumnTemplateContext>"
              }
            },
            {
              "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<IgcSummaryTemplateContext>"
              }
            },
            {
              "kind": "field",
              "privacy": "public",
              "name": "bodyTemplate",
              "description": "Returns a reference to the `bodyTemplate`.",
              "type": {
                "text": "IgcRenderFunction<IgcCellTemplateContext>"
              }
            },
            {
              "kind": "field",
              "privacy": "public",
              "name": "headerTemplate",
              "description": "Returns a reference to the header template.",
              "type": {
                "text": "IgcRenderFunction<IgcColumnTemplateContext>"
              }
            },
            {
              "kind": "field",
              "privacy": "public",
              "name": "inlineEditorTemplate",
              "description": "Returns a reference to the inline editor template.",
              "type": {
                "text": "IgcRenderFunction<IgcCellTemplateContext>"
              }
            },
            {
              "kind": "field",
              "privacy": "public",
              "name": "errorTemplate",
              "description": "Returns a reference to the validation error template.",
              "type": {
                "text": "IgcRenderFunction<IgcCellTemplateContext>"
              }
            },
            {
              "kind": "field",
              "privacy": "public",
              "name": "filterCellTemplate",
              "description": "Returns a reference to the `filterCellTemplate`.",
              "type": {
                "text": "IgcRenderFunction<IgcColumnTemplateContext>"
              }
            },
            {
              "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": "any"
              }
            },
            {
              "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"