igniteui-webcomponents-grids/web-types.json

Ignite UI Web Components grid components.

{
    "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
    "name": "igniteui-api-analyzer",
    "version": "1.0.0",
    "description-markup": "markdown",    "contributions": {
      "html": {
        "elements": [{"name":"igc-grid-state","description":"State component allows saving and restoring the state of the grid features.\n---\n\n\n### **Events:**\n - **stateParsed** - Event emitted when set state is called with a string.  Returns the parsed state object so that it can be further modified before applying to the grid.","doc-url":"","attributes":[{"name":"options","description":"An object with options determining if a certain feature state should be saved.","value":{"type":"IgcGridStateOptions"}}],"events":[{"name":"stateParsed","type":"CustomEvent<IgcGridStateInfo>","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."}],"js":{"properties":[{"name":"options","description":"An object with options determining if a certain feature state should be saved.","type":"IgcGridStateOptions"}],"events":[{"name":"stateParsed","type":"CustomEvent<IgcGridStateInfo>","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."}]}},{"name":"igc-action-strip","description":"Action Strip provides templatable area for one or more actions.\n---\n","doc-url":"","attributes":[{"name":"action-buttons","description":"ActionButton as ContentChildren inside the Action Strip","value":{"type":"IgcGridActionsBaseDirective[]"}},{"name":"hidden","description":"Gets/Sets the visibility of the Action Strip.  Could be used to set if the Action Strip will be initially hidden.","value":{"type":"boolean"}},{"name":"resource-strings","description":"Gets/Sets the resource strings.","value":{"type":"IgcActionStripResourceStrings"}}],"events":[],"js":{"properties":[{"name":"actionButtons","description":"ActionButton as ContentChildren inside the Action Strip","type":"IgcGridActionsBaseDirective[]"},{"name":"hidden","description":"Gets/Sets the visibility of the Action Strip.  Could be used to set if the Action Strip will be initially hidden.","type":"boolean"},{"name":"resourceStrings","description":"Gets/Sets the resource strings.","type":"IgcActionStripResourceStrings"}],"events":[]}},{"name":"igc-grid-editing-actions","description":"Grid Editing Actions for the Action Strip\n---\n","doc-url":"","attributes":[{"name":"add-row","description":"An input to enable/disable action strip row adding button","value":{"type":"boolean"}},{"name":"edit-row","description":"An input to enable/disable action strip row editing button","value":{"type":"boolean"}},{"name":"delete-row","description":"An input to enable/disable action strip row deleting button","value":{"type":"boolean"}},{"name":"add-child","description":"An input to enable/disable action strip child row adding button","value":{"type":"boolean"}},{"name":"as-menu-items","description":"Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label.","value":{"type":"boolean"}}],"events":[],"js":{"properties":[{"name":"addRow","description":"An input to enable/disable action strip row adding button","type":"boolean"},{"name":"editRow","description":"An input to enable/disable action strip row editing button","type":"boolean"},{"name":"deleteRow","description":"An input to enable/disable action strip row deleting button","type":"boolean"},{"name":"hasChildren","type":"boolean"},{"name":"addChild","description":"An input to enable/disable action strip child row adding button","type":"boolean"},{"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.","type":"boolean"}],"events":[]}},{"name":"igc-grid-pinning-actions","description":"Grid Pinning Actions for the Action Strip\n---\n","doc-url":"","attributes":[{"name":"as-menu-items","description":"Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label.","value":{"type":"boolean"}}],"events":[],"js":{"properties":[{"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.","type":"boolean"}],"events":[]}},{"name":"igc-column-group","description":"**Ignite UI for Angular Column Group**\n---\n\n\n### **Events:**\n - **hiddenChange** - Emitted when the column is hidden or shown.\n- **expandedChange** - Emitted when the column expanded or collapsed.\n- **widthChange** - Emitted when the column width changes.\n- **pinnedChange** - Emitted when the column is pinned/unpinned.","doc-url":"","attributes":[{"name":"children","value":{"type":"HTMLCollection"}},{"name":"collapsible","description":"Set if the column group is collapsible.  Default value is `false`","value":{"type":"boolean"}},{"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`","value":{"type":"boolean"}},{"name":"field","description":"Sets/gets the `field` value.","value":{"type":"string"}},{"name":"header","description":"Sets/gets the `header` value.","value":{"type":"string"}},{"name":"title","description":"Sets/gets the `title` value.","value":{"type":"string"}},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"selectable","description":"Returns if the column is selectable.","value":{"type":"boolean"}},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","value":{"type":"boolean"}},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"autosize-header","description":"Sets/gets whether the column header is included in autosize logic.  Useful when template for a column header is sized based on parent, for example a default `div`.  Default value is `false`.","value":{"type":"boolean"}},{"name":"has-summary","description":"Gets a value indicating whether the summary for the column is enabled.","value":{"type":"boolean"}},{"name":"hidden","description":"Gets whether the column is hidden.","value":{"type":"boolean"}},{"name":"selected","description":"Returns if the column is selected.","value":{"type":"boolean"}},{"name":"disable-hiding","description":"Gets whether the hiding is disabled.","value":{"type":"boolean"}},{"name":"disable-pinning","description":"Gets whether the pinning is disabled.","value":{"type":"boolean"}},{"name":"width","description":"Gets the `width` of the column.","value":{"type":"string"}},{"name":"max-width","description":"Sets/gets the maximum `width` of the column.","value":{"type":"string"}},{"name":"header-classes","description":"Sets/gets the class selector of the column header.","value":{"type":"string"}},{"name":"header-styles","description":"Sets conditional style properties on the column header.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","value":{"type":"any"}},{"name":"header-group-classes","description":"Sets/gets the class selector of the column group header.","value":{"type":"string"}},{"name":"header-group-styles","description":"Sets conditional style properties on the column header group wrapper.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","value":{"type":"any"}},{"name":"cell-classes","description":"Sets a conditional class selector of the column cells.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class, while the  value is either a callback function that returns a boolean,  or boolean, like so:","value":{"type":"any"}},{"name":"cell-styles","description":"Sets conditional style properties on the column cells.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.  As with `cellClasses` it accepts a callback function.","value":{"type":"any"}},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","value":{"type":"any"}},{"name":"summary-formatter","description":"The summaryFormatter is used to format the display of the column summaries.   In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter  to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.","value":{"type":"any"}},{"name":"filtering-ignore-case","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","value":{"type":"boolean"}},{"name":"sorting-ignore-case","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","value":{"type":"boolean"}},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","value":{"type":"boolean"}},{"name":"data-type","description":"Sets/gets the data type of the column values.  Default value is `string`.","value":{"type":"GridColumnDataType"}},{"name":"row-end","description":"Row index where the current field should end.  The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field","value":{"type":"number"}},{"name":"col-end","description":"Column index where the current field should end.  The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field","value":{"type":"number"}},{"name":"row-start","description":"Row index from which the field is starting.","value":{"type":"number"}},{"name":"col-start","description":"Column index from which the field is starting.","value":{"type":"number"}},{"name":"additional-template-context","description":"Sets/gets custom properties provided in additional template context.","value":{"type":"any"}},{"name":"min-width","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","value":{"type":"string"}},{"name":"pinned","description":"Gets whether the column is `pinned`.","value":{"type":"boolean"}},{"name":"summaries","description":"Gets the column `summaries`.","value":{"type":"any"}},{"name":"disabled-summaries","description":"Sets/gets the summary operands to exclude from display.  Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.","value":{"type":"string[]"}},{"name":"filters","description":"Gets the column `filters`.","value":{"type":"IgcFilteringOperand"}},{"name":"sort-strategy","description":"Gets the column `sortStrategy`.","value":{"type":"IgcSortingStrategy"}},{"name":"visible-when-collapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","value":{"type":"boolean"}},{"name":"pipe-args","value":{"type":"IgcColumnPipeArgs"}},{"name":"editor-options","description":"Pass optional properties for the default column editors.","value":{"type":"IgcColumnEditorOptions"}},{"name":"parent","description":"Sets/gets the parent column.","value":{"type":"any"}}],"events":[{"name":"hiddenChange","type":"CustomEvent<boolean>","description":"Emitted when the column is hidden or shown."},{"name":"expandedChange","type":"CustomEvent<boolean>","description":"Emitted when the column expanded or collapsed."},{"name":"widthChange","type":"CustomEvent<string>","description":"Emitted when the column width changes."},{"name":"pinnedChange","type":"CustomEvent<boolean>","description":"Emitted when the column is pinned/unpinned."}],"js":{"properties":[{"name":"children","type":"HTMLCollection"},{"name":"collapsible","description":"Set if the column group is collapsible.  Default value is `false`","type":"boolean"},{"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`","type":"boolean"},{"name":"summaries","description":"Gets the column group `summaries`.","type":"any"},{"name":"filters","description":"Gets the column group `filters`.","type":"any"},{"name":"selectable","description":"Returns if the column group is selectable","type":"boolean"},{"name":"collapsibleIndicatorTemplate","description":"Allows you to define a custom template for expand/collapse indicator","type":"IgcRenderFunction<IgcColumnTemplateContext>"},{"name":"hidden","description":"Gets whether the column group is hidden.","type":"boolean"},{"name":"selected","description":"Returns if the column group is selected.","type":"boolean"},{"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.","type":"IgcColumnComponent[]"},{"name":"columnGroup","description":"Returns a boolean indicating if the column is a `ColumnGroup`.","type":"boolean"},{"name":"columnLayout","description":"Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.","type":"boolean"},{"name":"width","description":"Gets the width of the column group.","type":"string"},{"name":"field","description":"Sets/gets the `field` value.","type":"string"},{"name":"header","description":"Sets/gets the `header` value.","type":"string"},{"name":"title","description":"Sets/gets the `title` value.","type":"string"},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","type":"boolean"},{"name":"selectable","description":"Returns if the column is selectable.","type":"boolean"},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","type":"boolean"},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","type":"boolean"},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","type":"boolean"},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","type":"boolean"},{"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`.","type":"boolean"},{"name":"hasSummary","description":"Gets a value indicating whether the summary for the column is enabled.","type":"boolean"},{"name":"hidden","description":"Gets whether the column is hidden.","type":"boolean"},{"name":"selected","description":"Returns if the column is selected.","type":"boolean"},{"name":"disableHiding","description":"Gets whether the hiding is disabled.","type":"boolean"},{"name":"disablePinning","description":"Gets whether the pinning is disabled.","type":"boolean"},{"name":"width","description":"Gets the `width` of the column.","type":"string"},{"name":"maxWidth","description":"Sets/gets the maximum `width` of the column.","type":"string"},{"name":"headerClasses","description":"Sets/gets the class selector of the column header.","type":"string"},{"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.","type":"any"},{"name":"headerGroupClasses","description":"Sets/gets the class selector of the column group header.","type":"string"},{"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.","type":"any"},{"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:","type":"any"},{"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.","type":"any"},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","type":"any"},{"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.","type":"any"},{"name":"filteringIgnoreCase","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","type":"boolean"},{"name":"sortingIgnoreCase","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","type":"boolean"},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","type":"boolean"},{"name":"dataType","description":"Sets/gets the data type of the column values.  Default value is `string`.","type":"GridColumnDataType"},{"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","type":"number"},{"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","type":"number"},{"name":"rowStart","description":"Row index from which the field is starting.","type":"number"},{"name":"colStart","description":"Column index from which the field is starting.","type":"number"},{"name":"additionalTemplateContext","description":"Sets/gets custom properties provided in additional template context.","type":"any"},{"name":"minWidth","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","type":"string"},{"name":"index","description":"Gets the column index.","type":"number"},{"name":"pinned","description":"Gets whether the column is `pinned`.","type":"boolean"},{"name":"summaries","description":"Gets the column `summaries`.","type":"any"},{"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.","type":"string[]"},{"name":"filters","description":"Gets the column `filters`.","type":"IgcFilteringOperand"},{"name":"sortStrategy","description":"Gets the column `sortStrategy`.","type":"IgcSortingStrategy"},{"name":"summaryTemplate","description":"Returns a reference to the `summaryTemplate`.","type":"IgcRenderFunction<IgcSummaryTemplateContext>"},{"name":"bodyTemplate","description":"Returns a reference to the `bodyTemplate`.","type":"IgcRenderFunction<IgcCellTemplateContext>"},{"name":"headerTemplate","description":"Returns a reference to the header template.","type":"IgcRenderFunction<IgcColumnTemplateContext>"},{"name":"inlineEditorTemplate","description":"Returns a reference to the inline editor template.","type":"IgcRenderFunction<IgcCellTemplateContext>"},{"name":"errorTemplate","description":"Returns a reference to the validation error template.","type":"IgcRenderFunction<IgcCellTemplateContext>"},{"name":"filterCellTemplate","description":"Returns a reference to the `filterCellTemplate`.","type":"IgcRenderFunction<IgcColumnTemplateContext>"},{"name":"visibleIndex","description":"Gets the column visible index.  If the column is not visible, returns `-1`.","type":"number"},{"name":"columnGroup","description":"Returns a boolean indicating if the column is a `ColumnGroup`.","type":"boolean"},{"name":"columnLayout","description":"Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.","type":"boolean"},{"name":"columnLayoutChild","description":"Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout.","type":"boolean"},{"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.","type":"IgcColumnComponent[]"},{"name":"level","description":"Returns the level of the column in a column group.  Returns `0` if the column doesn't have a `parent`.","type":"number"},{"name":"visibleWhenCollapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","type":"boolean"},{"name":"pipeArgs","type":"IgcColumnPipeArgs"},{"name":"editorOptions","description":"Pass optional properties for the default column editors.","type":"IgcColumnEditorOptions"},{"name":"filteringExpressionsTree","description":"Returns the filteringExpressionsTree of the column.","type":"IgcFilteringExpressionsTree"},{"name":"parent","description":"Sets/gets the parent column.","type":"any"},{"name":"topLevelParent","description":"Returns a reference to the top level parent column.","type":"IgcColumnComponent"}],"events":[{"name":"hiddenChange","type":"CustomEvent<boolean>","description":"Emitted when the column is hidden or shown."},{"name":"expandedChange","type":"CustomEvent<boolean>","description":"Emitted when the column expanded or collapsed."},{"name":"widthChange","type":"CustomEvent<string>","description":"Emitted when the column width changes."},{"name":"pinnedChange","type":"CustomEvent<boolean>","description":"Emitted when the column is pinned/unpinned."}]}},{"name":"igc-column","description":"**Ignite UI for Angular Column** -  [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid#columns-configuration)   The Ignite UI Column is used within an `igx-grid` element to define what data the column will show. Features such as sorting,  filtering & editing are enabled at the column level.  You can also provide a template containing custom content inside  the column using `ng-template` which will be used for all cells within the column.\n---\n\n\n### **Events:**\n - **hiddenChange** - Emitted when the column is hidden or shown.\n- **expandedChange** - Emitted when the column expanded or collapsed.\n- **widthChange** - Emitted when the column width changes.\n- **pinnedChange** - Emitted when the column is pinned/unpinned.","doc-url":"","attributes":[{"name":"field","description":"Sets/gets the `field` value.","value":{"type":"string"}},{"name":"header","description":"Sets/gets the `header` value.","value":{"type":"string"}},{"name":"title","description":"Sets/gets the `title` value.","value":{"type":"string"}},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"selectable","description":"Returns if the column is selectable.","value":{"type":"boolean"}},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","value":{"type":"boolean"}},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"autosize-header","description":"Sets/gets whether the column header is included in autosize logic.  Useful when template for a column header is sized based on parent, for example a default `div`.  Default value is `false`.","value":{"type":"boolean"}},{"name":"has-summary","description":"Gets a value indicating whether the summary for the column is enabled.","value":{"type":"boolean"}},{"name":"hidden","description":"Gets whether the column is hidden.","value":{"type":"boolean"}},{"name":"selected","description":"Returns if the column is selected.","value":{"type":"boolean"}},{"name":"disable-hiding","description":"Gets whether the hiding is disabled.","value":{"type":"boolean"}},{"name":"disable-pinning","description":"Gets whether the pinning is disabled.","value":{"type":"boolean"}},{"name":"width","description":"Gets the `width` of the column.","value":{"type":"string"}},{"name":"max-width","description":"Sets/gets the maximum `width` of the column.","value":{"type":"string"}},{"name":"header-classes","description":"Sets/gets the class selector of the column header.","value":{"type":"string"}},{"name":"header-styles","description":"Sets conditional style properties on the column header.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","value":{"type":"any"}},{"name":"header-group-classes","description":"Sets/gets the class selector of the column group header.","value":{"type":"string"}},{"name":"header-group-styles","description":"Sets conditional style properties on the column header group wrapper.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","value":{"type":"any"}},{"name":"cell-classes","description":"Sets a conditional class selector of the column cells.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class, while the  value is either a callback function that returns a boolean,  or boolean, like so:","value":{"type":"any"}},{"name":"cell-styles","description":"Sets conditional style properties on the column cells.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.  As with `cellClasses` it accepts a callback function.","value":{"type":"any"}},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","value":{"type":"any"}},{"name":"summary-formatter","description":"The summaryFormatter is used to format the display of the column summaries.   In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter  to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.","value":{"type":"any"}},{"name":"filtering-ignore-case","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","value":{"type":"boolean"}},{"name":"sorting-ignore-case","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","value":{"type":"boolean"}},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","value":{"type":"boolean"}},{"name":"data-type","description":"Sets/gets the data type of the column values.  Default value is `string`.","value":{"type":"GridColumnDataType"}},{"name":"row-end","description":"Row index where the current field should end.  The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field","value":{"type":"number"}},{"name":"col-end","description":"Column index where the current field should end.  The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field","value":{"type":"number"}},{"name":"row-start","description":"Row index from which the field is starting.","value":{"type":"number"}},{"name":"col-start","description":"Column index from which the field is starting.","value":{"type":"number"}},{"name":"additional-template-context","description":"Sets/gets custom properties provided in additional template context.","value":{"type":"any"}},{"name":"min-width","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","value":{"type":"string"}},{"name":"pinned","description":"Gets whether the column is `pinned`.","value":{"type":"boolean"}},{"name":"summaries","description":"Gets the column `summaries`.","value":{"type":"any"}},{"name":"disabled-summaries","description":"Sets/gets the summary operands to exclude from display.  Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.","value":{"type":"string[]"}},{"name":"filters","description":"Gets the column `filters`.","value":{"type":"IgcFilteringOperand"}},{"name":"sort-strategy","description":"Gets the column `sortStrategy`.","value":{"type":"IgcSortingStrategy"}},{"name":"visible-when-collapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","value":{"type":"boolean"}},{"name":"pipe-args","value":{"type":"IgcColumnPipeArgs"}},{"name":"editor-options","description":"Pass optional properties for the default column editors.","value":{"type":"IgcColumnEditorOptions"}},{"name":"parent","description":"Sets/gets the parent column.","value":{"type":"any"}}],"events":[{"name":"hiddenChange","type":"CustomEvent<boolean>","description":"Emitted when the column is hidden or shown."},{"name":"expandedChange","type":"CustomEvent<boolean>","description":"Emitted when the column expanded or collapsed."},{"name":"widthChange","type":"CustomEvent<string>","description":"Emitted when the column width changes."},{"name":"pinnedChange","type":"CustomEvent<boolean>","description":"Emitted when the column is pinned/unpinned."}],"js":{"properties":[{"name":"field","description":"Sets/gets the `field` value.","type":"string"},{"name":"header","description":"Sets/gets the `header` value.","type":"string"},{"name":"title","description":"Sets/gets the `title` value.","type":"string"},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","type":"boolean"},{"name":"selectable","description":"Returns if the column is selectable.","type":"boolean"},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","type":"boolean"},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","type":"boolean"},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","type":"boolean"},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","type":"boolean"},{"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`.","type":"boolean"},{"name":"hasSummary","description":"Gets a value indicating whether the summary for the column is enabled.","type":"boolean"},{"name":"hidden","description":"Gets whether the column is hidden.","type":"boolean"},{"name":"selected","description":"Returns if the column is selected.","type":"boolean"},{"name":"disableHiding","description":"Gets whether the hiding is disabled.","type":"boolean"},{"name":"disablePinning","description":"Gets whether the pinning is disabled.","type":"boolean"},{"name":"width","description":"Gets the `width` of the column.","type":"string"},{"name":"maxWidth","description":"Sets/gets the maximum `width` of the column.","type":"string"},{"name":"headerClasses","description":"Sets/gets the class selector of the column header.","type":"string"},{"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.","type":"any"},{"name":"headerGroupClasses","description":"Sets/gets the class selector of the column group header.","type":"string"},{"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.","type":"any"},{"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:","type":"any"},{"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.","type":"any"},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","type":"any"},{"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.","type":"any"},{"name":"filteringIgnoreCase","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","type":"boolean"},{"name":"sortingIgnoreCase","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","type":"boolean"},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","type":"boolean"},{"name":"dataType","description":"Sets/gets the data type of the column values.  Default value is `string`.","type":"GridColumnDataType"},{"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","type":"number"},{"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","type":"number"},{"name":"rowStart","description":"Row index from which the field is starting.","type":"number"},{"name":"colStart","description":"Column index from which the field is starting.","type":"number"},{"name":"additionalTemplateContext","description":"Sets/gets custom properties provided in additional template context.","type":"any"},{"name":"minWidth","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","type":"string"},{"name":"index","description":"Gets the column index.","type":"number"},{"name":"pinned","description":"Gets whether the column is `pinned`.","type":"boolean"},{"name":"summaries","description":"Gets the column `summaries`.","type":"any"},{"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.","type":"string[]"},{"name":"filters","description":"Gets the column `filters`.","type":"IgcFilteringOperand"},{"name":"sortStrategy","description":"Gets the column `sortStrategy`.","type":"IgcSortingStrategy"},{"name":"summaryTemplate","description":"Returns a reference to the `summaryTemplate`.","type":"IgcRenderFunction<IgcSummaryTemplateContext>"},{"name":"bodyTemplate","description":"Returns a reference to the `bodyTemplate`.","type":"IgcRenderFunction<IgcCellTemplateContext>"},{"name":"headerTemplate","description":"Returns a reference to the header template.","type":"IgcRenderFunction<IgcColumnTemplateContext>"},{"name":"inlineEditorTemplate","description":"Returns a reference to the inline editor template.","type":"IgcRenderFunction<IgcCellTemplateContext>"},{"name":"errorTemplate","description":"Returns a reference to the validation error template.","type":"IgcRenderFunction<IgcCellTemplateContext>"},{"name":"filterCellTemplate","description":"Returns a reference to the `filterCellTemplate`.","type":"IgcRenderFunction<IgcColumnTemplateContext>"},{"name":"visibleIndex","description":"Gets the column visible index.  If the column is not visible, returns `-1`.","type":"number"},{"name":"columnGroup","description":"Returns a boolean indicating if the column is a `ColumnGroup`.","type":"boolean"},{"name":"columnLayout","description":"Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.","type":"boolean"},{"name":"columnLayoutChild","description":"Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout.","type":"boolean"},{"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.","type":"IgcColumnComponent[]"},{"name":"level","description":"Returns the level of the column in a column group.  Returns `0` if the column doesn't have a `parent`.","type":"number"},{"name":"visibleWhenCollapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","type":"boolean"},{"name":"pipeArgs","type":"IgcColumnPipeArgs"},{"name":"editorOptions","description":"Pass optional properties for the default column editors.","type":"IgcColumnEditorOptions"},{"name":"filteringExpressionsTree","description":"Returns the filteringExpressionsTree of the column.","type":"IgcFilteringExpressionsTree"},{"name":"parent","description":"Sets/gets the parent column.","type":"any"},{"name":"topLevelParent","description":"Returns a reference to the top level parent column.","type":"IgcColumnComponent"}],"events":[{"name":"hiddenChange","type":"CustomEvent<boolean>","description":"Emitted when the column is hidden or shown."},{"name":"expandedChange","type":"CustomEvent<boolean>","description":"Emitted when the column expanded or collapsed."},{"name":"widthChange","type":"CustomEvent<string>","description":"Emitted when the column width changes."},{"name":"pinnedChange","type":"CustomEvent<boolean>","description":"Emitted when the column is pinned/unpinned."}]}},{"name":"igc-column-layout","description":"Column layout for declaration of Multi-row Layout\n---\n\n\n### **Events:**\n - **hiddenChange** - Emitted when the column is hidden or shown.\n- **expandedChange** - Emitted when the column expanded or collapsed.\n- **widthChange** - Emitted when the column width changes.\n- **pinnedChange** - Emitted when the column is pinned/unpinned.","doc-url":"","attributes":[{"name":"children","value":{"type":"HTMLCollection"}},{"name":"collapsible","description":"Set if the column group is collapsible.  Default value is `false`","value":{"type":"boolean"}},{"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`","value":{"type":"boolean"}},{"name":"field","description":"Sets/gets the `field` value.","value":{"type":"string"}},{"name":"header","description":"Sets/gets the `header` value.","value":{"type":"string"}},{"name":"title","description":"Sets/gets the `title` value.","value":{"type":"string"}},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"selectable","description":"Returns if the column is selectable.","value":{"type":"boolean"}},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","value":{"type":"boolean"}},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","value":{"type":"boolean"}},{"name":"autosize-header","description":"Sets/gets whether the column header is included in autosize logic.  Useful when template for a column header is sized based on parent, for example a default `div`.  Default value is `false`.","value":{"type":"boolean"}},{"name":"has-summary","description":"Gets a value indicating whether the summary for the column is enabled.","value":{"type":"boolean"}},{"name":"hidden","description":"Gets whether the column is hidden.","value":{"type":"boolean"}},{"name":"selected","description":"Returns if the column is selected.","value":{"type":"boolean"}},{"name":"disable-hiding","description":"Gets whether the hiding is disabled.","value":{"type":"boolean"}},{"name":"disable-pinning","description":"Gets whether the pinning is disabled.","value":{"type":"boolean"}},{"name":"width","description":"Gets the `width` of the column.","value":{"type":"string"}},{"name":"max-width","description":"Sets/gets the maximum `width` of the column.","value":{"type":"string"}},{"name":"header-classes","description":"Sets/gets the class selector of the column header.","value":{"type":"string"}},{"name":"header-styles","description":"Sets conditional style properties on the column header.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","value":{"type":"any"}},{"name":"header-group-classes","description":"Sets/gets the class selector of the column group header.","value":{"type":"string"}},{"name":"header-group-styles","description":"Sets conditional style properties on the column header group wrapper.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.","value":{"type":"any"}},{"name":"cell-classes","description":"Sets a conditional class selector of the column cells.  Accepts an object literal, containing key-value pairs,  where the key is the name of the CSS class, while the  value is either a callback function that returns a boolean,  or boolean, like so:","value":{"type":"any"}},{"name":"cell-styles","description":"Sets conditional style properties on the column cells.  Similar to `ngStyle` it accepts an object literal where the keys are  the style properties and the value is the expression to be evaluated.  As with `cellClasses` it accepts a callback function.","value":{"type":"any"}},{"name":"formatter","description":"Applies display format to cell values in the column. Does not modify the underlying data.","value":{"type":"any"}},{"name":"summary-formatter","description":"The summaryFormatter is used to format the display of the column summaries.   In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter  to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.","value":{"type":"any"}},{"name":"filtering-ignore-case","description":"Sets/gets whether the column filtering should be case sensitive.  Default value is `true`.","value":{"type":"boolean"}},{"name":"sorting-ignore-case","description":"Sets/gets whether the column sorting should be case sensitive.  Default value is `true`.","value":{"type":"boolean"}},{"name":"searchable","description":"Sets/gets whether the column is `searchable`.  Default value is `true`.","value":{"type":"boolean"}},{"name":"data-type","description":"Sets/gets the data type of the column values.  Default value is `string`.","value":{"type":"GridColumnDataType"}},{"name":"row-end","description":"Row index where the current field should end.  The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field","value":{"type":"number"}},{"name":"col-end","description":"Column index where the current field should end.  The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field","value":{"type":"number"}},{"name":"row-start","description":"Row index from which the field is starting.","value":{"type":"number"}},{"name":"col-start","description":"Column index from which the field is starting.","value":{"type":"number"}},{"name":"additional-template-context","description":"Sets/gets custom properties provided in additional template context.","value":{"type":"any"}},{"name":"min-width","description":"Sets/gets the minimum `width` of the column.  Default value is `88`;","value":{"type":"string"}},{"name":"pinned","description":"Gets whether the column is `pinned`.","value":{"type":"boolean"}},{"name":"summaries","description":"Gets the column `summaries`.","value":{"type":"any"}},{"name":"disabled-summaries","description":"Sets/gets the summary operands to exclude from display.  Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.","value":{"type":"string[]"}},{"name":"filters","description":"Gets the column `filters`.","value":{"type":"IgcFilteringOperand"}},{"name":"sort-strategy","description":"Gets the column `sortStrategy`.","value":{"type":"IgcSortingStrategy"}},{"name":"visible-when-collapsed","description":"Indicates whether the column will be visible when its parent is collapsed.","value":{"type":"boolean"}},{"name":"pipe-args","value":{"type":"IgcColumnPipeArgs"}},{"name":"editor-options","description":"Pass optional properties for the default column editors.","value":{"type":"IgcColumnEditorOptions"}},{"name":"parent","description":"Sets/gets the parent column.","value":{"type":"any"}}],"events":[{"name":"hiddenChange","type":"CustomEvent<boolean>","description":"Emitted when the column is hidden or shown."},{"name":"expandedChange","type":"CustomEvent<boolean>","description":"Emitted when the column expanded or collapsed."},{"name":"widthChange","type":"CustomEvent<string>","description":"Emitted when the column width changes."},{"name":"pinnedChange","type":"CustomEvent<boolean>","description":"Emitted when the column is pinned/unpinned."}],"js":{"properties":[{"name":"width","description":"Gets the width of the column layout.","type":"any"},{"name":"visibleIndex","description":"Gets the column visible index.  If the column is not visible, returns `-1`.","type":"number"},{"name":"children","type":"HTMLCollection"},{"name":"collapsible","description":"Set if the column group is collapsible.  Default value is `false`","type":"boolean"},{"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`","type":"boolean"},{"name":"summaries","description":"Gets the column group `summaries`.","type":"any"},{"name":"filters","description":"Gets the column group `filters`.","type":"any"},{"name":"selectable","description":"Returns if the column group is selectable","type":"boolean"},{"name":"collapsibleIndicatorTemplate","description":"Allows you to define a custom template for expand/collapse indicator","type":"IgcRenderFunction<IgcColumnTemplateContext>"},{"name":"hidden","description":"Gets whether the column group is hidden.","type":"boolean"},{"name":"selected","description":"Returns if the column group is selected.","type":"boolean"},{"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.","type":"IgcColumnComponent[]"},{"name":"columnGroup","description":"Returns a boolean indicating if the column is a `ColumnGroup`.","type":"boolean"},{"name":"columnLayout","description":"Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.","type":"boolean"},{"name":"width","description":"Gets the width of the column group.","type":"string"},{"name":"field","description":"Sets/gets the `field` value.","type":"string"},{"name":"header","description":"Sets/gets the `header` value.","type":"string"},{"name":"title","description":"Sets/gets the `title` value.","type":"string"},{"name":"sortable","description":"Sets/gets whether the column is sortable.  Default value is `false`.","type":"boolean"},{"name":"selectable","description":"Returns if the column is selectable.","type":"boolean"},{"name":"groupable","description":"Sets/gets whether the column is groupable.  Default value is `false`.","type":"boolean"},{"name":"editable","description":"Gets whether the column is editable.  Default value is `false`.","type":"boolean"},{"name":"filterable","description":"Sets/gets whether the column is filterable.  Default value is `true`.","type":"boolean"},{"name":"resizable","description":"Sets/gets whether the column is resizable.  Default value is `false`.","type":"boolean"},{"name":"autosizeHeader","description":"Sets/gets whether the column header is included in autosize l