{"_meta":{"branch":"master","commit":"f7904e1299fbfa801b792de7bb8629adcf41328b","version":"13.0.0"},"accessibility":{"children":{"enabled":{"doclet":{"description":"Enable accessibility features for the Grid.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"accessibility.enabled","name":"enabled","default":true},"children":{}},"highContrastMode":{"doclet":{"description":"The default option is auto, which applies the high contrast theme the\nuser's system has a high contrast theme active.","type":{"names":["boolean","'auto'"]}},"meta":{"fullname":"accessibility.highContrastMode","name":"highContrastMode"},"children":{}},"announcements":{"doclet":{"description":"VoiceOver announcer options for Grid actions.","type":{"names":["A11yAnnouncementsOptions"]}},"meta":{"fullname":"accessibility.announcements","name":"announcements"},"children":{"sorting":{"doclet":{"description":"Enable accessibility announcements for the sorting.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"accessibility.announcements.sorting","name":"sorting","default":true},"children":{}},"filtering":{"doclet":{"description":"Enable accessibility announcements for the filtering.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"accessibility.announcements.filtering","name":"filtering","default":true},"children":{}},"cellEditing":{"doclet":{"description":"Enable accessibility announcements for the cell editing.","defaultvalue":true,"type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"accessibility.announcements.cellEditing","name":"cellEditing","default":true},"children":{}},"rowPinning":{"doclet":{"description":"Enable accessibility announcements for row pinning changes.","defaultvalue":true,"type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"accessibility.announcements.rowPinning","name":"rowPinning","default":true},"children":{}}}},"screenReaderSection":{"doclet":{"description":"Options for screen reader sections before and after the Grid.","samples":[{"name":"Screen reader sections","value":"grid-lite/options/screen-reader-section"}],"type":{"names":["ScreenReaderSectionOptions"]}},"meta":{"fullname":"accessibility.screenReaderSection","name":"screenReaderSection"},"children":{"beforeGridFormatter":{"doclet":{"description":"A formatter function to create the HTML contents of the hidden screen\nreader information region before the Grid.<p>Callback parameters:</p><ul><li><code>grid</code> — <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a></li></ul>","type":{"names":["(grid: Grid) => string"]}},"meta":{"fullname":"accessibility.screenReaderSection.beforeGridFormatter","name":"beforeGridFormatter"},"children":{}},"beforeGridFormat":{"doclet":{"description":"Format for the screen reader information region before the Grid.\nSupported HTML tags are h1-h6, p, div. Attributes are not supported.\n\nAvailable template variables:\n- {gridTitle}: The Grid caption/title.\n- {gridDescription}: The Grid description.\n- {rowCount}: Number of rows in the Grid.\n- {columnCount}: Number of columns in the Grid.","defaultvalue":"<div>{gridTitle}</div><div>{gridDescription}</div><div>Grid with {rowCount} rows and {columnCount} columns.</div>","type":{"names":["string"]}},"meta":{"fullname":"accessibility.screenReaderSection.beforeGridFormat","name":"beforeGridFormat","default":"<div>{gridTitle}</div><div>{gridDescription}</div><div>Grid with {rowCount} rows and {columnCount} columns.</div>"},"children":{}},"afterGridFormatter":{"doclet":{"description":"A formatter function to create the HTML contents of the hidden screen\nreader information region after the Grid.<p>Callback parameters:</p><ul><li><code>grid</code> — <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a></li></ul>","type":{"names":["(grid: Grid) => string"]}},"meta":{"fullname":"accessibility.screenReaderSection.afterGridFormatter","name":"afterGridFormatter"},"children":{}},"afterGridFormat":{"doclet":{"description":"Format for the screen reader information region after the Grid.","defaultvalue":"End of Grid.","type":{"names":["string"]}},"meta":{"fullname":"accessibility.screenReaderSection.afterGridFormat","name":"afterGridFormat","default":"End of Grid."},"children":{}}}}},"doclet":{"description":"Accessibility options for the grid.","type":{"names":["A11yOptions"]}},"meta":{"fullname":"accessibility","name":"accessibility"}},"caption":{"children":{"className":{"doclet":{"description":"The custom CSS class name for the table caption.","type":{"names":["string"]}},"meta":{"fullname":"caption.className","name":"className"},"children":{}},"htmlTag":{"doclet":{"description":"The HTML tag to use for the caption. When set, the caption is rendered\nas that element (e.g. `h1`, `p`, `span`). Must be one of\n[AST.allowedTags](https://api.highcharts.com/class-reference/Highcharts.AST#allowedTags)\n(e.g. `div`, `p`, `span`, `h1`–`h6`).","defaultvalue":"div","type":{"names":["string"]}},"meta":{"fullname":"caption.htmlTag","name":"htmlTag","default":"div"},"children":{}},"text":{"doclet":{"description":"The caption of the grid.","samples":[{"name":"Caption text","value":"grid-lite/options/caption-text"}],"type":{"names":["string"]}},"meta":{"fullname":"caption.text","name":"text"},"children":{}}},"doclet":{"description":"Options for the table caption.","type":{"names":["CaptionOptions"]}},"meta":{"fullname":"caption","name":"caption"}},"columnDefaults":{"children":{"cells":{"doclet":{"description":"Options for all cells in the column.","type":{"names":["ColumnCellOptions"]}},"meta":{"fullname":"columnDefaults.cells","name":"cells"},"children":{"rowHeader":{"doclet":{"description":"Whether cells in this column should be rendered as row header cells.\n\nWhen enabled, body cells are rendered as `<th scope=\"row\">` instead of\n`<td>`. This is useful for accessible data grids where the first column\nacts as a row header.","defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.cells.rowHeader","name":"rowHeader","default":"false"},"children":{}},"className":{"doclet":{"description":"Allows to define an additional class name to all table cells in the\ncolumn. Applied only to cell that are in the table, not in the column\nheader. It is updated with every cell's value change.\n\nIt uses templating, where context is the table cell instance.","defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columnDefaults.cells.className","name":"className","default":"undefined"},"children":{}},"format":{"doclet":{"description":"The format of the cell content within the given column of the grid.\nApplied only to cell that are in the table, not in the column header.\n\nWhen not set, the default format `'{value}'` is used.","samples":[{"name":"Cell formatting","value":"grid-pro/basic/cell-formatting"}],"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columnDefaults.cells.format","name":"format","default":"undefined"},"children":{}},"formatter":{"doclet":{"description":"Callback function for formatting cells within the given column of the\ngrid. Applied only to cell that are in the table not the column\nheader.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Cell.Cell.html\">Cell</a> instance.</p>","samples":[{"name":"Cell formatting","value":"grid-pro/basic/cell-formatting"}],"return":"A string to be set as a table cell's content.","type":{"names":["(this: Cell) => string"]}},"meta":{"fullname":"columnDefaults.cells.formatter","name":"formatter"},"children":{}},"valueGetter":{"doclet":{"description":"Callback function to resolve the value of an unbound column cell.\nFor bound columns, overrides only the rendered content - sorting,\nfiltering, and export remain unaffected.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p><p>Callback parameters:</p><ul><li><code>cell</code> — <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a></li></ul>","type":{"names":["( this: TableCell, cell: TableCell ) => (DataTableCellType | Promise<DataTableCellType>)"]}},"meta":{"fullname":"columnDefaults.cells.valueGetter","name":"valueGetter"},"children":{}},"contextMenu":{"doclet":{"description":"Context menu options for table body cells. When configured, a custom\ncontext menu will be shown on right-click.","samples":[{"name":"Cell context menu","value":"grid-lite/demo/cell-context-menu"},{"name":"Cell context menu with built-ins","value":"grid-pro/basic/cell-context-menu"}],"type":{"names":["CellContextMenuOptions"]}},"meta":{"fullname":"columnDefaults.cells.contextMenu","name":"contextMenu"},"children":{"enabled":{"doclet":{"description":"Whether the cell context menu is enabled. When omitted, the menu is\nenabled when `items` are provided, or when a composed feature registers\nvisible built-in actions for the current cell.","type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.cells.contextMenu.enabled","name":"enabled"},"children":{}},"items":{"doclet":{"description":"List of items to show in the cell context menu.","type":{"names":["(CellContextMenuDividerItemOptions | CellContextMenuTypedDividerItemOptions | CellContextMenuActionItemOptions | CellContextMenuSubmenuItemOptions | CellContextMenuBuiltInItemOptions | CellContextMenuBuiltInGroupItemOptions | CellContextMenuActionId | CellContextMenuGroupId)[]"]},"supportsArray":true},"meta":{"fullname":"columnDefaults.cells.contextMenu.items","name":"items"},"children":{}}}},"style":{"doclet":{"description":"CSS styles for table body cells in the column.\nCan be a static style object or a callback that returns one.","type":{"names":["StyleValue<Cell>"]}},"meta":{"fullname":"columnDefaults.cells.style","name":"style"},"children":{}},"editMode":{"doclet":{"description":"Whether to enabled the cell edit mode functionality. It allows to\nedit the cell value in a separate input field that is displayed\nafter double-clicking the cell or pressing the Enter key.","samples":[{"name":"Cell editing","value":"grid-pro/basic/cell-editing"}],"type":{"names":["ColumnEditModeOptions"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode","name":"editMode"},"children":{"enabled":{"doclet":{"description":"Whether to enable the cell edit mode functionality.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.enabled","name":"enabled"},"children":{}},"renderer":{"doclet":{"description":"The edit mode renderer for the column.","type":{"names":["EditModeRendererType['options']"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer","name":"renderer"},"children":{"checkbox":{"doclet":{"description":"Options to control the checkbox renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.checkbox","name":"checkbox"},"children":{"disabled":{"doclet":{"description":"Whether the checkbox is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.checkbox.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the checkbox.","type":{"names":["CheckboxAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.checkbox.attributes","name":"attributes"},"children":{"checked":{"doclet":{"description":"Initial checked state of the checkbox renderer.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.checkbox.attributes.checked","name":"checked"},"children":{}}}}}},"select":{"doclet":{"description":"Options to control the select renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select","name":"select"},"children":{"options":{"doclet":{"description":"The options available in the select input.","type":{"names":["SelectOption[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.options","name":"options"},"children":{"value":{"doclet":{"description":"The value of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.options.value","name":"value"},"children":{}},"label":{"doclet":{"description":"The label of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.options.label","name":"label"},"children":{}},"disabled":{"doclet":{"description":"Whether the option is disabled. If true, the option cannot be\nselected.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.options.disabled","name":"disabled"},"children":{}}}},"disabled":{"doclet":{"description":"Whether the select input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the select input.","type":{"names":["SelectAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.attributes","name":"attributes"},"children":{"multiple":{"doclet":{"description":"Whether multiple options can be selected at the same time.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.attributes.multiple","name":"multiple"},"children":{}},"autofocus":{"doclet":{"description":"Whether the select should receive focus automatically when editing\nstarts.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.attributes.autofocus","name":"autofocus"},"children":{}},"size":{"doclet":{"description":"Number of visible options shown without scrolling.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.select.attributes.size","name":"size"},"children":{}}}}}},"textInput":{"doclet":{"description":"Options to control the text input renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput","name":"textInput"},"children":{"disabled":{"doclet":{"description":"Whether the text input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the text input.","type":{"names":["TextInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.attributes","name":"attributes"},"children":{"minlength":{"doclet":{"description":"Minimum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.attributes.minlength","name":"minlength"},"children":{}},"maxlength":{"doclet":{"description":"Maximum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.attributes.maxlength","name":"maxlength"},"children":{}},"pattern":{"doclet":{"description":"Regular expression pattern used for native input validation.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.attributes.pattern","name":"pattern"},"children":{}},"placeholder":{"doclet":{"description":"Placeholder text shown when the input is empty.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.attributes.placeholder","name":"placeholder"},"children":{}},"size":{"doclet":{"description":"Visible width of the input in characters.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.textInput.attributes.size","name":"size"},"children":{}}}}}},"dateInput":{"doclet":{"description":"Options to control the date input renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.dateInput","name":"dateInput"},"children":{"type":{"doclet":{"description":"Use the built-in date input renderer.","defaultvalue":"'dateInput'","type":{"names":["'dateInput'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.dateInput.type","name":"type","default":"dateInput"},"children":{}}}},"dateTimeInput":{"doclet":{"description":"Options to control the date time input renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.dateTimeInput","name":"dateTimeInput"},"children":{"type":{"doclet":{"description":"Use the built-in date-time input renderer.","defaultvalue":"'dateTimeInput'","type":{"names":["'dateTimeInput'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.dateTimeInput.type","name":"type","default":"dateTimeInput"},"children":{}}}},"timeInput":{"doclet":{"description":"Options to control the time input renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.timeInput","name":"timeInput"},"children":{"type":{"doclet":{"description":"Use the built-in time input renderer.","defaultvalue":"'timeInput'","type":{"names":["'timeInput'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.timeInput.type","name":"type","default":"timeInput"},"children":{}}}},"numberInput":{"doclet":{"description":"Options to control the number input renderer content."},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.numberInput","name":"numberInput"},"children":{"disabled":{"doclet":{"description":"Whether the number input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.numberInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the number input.","type":{"names":["NumberInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.numberInput.attributes","name":"attributes"},"children":{"min":{"doclet":{"description":"Minimum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.numberInput.attributes.min","name":"min"},"children":{}},"max":{"doclet":{"description":"Maximum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.numberInput.attributes.max","name":"max"},"children":{}},"step":{"doclet":{"description":"Step interval used by the number input controls.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.renderer.numberInput.attributes.step","name":"step"},"children":{}}}}}}}},"validationRules":{"doclet":{"description":"Validation options for the column.\n\nIf not set, the validation rules are applied according to the data\ntype.\n\nCan be an array where each item can be\neither a rule key (string) or a rule definition (object).","samples":[{"name":"Validation rules","value":"grid-pro/demo/validation"}],"type":{"names":["RuleKey","RuleDefinition[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.validationRules","name":"validationRules"},"children":{"validate":{"doclet":{"description":"Validation logic for the rule.\n\nUse a built-in rule key to reuse one of the predefined validators, or\nprovide a custom callback function.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p><p>Callback parameters:</p><ul><li><code>content</code> — <code>EditModeContent</code></li></ul>","type":{"names":["'boolean' | 'datetime' | 'notEmpty' | 'number' | 'ignoreCaseUnique' | 'unique' | 'arrayNumber' | 'json' | 'sparkline' | 'treeViewPathSyntax' | 'treeViewPathUnique'","( this: TableCell, content: EditModeContent ) => boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.validationRules.validate","name":"validate"},"children":{}},"notification":{"doclet":{"description":"Notification displayed when the validation fails.\n\nCan be defined as a static string or a callback function returning a\nstring.\n\nWhen `validate` references one of the predefined rule keys, this\nproperty overrides that rule's built-in notification.\n\nLocalized notifications for predefined rules configured directly by key\ncan be customized through `lang.validationNotifications`.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.editMode.validationRules.notification","name":"notification"},"children":{}}}}}},"renderer":{"doclet":{"description":"Options to control the cell content rendering.","samples":[{"name":"Cell renderers","value":"grid-pro/basic/cell-renderers"},{"name":"Sparklines","value":"grid-pro/basic/sparklines"}],"type":{"names":["CellRendererType['options']"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer","name":"renderer"},"children":{"text":{"doclet":{"description":"Options to control the text renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.text","name":"text"},"children":{"type":{"doclet":{"description":"Use the built-in plain text renderer.","defaultvalue":"'text'","type":{"names":["'text'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.text.type","name":"type","default":"text"},"children":{}}}},"checkbox":{"doclet":{"description":"Options to control the checkbox renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.checkbox","name":"checkbox"},"children":{"disabled":{"doclet":{"description":"Whether the checkbox is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.checkbox.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the checkbox.","type":{"names":["CheckboxAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.checkbox.attributes","name":"attributes"},"children":{"checked":{"doclet":{"description":"Initial checked state of the checkbox renderer.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.checkbox.attributes.checked","name":"checked"},"children":{}}}}}},"select":{"doclet":{"description":"Options to control the select renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.select","name":"select"},"children":{"options":{"doclet":{"description":"The options available in the select input.","type":{"names":["SelectOption[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.options","name":"options"},"children":{"value":{"doclet":{"description":"The value of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.options.value","name":"value"},"children":{}},"label":{"doclet":{"description":"The label of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.options.label","name":"label"},"children":{}},"disabled":{"doclet":{"description":"Whether the option is disabled. If true, the option cannot be\nselected.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.options.disabled","name":"disabled"},"children":{}}}},"disabled":{"doclet":{"description":"Whether the select input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the select input.","type":{"names":["SelectAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.attributes","name":"attributes"},"children":{"multiple":{"doclet":{"description":"Whether multiple options can be selected at the same time.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.attributes.multiple","name":"multiple"},"children":{}},"autofocus":{"doclet":{"description":"Whether the select should receive focus automatically when editing\nstarts.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.attributes.autofocus","name":"autofocus"},"children":{}},"size":{"doclet":{"description":"Number of visible options shown without scrolling.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.select.attributes.size","name":"size"},"children":{}}}}}},"sparkline":{"doclet":{"description":"Options to control the sparkline renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.sparkline","name":"sparkline"},"children":{"chartOptions":{"doclet":{"description":"Highcharts options used to render the sparkline chart inside the cell.\n\nCan be a static options object or a callback returning chart options for\nthe current cell value.","samples":[{"name":"Sparklines","value":"grid-pro/basic/sparklines"}],"type":{"names":["(this: TableCell, data: DataTableCellType) => AnyRecord|AnyRecord"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.sparkline.chartOptions","name":"chartOptions"},"children":{}}}},"textInput":{"doclet":{"description":"Options to control the text input renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.textInput","name":"textInput"},"children":{"disabled":{"doclet":{"description":"Whether the text input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the text input.","type":{"names":["TextInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.attributes","name":"attributes"},"children":{"minlength":{"doclet":{"description":"Minimum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.attributes.minlength","name":"minlength"},"children":{}},"maxlength":{"doclet":{"description":"Maximum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.attributes.maxlength","name":"maxlength"},"children":{}},"pattern":{"doclet":{"description":"Regular expression pattern used for native input validation.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.attributes.pattern","name":"pattern"},"children":{}},"placeholder":{"doclet":{"description":"Placeholder text shown when the input is empty.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.attributes.placeholder","name":"placeholder"},"children":{}},"size":{"doclet":{"description":"Visible width of the input in characters.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.textInput.attributes.size","name":"size"},"children":{}}}}}},"dateInput":{"doclet":{"description":"Options to control the date input renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.dateInput","name":"dateInput"},"children":{"type":{"doclet":{"description":"Use the built-in date input renderer.","defaultvalue":"'dateInput'","type":{"names":["'dateInput'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.dateInput.type","name":"type","default":"dateInput"},"children":{}}}},"dateTimeInput":{"doclet":{"description":"Options to control the date time input renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.dateTimeInput","name":"dateTimeInput"},"children":{"type":{"doclet":{"description":"Use the built-in date-time input renderer.","defaultvalue":"'dateTimeInput'","type":{"names":["'dateTimeInput'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.dateTimeInput.type","name":"type","default":"dateTimeInput"},"children":{}}}},"timeInput":{"doclet":{"description":"Options to control the time input renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.timeInput","name":"timeInput"},"children":{"type":{"doclet":{"description":"Use the built-in time input renderer.","defaultvalue":"'timeInput'","type":{"names":["'timeInput'"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.timeInput.type","name":"type","default":"timeInput"},"children":{}}}},"numberInput":{"doclet":{"description":"Options to control the number input renderer content."},"meta":{"fullname":"columnDefaults.cells.renderer.numberInput","name":"numberInput"},"children":{"disabled":{"doclet":{"description":"Whether the number input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.numberInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the number input.","type":{"names":["NumberInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.numberInput.attributes","name":"attributes"},"children":{"min":{"doclet":{"description":"Minimum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.numberInput.attributes.min","name":"min"},"children":{}},"max":{"doclet":{"description":"Maximum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.numberInput.attributes.max","name":"max"},"children":{}},"step":{"doclet":{"description":"Step interval used by the number input controls.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.renderer.numberInput.attributes.step","name":"step"},"children":{}}}}}}}},"events":{"doclet":{"description":"Events options triggered by the grid elements.","type":{"names":["CellEvents"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events","name":"events"},"children":{"click":{"doclet":{"description":"Callback function to be called when the cell is clicked.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events.click","name":"click"},"children":{}},"dblClick":{"doclet":{"description":"Callback function to be called when the cell is double clicked.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events.dblClick","name":"dblClick"},"children":{}},"mouseOver":{"doclet":{"description":"Callback function to be called when the cell is hovered.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events.mouseOver","name":"mouseOver"},"children":{}},"mouseOut":{"doclet":{"description":"Callback function to be called when the cell is no longer hovered.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events.mouseOut","name":"mouseOut"},"children":{}},"afterRender":{"doclet":{"description":"Callback function to be called after the cell value is set (on init or\nafter editing).<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events.afterRender","name":"afterRender"},"children":{}},"afterEdit":{"doclet":{"description":"Callback function to be called after editing of cell value.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.cells.events.afterEdit","name":"afterEdit"},"children":{}}}}}},"dataType":{"doclet":{"description":"The data type of the column. Can be one of `string`, `number`,\n`boolean` or `date`.\n\nIf not set, the data type is inferred from the first cell in the\ncolumn.","type":{"names":["'string' | 'number' | 'boolean' | 'datetime'"]}},"meta":{"fullname":"columnDefaults.dataType","name":"dataType"},"children":{}},"header":{"doclet":{"description":"Options for all the header cells in the column.","type":{"names":["ColumnHeaderOptions"]}},"meta":{"fullname":"columnDefaults.header","name":"header"},"children":{"className":{"doclet":{"description":"Allows user to define an additional class name only to the column header.\n\nIt uses templating, where context is the header cell instance.","defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columnDefaults.header.className","name":"className","default":"undefined"},"children":{}},"format":{"doclet":{"description":"The format of the column header. Use `{id}` to display the column id.","type":{"names":["string"]}},"meta":{"fullname":"columnDefaults.header.format","name":"format"},"children":{}},"formatter":{"doclet":{"description":"Callback function for formatting the column header. It is called for each\ncolumn header cell.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","return":"A string to be set as a header cell's content.","type":{"names":["(this: Column) => string"]}},"meta":{"fullname":"columnDefaults.header.formatter","name":"formatter"},"children":{}},"style":{"doclet":{"description":"CSS styles for the column header cells.\nCan be a static style object or a callback that returns one.","type":{"names":["StyleValue<Column>"]}},"meta":{"fullname":"columnDefaults.header.style","name":"style"},"children":{}},"events":{"doclet":{"description":"Events options triggered by the grid elements.","type":{"names":["HeaderEvents"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.header.events","name":"events"},"children":{"click":{"doclet":{"description":"Callback function to be called when the header is clicked.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.header.events.click","name":"click"},"children":{}},"afterRender":{"doclet":{"description":"Callback function to be called after the header is initialized.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.header.events.afterRender","name":"afterRender"},"children":{}}}}}},"sorting":{"doclet":{"description":"Column sorting options.","samples":[{"name":"Sorting options","value":"grid-pro/basic/sorting-options"}],"type":{"names":["ColumnSortingOptions"]}},"meta":{"fullname":"columnDefaults.sorting","name":"sorting"},"children":{"enabled":{"doclet":{"description":"Whether to allow users to sort values in column. When it is enabled,\nthe column header will be clickable.\n\nWhen sorting is disabled (`false`), this column cannot be sorted by the\nuser interface. However, the order of rows in this column may still\nchange when other columns are sorted.","samples":[{"name":"Sorting options","value":"grid-pro/basic/sorting-options"}],"defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.sorting.enabled","name":"enabled","default":true},"children":{}},"orderSequence":{"doclet":{"description":"Sequence of sorting orders used when toggling sorting from the user\ninterface (for example by clicking the column header).\n\nThe sequence can contain any number of values, in any order, with\nduplicates allowed. Allowed values are: `'asc'`, `'desc'`, and `null`.\n\nIf the sequence is empty (`[]`), sorting toggles become a no-op while\nthe sortable UI can still be shown.\n\nThis option can be set in both `columnDefaults.sorting` and\n`columns[].sorting`.","defaultvalue":"['asc', 'desc', null]","type":{"names":["('asc' | 'desc' | null)[]"]},"supportsArray":true},"meta":{"fullname":"columnDefaults.sorting.orderSequence","name":"orderSequence","default":"['asc', 'desc', null]"},"children":{}},"compare":{"doclet":{"description":"Custom compare function to sort the column values. It overrides the\ndefault sorting behavior. If not set, the default sorting behavior is\nused.","param":["a\nThe first value to compare.","b\nThe second value to compare."],"return":"A number indicating whether the first value (`a`) is less than (`-1`),\nequal to (`0`), or greater than (`1`) the second value (`b`).","type":{"names":["(a: DataTableCellType, b: DataTableCellType) => number"]}},"meta":{"fullname":"columnDefaults.sorting.compare","name":"compare"},"children":{}}}},"width":{"doclet":{"description":"The width of the column. It can be set in pixels, as a percentage of the\ntable width, or `'auto'`. If unset or `'auto'`, the remaining table\nwidth is distributed between columns without an explicit width.\n\nThe final width is also constrained by `minWidth` and `maxWidth`, if\nthey are set.","type":{"names":["number","string"]}},"meta":{"fullname":"columnDefaults.width","name":"width"},"children":{}},"minWidth":{"doclet":{"description":"The minimum width of the column. It can be set in pixels or as a\npercentage of the table width.","samples":[{"name":"Column width limits","value":"grid-lite/options/column-width-limits"}],"type":{"names":["number","string"]}},"meta":{"fullname":"columnDefaults.minWidth","name":"minWidth"},"children":{}},"maxWidth":{"doclet":{"description":"The maximum width of the column. It can be set in pixels or as a\npercentage of the table width.","samples":[{"name":"Column width limits","value":"grid-lite/options/column-width-limits"}],"type":{"names":["number","string"]}},"meta":{"fullname":"columnDefaults.maxWidth","name":"maxWidth"},"children":{}},"filtering":{"doclet":{"description":"Filtering options for the column.","samples":[{"name":"Column filtering","value":"grid-lite/basic/column-filtering"}],"type":{"names":["ColumnFilteringOptions"]}},"meta":{"fullname":"columnDefaults.filtering","name":"filtering"},"children":{"rule":{"doclet":{"description":"The active filtering rule applied to the column.","example":"```js\ncolumns: [{\n  id: 'weight',\n  filtering: {\n    enabled: true,\n    rule: {\n      operator: 'greaterThan',\n      value: 100\n    }\n  }\n}]\n```","type":{"names":["FilteringRule"]}},"meta":{"fullname":"columnDefaults.filtering.rule","name":"rule"},"children":{"operator":{"doclet":{"description":"The operator to use for filtering the column.","type":{"names":["StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases"]}},"meta":{"fullname":"columnDefaults.filtering.rule.operator","name":"operator"},"children":{}},"value":{"doclet":{"description":"The value that is used with the operator to filter the column.","type":{"names":["string","number","boolean","null"]}},"meta":{"fullname":"columnDefaults.filtering.rule.value","name":"value"},"children":{}}}},"operators":{"doclet":{"description":"Restricts the list of available filtering operators for the column.\n\nIf set, the UI will only display the provided operators that are valid\nfor the column's `dataType`. Invalid operators are ignored.","example":"```js\ncolumns: [{\n  id: 'name',\n  dataType: 'string',\n  filtering: {\n    enabled: true,\n    operators: ['contains', 'beginsWith']\n  }\n}]\n```","type":{"names":["(StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases)[]"]},"supportsArray":true},"meta":{"fullname":"columnDefaults.filtering.operators","name":"operators"},"children":{}},"condition":{"doclet":{"description":"The condition to use for filtering the column.<p><em>Deprecated:</em> Use `rule.operator` instead.</p>","deprecated":"3.1.0","deprnote":"Use `rule.operator` instead.","type":{"names":["StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases"]}},"meta":{"fullname":"columnDefaults.filtering.condition","name":"condition"},"children":{}},"value":{"doclet":{"description":"The value that is used with the condition to filter the column.<p><em>Deprecated:</em> Use `rule.value` instead.</p>","deprecated":"3.1.0","deprnote":"Use `rule.value` instead.","type":{"names":["string","number","boolean","null"]}},"meta":{"fullname":"columnDefaults.filtering.value","name":"value"},"children":{}},"conditions":{"doclet":{"description":"Restricts the list of available filtering conditions for the column.<p><em>Deprecated:</em> Use `operators` instead.</p>","deprecated":"3.1.0","deprnote":"Use `operators` instead.","example":"```js\ncolumns: [{\n  id: 'name',\n  dataType: 'string',\n  filtering: {\n    enabled: true,\n    conditions: ['contains', 'beginsWith']\n  }\n}]\n```","type":{"names":["(StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases)[]"]},"supportsArray":true},"meta":{"fullname":"columnDefaults.filtering.conditions","name":"conditions"},"children":{}},"enabled":{"doclet":{"description":"Whether the filtering is enabled or not.","samples":[{"name":"Column filtering","value":"grid-lite/basic/column-filtering"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.filtering.enabled","name":"enabled","default":"false"},"children":{}},"inline":{"doclet":{"description":"Whether the filtering inputs should be rendered inline in the special\ntable header row (`true`), or should be accessed via a popup (`false`).","samples":[{"name":"Inline filtering","value":"grid-lite/options/inline-filtering"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.filtering.inline","name":"inline","default":"false"},"children":{}},"hideOperatorSelect":{"doclet":{"description":"Hides the operator select in filtering UI.\n\nUses ColumnFilteringOptions.rule operator when valid, otherwise\nthe first operator for the column `dataType` or\nColumnFilteringOptions.operators. Not supported for `boolean`\ncolumns (no value input).","samples":[{"name":"Inline filtering with hidden operator select","value":"grid-lite/options/inline-filtering-hide-select"}],"defaultvalue":"true when {@link ColumnFilteringOptions.operators} has a\n        single entry, otherwise `false`","type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.filtering.hideOperatorSelect","name":"hideOperatorSelect","default":"true when {@link ColumnFilteringOptions.operators} has a\n        single entry, otherwise `false`"},"children":{}}}},"style":{"doclet":{"description":"CSS styles for the whole column, applied to the header and body cells.\nCan be a static style object or a callback that returns one.","type":{"names":["StyleValue<Column>"]}},"meta":{"fullname":"columnDefaults.style","name":"style"},"children":{}},"exportable":{"doclet":{"description":"Whether the column should be included in exports.\n\nFor unbound columns, exporting is always disabled.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"columnDefaults.exportable","name":"exportable","default":true},"children":{}},"events":{"doclet":{"description":"Events options triggered by the grid elements.","type":{"names":["ColumnEvents"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.events","name":"events"},"children":{"beforeFilter":{"doclet":{"description":"Callback function to be called when the column is filtered, after input\nkeypress or select change events, but before the filtering is applied.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.events.beforeFilter","name":"beforeFilter"},"children":{}},"afterFilter":{"doclet":{"description":"Callback function to be called when the column is filtered, after input\nkeypress or select change events, and the filtering is applied.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.events.afterFilter","name":"afterFilter"},"children":{}},"beforeSort":{"doclet":{"description":"Callback function to be called when the column is sorted,\nbefore clicking on header.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.events.beforeSort","name":"beforeSort"},"children":{}},"afterSort":{"doclet":{"description":"Callback function to be called when the column is sorted,\nafter clicking on header.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.events.afterSort","name":"afterSort"},"children":{}},"afterResize":{"doclet":{"description":"Callback function to be called when the column is resized.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.events.afterResize","name":"afterResize"},"children":{}}}},"rowAggregator":{"doclet":{"description":"Aggregator used for parent rows of the projected tree, in the\n`treeView` and `rowGrouping` features.\n\nWhen provided as a string, the function is applied to every row that\nhas children in the projected tree, overriding the row's source\nvalue. Structural columns such as `data.idColumn`,\n`treeView.input.pathColumn`, `treeView.input.parentIdColumn`, and\n`rowGrouping.groupBy` columns never aggregate, even if configured.\n\nWhen provided as a callback, it is invoked for matching parent rows\nand should return a registered Formula processor function name, or a\nfalsy value to skip aggregation for the current row.\n\nSet it in `columnDefaults` to aggregate every column the same way,\nand to `false` in a single column to reset that default.","samples":[{"name":"TreeView data aggregation","value":"grid-pro/tree-view/data-aggregation"},{"name":"Row grouping","value":"grid-pro/options/row-grouping"}],"type":{"names":["false | string | TreeViewColumnAggregatorCallback"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.rowAggregator","name":"rowAggregator"},"children":{}},"treeView":{"doclet":{"description":"TreeView options for a single column.<p><em>Deprecated:</em> Use the column level `rowAggregator` option instead.</p>","deprecated":"3.1.0","deprnote":"Use the column level `rowAggregator` option instead.","type":{"names":["TreeViewColumnOptions"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.treeView","name":"treeView"},"children":{"aggregator":{"doclet":{"description":"Aggregator used for parent rows in the projected tree.","type":{"names":["false | string | TreeViewColumnAggregatorCallback"]},"product":"gridpro"},"meta":{"fullname":"columnDefaults.treeView.aggregator","name":"aggregator"},"children":{}}}}},"doclet":{"description":"Default options for all the columns in the grid. Can be overridden\nby the `dataTypeColumnDefaults` and individual column options.","type":{"names":["ColumnOptions"]}},"meta":{"fullname":"columnDefaults","name":"columnDefaults"}},"columns":{"children":{"className":{"doclet":{"description":"The custom CSS class name for the column. Applied also to cells that are\nin the table and also to the column header cells.\n\nIt does not use templating.","samples":[{"name":"Custom class","value":"grid-pro/basic/custom-class"}],"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columns.className","name":"className","default":"undefined"},"children":{}},"enabled":{"doclet":{"description":"Whether the column is enabled and should be displayed. If `false`,\nthe column will not be rendered.","samples":[{"name":"Toggle column visibility","value":"grid-lite/options/column-enabled"}],"defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"columns.enabled","name":"enabled","default":true},"children":{}},"id":{"doclet":{"description":"The column id used by Grid as the column identity.","type":{"names":["string"]}},"meta":{"fullname":"columns.id","name":"id"},"children":{}},"dataId":{"doclet":{"description":"The id of the data source column.\n\n- `undefined`: defaults to `id`.\n- `null`: forces the column to be unbound.","type":{"names":["string","null"]}},"meta":{"fullname":"columns.dataId","name":"dataId"},"children":{}},"sorting":{"doclet":{"description":"Column sorting options for this specific column.\n\nUse this to override `columnDefaults.sorting` or to define initial\nsorting state and priority for multi-column sorting.","samples":[{"name":"Sorting options","value":"grid-pro/basic/sorting-options"}],"type":{"names":["IndividualColumnSortingOptions"]}},"meta":{"fullname":"columns.sorting","name":"sorting"},"children":{"order":{"doclet":{"description":"The initial sorting order of the column. Can be either `asc` for\nascending, `desc` for descending, or `null` for disabled.","defaultvalue":"null","type":{"names":["'asc' | 'desc' | null"]}},"meta":{"fullname":"columns.sorting.order","name":"order","default":"null"},"children":{}},"priority":{"doclet":{"description":"Priority of this column when multiple columns are sorted. Lower numbers\nhave higher priority.","type":{"names":["number"]}},"meta":{"fullname":"columns.sorting.priority","name":"priority"},"children":{}},"enabled":{"doclet":{"description":"Whether to allow users to sort values in column. When it is enabled,\nthe column header will be clickable.\n\nWhen sorting is disabled (`false`), this column cannot be sorted by the\nuser interface. However, the order of rows in this column may still\nchange when other columns are sorted.","samples":[{"name":"Sorting options","value":"grid-pro/basic/sorting-options"}],"defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"columns.sorting.enabled","name":"enabled","default":true},"children":{}},"orderSequence":{"doclet":{"description":"Sequence of sorting orders used when toggling sorting from the user\ninterface (for example by clicking the column header).\n\nThe sequence can contain any number of values, in any order, with\nduplicates allowed. Allowed values are: `'asc'`, `'desc'`, and `null`.\n\nIf the sequence is empty (`[]`), sorting toggles become a no-op while\nthe sortable UI can still be shown.\n\nThis option can be set in both `columnDefaults.sorting` and\n`columns[].sorting`.","defaultvalue":"['asc', 'desc', null]","type":{"names":["('asc' | 'desc' | null)[]"]},"supportsArray":true},"meta":{"fullname":"columns.sorting.orderSequence","name":"orderSequence","default":"['asc', 'desc', null]"},"children":{}},"compare":{"doclet":{"description":"Custom compare function to sort the column values. It overrides the\ndefault sorting behavior. If not set, the default sorting behavior is\nused.","param":["a\nThe first value to compare.","b\nThe second value to compare."],"return":"A number indicating whether the first value (`a`) is less than (`-1`),\nequal to (`0`), or greater than (`1`) the second value (`b`).","type":{"names":["(a: DataTableCellType, b: DataTableCellType) => number"]}},"meta":{"fullname":"columns.sorting.compare","name":"compare"},"children":{}}}},"cells":{"doclet":{"description":"Options for all cells in the column.","type":{"names":["ColumnCellOptions"]}},"meta":{"fullname":"columns.cells","name":"cells"},"children":{"rowHeader":{"doclet":{"description":"Whether cells in this column should be rendered as row header cells.\n\nWhen enabled, body cells are rendered as `<th scope=\"row\">` instead of\n`<td>`. This is useful for accessible data grids where the first column\nacts as a row header.","defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"columns.cells.rowHeader","name":"rowHeader","default":"false"},"children":{}},"className":{"doclet":{"description":"Allows to define an additional class name to all table cells in the\ncolumn. Applied only to cell that are in the table, not in the column\nheader. It is updated with every cell's value change.\n\nIt uses templating, where context is the table cell instance.","defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columns.cells.className","name":"className","default":"undefined"},"children":{}},"format":{"doclet":{"description":"The format of the cell content within the given column of the grid.\nApplied only to cell that are in the table, not in the column header.\n\nWhen not set, the default format `'{value}'` is used.","samples":[{"name":"Cell formatting","value":"grid-pro/basic/cell-formatting"}],"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columns.cells.format","name":"format","default":"undefined"},"children":{}},"formatter":{"doclet":{"description":"Callback function for formatting cells within the given column of the\ngrid. Applied only to cell that are in the table not the column\nheader.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Cell.Cell.html\">Cell</a> instance.</p>","samples":[{"name":"Cell formatting","value":"grid-pro/basic/cell-formatting"}],"return":"A string to be set as a table cell's content.","type":{"names":["(this: Cell) => string"]}},"meta":{"fullname":"columns.cells.formatter","name":"formatter"},"children":{}},"valueGetter":{"doclet":{"description":"Callback function to resolve the value of an unbound column cell.\nFor bound columns, overrides only the rendered content - sorting,\nfiltering, and export remain unaffected.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p><p>Callback parameters:</p><ul><li><code>cell</code> — <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a></li></ul>","type":{"names":["( this: TableCell, cell: TableCell ) => (DataTableCellType | Promise<DataTableCellType>)"]}},"meta":{"fullname":"columns.cells.valueGetter","name":"valueGetter"},"children":{}},"contextMenu":{"doclet":{"description":"Context menu options for table body cells. When configured, a custom\ncontext menu will be shown on right-click.","samples":[{"name":"Cell context menu","value":"grid-lite/demo/cell-context-menu"},{"name":"Cell context menu with built-ins","value":"grid-pro/basic/cell-context-menu"}],"type":{"names":["CellContextMenuOptions"]}},"meta":{"fullname":"columns.cells.contextMenu","name":"contextMenu"},"children":{"enabled":{"doclet":{"description":"Whether the cell context menu is enabled. When omitted, the menu is\nenabled when `items` are provided, or when a composed feature registers\nvisible built-in actions for the current cell.","type":{"names":["boolean"]}},"meta":{"fullname":"columns.cells.contextMenu.enabled","name":"enabled"},"children":{}},"items":{"doclet":{"description":"List of items to show in the cell context menu.","type":{"names":["(CellContextMenuDividerItemOptions | CellContextMenuTypedDividerItemOptions | CellContextMenuActionItemOptions | CellContextMenuSubmenuItemOptions | CellContextMenuBuiltInItemOptions | CellContextMenuBuiltInGroupItemOptions | CellContextMenuActionId | CellContextMenuGroupId)[]"]},"supportsArray":true},"meta":{"fullname":"columns.cells.contextMenu.items","name":"items"},"children":{}}}},"style":{"doclet":{"description":"CSS styles for table body cells in the column.\nCan be a static style object or a callback that returns one.","type":{"names":["StyleValue<Cell>"]}},"meta":{"fullname":"columns.cells.style","name":"style"},"children":{}},"editMode":{"doclet":{"description":"Whether to enabled the cell edit mode functionality. It allows to\nedit the cell value in a separate input field that is displayed\nafter double-clicking the cell or pressing the Enter key.","samples":[{"name":"Cell editing","value":"grid-pro/basic/cell-editing"}],"type":{"names":["ColumnEditModeOptions"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode","name":"editMode"},"children":{"enabled":{"doclet":{"description":"Whether to enable the cell edit mode functionality.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.enabled","name":"enabled"},"children":{}},"renderer":{"doclet":{"description":"The edit mode renderer for the column.","type":{"names":["EditModeRendererType['options']"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer","name":"renderer"},"children":{"checkbox":{"doclet":{"description":"Options to control the checkbox renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.checkbox","name":"checkbox"},"children":{"disabled":{"doclet":{"description":"Whether the checkbox is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.checkbox.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the checkbox.","type":{"names":["CheckboxAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.checkbox.attributes","name":"attributes"},"children":{"checked":{"doclet":{"description":"Initial checked state of the checkbox renderer.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.checkbox.attributes.checked","name":"checked"},"children":{}}}}}},"select":{"doclet":{"description":"Options to control the select renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.select","name":"select"},"children":{"options":{"doclet":{"description":"The options available in the select input.","type":{"names":["SelectOption[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.options","name":"options"},"children":{"value":{"doclet":{"description":"The value of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.options.value","name":"value"},"children":{}},"label":{"doclet":{"description":"The label of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.options.label","name":"label"},"children":{}},"disabled":{"doclet":{"description":"Whether the option is disabled. If true, the option cannot be\nselected.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.options.disabled","name":"disabled"},"children":{}}}},"disabled":{"doclet":{"description":"Whether the select input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the select input.","type":{"names":["SelectAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.attributes","name":"attributes"},"children":{"multiple":{"doclet":{"description":"Whether multiple options can be selected at the same time.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.attributes.multiple","name":"multiple"},"children":{}},"autofocus":{"doclet":{"description":"Whether the select should receive focus automatically when editing\nstarts.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.attributes.autofocus","name":"autofocus"},"children":{}},"size":{"doclet":{"description":"Number of visible options shown without scrolling.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.select.attributes.size","name":"size"},"children":{}}}}}},"textInput":{"doclet":{"description":"Options to control the text input renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.textInput","name":"textInput"},"children":{"disabled":{"doclet":{"description":"Whether the text input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the text input.","type":{"names":["TextInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.attributes","name":"attributes"},"children":{"minlength":{"doclet":{"description":"Minimum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.attributes.minlength","name":"minlength"},"children":{}},"maxlength":{"doclet":{"description":"Maximum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.attributes.maxlength","name":"maxlength"},"children":{}},"pattern":{"doclet":{"description":"Regular expression pattern used for native input validation.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.attributes.pattern","name":"pattern"},"children":{}},"placeholder":{"doclet":{"description":"Placeholder text shown when the input is empty.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.attributes.placeholder","name":"placeholder"},"children":{}},"size":{"doclet":{"description":"Visible width of the input in characters.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.textInput.attributes.size","name":"size"},"children":{}}}}}},"dateInput":{"doclet":{"description":"Options to control the date input renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.dateInput","name":"dateInput"},"children":{"type":{"doclet":{"description":"Use the built-in date input renderer.","defaultvalue":"'dateInput'","type":{"names":["'dateInput'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.dateInput.type","name":"type","default":"dateInput"},"children":{}}}},"dateTimeInput":{"doclet":{"description":"Options to control the date time input renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.dateTimeInput","name":"dateTimeInput"},"children":{"type":{"doclet":{"description":"Use the built-in date-time input renderer.","defaultvalue":"'dateTimeInput'","type":{"names":["'dateTimeInput'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.dateTimeInput.type","name":"type","default":"dateTimeInput"},"children":{}}}},"timeInput":{"doclet":{"description":"Options to control the time input renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.timeInput","name":"timeInput"},"children":{"type":{"doclet":{"description":"Use the built-in time input renderer.","defaultvalue":"'timeInput'","type":{"names":["'timeInput'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.timeInput.type","name":"type","default":"timeInput"},"children":{}}}},"numberInput":{"doclet":{"description":"Options to control the number input renderer content."},"meta":{"fullname":"columns.cells.editMode.renderer.numberInput","name":"numberInput"},"children":{"disabled":{"doclet":{"description":"Whether the number input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.numberInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the number input.","type":{"names":["NumberInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.numberInput.attributes","name":"attributes"},"children":{"min":{"doclet":{"description":"Minimum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.numberInput.attributes.min","name":"min"},"children":{}},"max":{"doclet":{"description":"Maximum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.numberInput.attributes.max","name":"max"},"children":{}},"step":{"doclet":{"description":"Step interval used by the number input controls.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.renderer.numberInput.attributes.step","name":"step"},"children":{}}}}}}}},"validationRules":{"doclet":{"description":"Validation options for the column.\n\nIf not set, the validation rules are applied according to the data\ntype.\n\nCan be an array where each item can be\neither a rule key (string) or a rule definition (object).","samples":[{"name":"Validation rules","value":"grid-pro/demo/validation"}],"type":{"names":["RuleKey","RuleDefinition[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.validationRules","name":"validationRules"},"children":{"validate":{"doclet":{"description":"Validation logic for the rule.\n\nUse a built-in rule key to reuse one of the predefined validators, or\nprovide a custom callback function.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p><p>Callback parameters:</p><ul><li><code>content</code> — <code>EditModeContent</code></li></ul>","type":{"names":["'boolean' | 'datetime' | 'notEmpty' | 'number' | 'ignoreCaseUnique' | 'unique' | 'arrayNumber' | 'json' | 'sparkline' | 'treeViewPathSyntax' | 'treeViewPathUnique'","( this: TableCell, content: EditModeContent ) => boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.validationRules.validate","name":"validate"},"children":{}},"notification":{"doclet":{"description":"Notification displayed when the validation fails.\n\nCan be defined as a static string or a callback function returning a\nstring.\n\nWhen `validate` references one of the predefined rule keys, this\nproperty overrides that rule's built-in notification.\n\nLocalized notifications for predefined rules configured directly by key\ncan be customized through `lang.validationNotifications`.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.editMode.validationRules.notification","name":"notification"},"children":{}}}}}},"renderer":{"doclet":{"description":"Options to control the cell content rendering.","samples":[{"name":"Cell renderers","value":"grid-pro/basic/cell-renderers"},{"name":"Sparklines","value":"grid-pro/basic/sparklines"}],"type":{"names":["CellRendererType['options']"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer","name":"renderer"},"children":{"text":{"doclet":{"description":"Options to control the text renderer content."},"meta":{"fullname":"columns.cells.renderer.text","name":"text"},"children":{"type":{"doclet":{"description":"Use the built-in plain text renderer.","defaultvalue":"'text'","type":{"names":["'text'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.text.type","name":"type","default":"text"},"children":{}}}},"checkbox":{"doclet":{"description":"Options to control the checkbox renderer content."},"meta":{"fullname":"columns.cells.renderer.checkbox","name":"checkbox"},"children":{"disabled":{"doclet":{"description":"Whether the checkbox is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.checkbox.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the checkbox.","type":{"names":["CheckboxAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.checkbox.attributes","name":"attributes"},"children":{"checked":{"doclet":{"description":"Initial checked state of the checkbox renderer.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.checkbox.attributes.checked","name":"checked"},"children":{}}}}}},"select":{"doclet":{"description":"Options to control the select renderer content."},"meta":{"fullname":"columns.cells.renderer.select","name":"select"},"children":{"options":{"doclet":{"description":"The options available in the select input.","type":{"names":["SelectOption[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.options","name":"options"},"children":{"value":{"doclet":{"description":"The value of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.options.value","name":"value"},"children":{}},"label":{"doclet":{"description":"The label of the option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.options.label","name":"label"},"children":{}},"disabled":{"doclet":{"description":"Whether the option is disabled. If true, the option cannot be\nselected.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.options.disabled","name":"disabled"},"children":{}}}},"disabled":{"doclet":{"description":"Whether the select input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the select input.","type":{"names":["SelectAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.attributes","name":"attributes"},"children":{"multiple":{"doclet":{"description":"Whether multiple options can be selected at the same time.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.attributes.multiple","name":"multiple"},"children":{}},"autofocus":{"doclet":{"description":"Whether the select should receive focus automatically when editing\nstarts.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.attributes.autofocus","name":"autofocus"},"children":{}},"size":{"doclet":{"description":"Number of visible options shown without scrolling.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.select.attributes.size","name":"size"},"children":{}}}}}},"sparkline":{"doclet":{"description":"Options to control the sparkline renderer content."},"meta":{"fullname":"columns.cells.renderer.sparkline","name":"sparkline"},"children":{"chartOptions":{"doclet":{"description":"Highcharts options used to render the sparkline chart inside the cell.\n\nCan be a static options object or a callback returning chart options for\nthe current cell value.","samples":[{"name":"Sparklines","value":"grid-pro/basic/sparklines"}],"type":{"names":["(this: TableCell, data: DataTableCellType) => AnyRecord|AnyRecord"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.sparkline.chartOptions","name":"chartOptions"},"children":{}}}},"textInput":{"doclet":{"description":"Options to control the text input renderer content."},"meta":{"fullname":"columns.cells.renderer.textInput","name":"textInput"},"children":{"disabled":{"doclet":{"description":"Whether the text input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the text input.","type":{"names":["TextInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.attributes","name":"attributes"},"children":{"minlength":{"doclet":{"description":"Minimum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.attributes.minlength","name":"minlength"},"children":{}},"maxlength":{"doclet":{"description":"Maximum number of characters allowed in the input.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.attributes.maxlength","name":"maxlength"},"children":{}},"pattern":{"doclet":{"description":"Regular expression pattern used for native input validation.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.attributes.pattern","name":"pattern"},"children":{}},"placeholder":{"doclet":{"description":"Placeholder text shown when the input is empty.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.attributes.placeholder","name":"placeholder"},"children":{}},"size":{"doclet":{"description":"Visible width of the input in characters.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.textInput.attributes.size","name":"size"},"children":{}}}}}},"dateInput":{"doclet":{"description":"Options to control the date input renderer content."},"meta":{"fullname":"columns.cells.renderer.dateInput","name":"dateInput"},"children":{"type":{"doclet":{"description":"Use the built-in date input renderer.","defaultvalue":"'dateInput'","type":{"names":["'dateInput'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.dateInput.type","name":"type","default":"dateInput"},"children":{}}}},"dateTimeInput":{"doclet":{"description":"Options to control the date time input renderer content."},"meta":{"fullname":"columns.cells.renderer.dateTimeInput","name":"dateTimeInput"},"children":{"type":{"doclet":{"description":"Use the built-in date-time input renderer.","defaultvalue":"'dateTimeInput'","type":{"names":["'dateTimeInput'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.dateTimeInput.type","name":"type","default":"dateTimeInput"},"children":{}}}},"timeInput":{"doclet":{"description":"Options to control the time input renderer content."},"meta":{"fullname":"columns.cells.renderer.timeInput","name":"timeInput"},"children":{"type":{"doclet":{"description":"Use the built-in time input renderer.","defaultvalue":"'timeInput'","type":{"names":["'timeInput'"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.timeInput.type","name":"type","default":"timeInput"},"children":{}}}},"numberInput":{"doclet":{"description":"Options to control the number input renderer content."},"meta":{"fullname":"columns.cells.renderer.numberInput","name":"numberInput"},"children":{"disabled":{"doclet":{"description":"Whether the number input is disabled.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.numberInput.disabled","name":"disabled"},"children":{}},"attributes":{"doclet":{"description":"Attributes to control the number input.","type":{"names":["NumberInputAttributes"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.numberInput.attributes","name":"attributes"},"children":{"min":{"doclet":{"description":"Minimum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.numberInput.attributes.min","name":"min"},"children":{}},"max":{"doclet":{"description":"Maximum accepted numeric value.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.numberInput.attributes.max","name":"max"},"children":{}},"step":{"doclet":{"description":"Step interval used by the number input controls.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.renderer.numberInput.attributes.step","name":"step"},"children":{}}}}}}}},"events":{"doclet":{"description":"Events options triggered by the grid elements.","type":{"names":["CellEvents"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events","name":"events"},"children":{"click":{"doclet":{"description":"Callback function to be called when the cell is clicked.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events.click","name":"click"},"children":{}},"dblClick":{"doclet":{"description":"Callback function to be called when the cell is double clicked.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events.dblClick","name":"dblClick"},"children":{}},"mouseOver":{"doclet":{"description":"Callback function to be called when the cell is hovered.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events.mouseOver","name":"mouseOver"},"children":{}},"mouseOut":{"doclet":{"description":"Callback function to be called when the cell is no longer hovered.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events.mouseOut","name":"mouseOut"},"children":{}},"afterRender":{"doclet":{"description":"Callback function to be called after the cell value is set (on init or\nafter editing).<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events.afterRender","name":"afterRender"},"children":{}},"afterEdit":{"doclet":{"description":"Callback function to be called after editing of cell value.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Body_TableCell.TableCell.html\">TableCell</a> instance.</p>","type":{"names":["(this: TableCell) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.cells.events.afterEdit","name":"afterEdit"},"children":{}}}}}},"dataType":{"doclet":{"description":"The data type of the column. Can be one of `string`, `number`,\n`boolean` or `date`.\n\nIf not set, the data type is inferred from the first cell in the\ncolumn.","type":{"names":["'string' | 'number' | 'boolean' | 'datetime'"]}},"meta":{"fullname":"columns.dataType","name":"dataType"},"children":{}},"header":{"doclet":{"description":"Options for all the header cells in the column.","type":{"names":["ColumnHeaderOptions"]}},"meta":{"fullname":"columns.header","name":"header"},"children":{"className":{"doclet":{"description":"Allows user to define an additional class name only to the column header.\n\nIt uses templating, where context is the header cell instance.","defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"columns.header.className","name":"className","default":"undefined"},"children":{}},"format":{"doclet":{"description":"The format of the column header. Use `{id}` to display the column id.","type":{"names":["string"]}},"meta":{"fullname":"columns.header.format","name":"format"},"children":{}},"formatter":{"doclet":{"description":"Callback function for formatting the column header. It is called for each\ncolumn header cell.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","return":"A string to be set as a header cell's content.","type":{"names":["(this: Column) => string"]}},"meta":{"fullname":"columns.header.formatter","name":"formatter"},"children":{}},"style":{"doclet":{"description":"CSS styles for the column header cells.\nCan be a static style object or a callback that returns one.","type":{"names":["StyleValue<Column>"]}},"meta":{"fullname":"columns.header.style","name":"style"},"children":{}},"events":{"doclet":{"description":"Events options triggered by the grid elements.","type":{"names":["HeaderEvents"]},"product":"gridpro"},"meta":{"fullname":"columns.header.events","name":"events"},"children":{"click":{"doclet":{"description":"Callback function to be called when the header is clicked.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.header.events.click","name":"click"},"children":{}},"afterRender":{"doclet":{"description":"Callback function to be called after the header is initialized.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.header.events.afterRender","name":"afterRender"},"children":{}}}}}},"width":{"doclet":{"description":"The width of the column. It can be set in pixels, as a percentage of the\ntable width, or `'auto'`. If unset or `'auto'`, the remaining table\nwidth is distributed between columns without an explicit width.\n\nThe final width is also constrained by `minWidth` and `maxWidth`, if\nthey are set.","type":{"names":["number","string"]}},"meta":{"fullname":"columns.width","name":"width"},"children":{}},"minWidth":{"doclet":{"description":"The minimum width of the column. It can be set in pixels or as a\npercentage of the table width.","samples":[{"name":"Column width limits","value":"grid-lite/options/column-width-limits"}],"type":{"names":["number","string"]}},"meta":{"fullname":"columns.minWidth","name":"minWidth"},"children":{}},"maxWidth":{"doclet":{"description":"The maximum width of the column. It can be set in pixels or as a\npercentage of the table width.","samples":[{"name":"Column width limits","value":"grid-lite/options/column-width-limits"}],"type":{"names":["number","string"]}},"meta":{"fullname":"columns.maxWidth","name":"maxWidth"},"children":{}},"filtering":{"doclet":{"description":"Filtering options for the column.","samples":[{"name":"Column filtering","value":"grid-lite/basic/column-filtering"}],"type":{"names":["ColumnFilteringOptions"]}},"meta":{"fullname":"columns.filtering","name":"filtering"},"children":{"rule":{"doclet":{"description":"The active filtering rule applied to the column.","example":"```js\ncolumns: [{\n  id: 'weight',\n  filtering: {\n    enabled: true,\n    rule: {\n      operator: 'greaterThan',\n      value: 100\n    }\n  }\n}]\n```","type":{"names":["FilteringRule"]}},"meta":{"fullname":"columns.filtering.rule","name":"rule"},"children":{"operator":{"doclet":{"description":"The operator to use for filtering the column.","type":{"names":["StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases"]}},"meta":{"fullname":"columns.filtering.rule.operator","name":"operator"},"children":{}},"value":{"doclet":{"description":"The value that is used with the operator to filter the column.","type":{"names":["string","number","boolean","null"]}},"meta":{"fullname":"columns.filtering.rule.value","name":"value"},"children":{}}}},"operators":{"doclet":{"description":"Restricts the list of available filtering operators for the column.\n\nIf set, the UI will only display the provided operators that are valid\nfor the column's `dataType`. Invalid operators are ignored.","example":"```js\ncolumns: [{\n  id: 'name',\n  dataType: 'string',\n  filtering: {\n    enabled: true,\n    operators: ['contains', 'beginsWith']\n  }\n}]\n```","type":{"names":["(StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases)[]"]},"supportsArray":true},"meta":{"fullname":"columns.filtering.operators","name":"operators"},"children":{}},"condition":{"doclet":{"description":"The condition to use for filtering the column.<p><em>Deprecated:</em> Use `rule.operator` instead.</p>","deprecated":"3.1.0","deprnote":"Use `rule.operator` instead.","type":{"names":["StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases"]}},"meta":{"fullname":"columns.filtering.condition","name":"condition"},"children":{}},"value":{"doclet":{"description":"The value that is used with the condition to filter the column.<p><em>Deprecated:</em> Use `rule.value` instead.</p>","deprecated":"3.1.0","deprnote":"Use `rule.value` instead.","type":{"names":["string","number","boolean","null"]}},"meta":{"fullname":"columns.filtering.value","name":"value"},"children":{}},"conditions":{"doclet":{"description":"Restricts the list of available filtering conditions for the column.<p><em>Deprecated:</em> Use `operators` instead.</p>","deprecated":"3.1.0","deprnote":"Use `operators` instead.","example":"```js\ncolumns: [{\n  id: 'name',\n  dataType: 'string',\n  filtering: {\n    enabled: true,\n    conditions: ['contains', 'beginsWith']\n  }\n}]\n```","type":{"names":["(StringCondition | NumberCondition | BooleanCondition | keyof typeof operatorAliases)[]"]},"supportsArray":true},"meta":{"fullname":"columns.filtering.conditions","name":"conditions"},"children":{}},"enabled":{"doclet":{"description":"Whether the filtering is enabled or not.","samples":[{"name":"Column filtering","value":"grid-lite/basic/column-filtering"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"columns.filtering.enabled","name":"enabled","default":"false"},"children":{}},"inline":{"doclet":{"description":"Whether the filtering inputs should be rendered inline in the special\ntable header row (`true`), or should be accessed via a popup (`false`).","samples":[{"name":"Inline filtering","value":"grid-lite/options/inline-filtering"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"columns.filtering.inline","name":"inline","default":"false"},"children":{}},"hideOperatorSelect":{"doclet":{"description":"Hides the operator select in filtering UI.\n\nUses ColumnFilteringOptions.rule operator when valid, otherwise\nthe first operator for the column `dataType` or\nColumnFilteringOptions.operators. Not supported for `boolean`\ncolumns (no value input).","samples":[{"name":"Inline filtering with hidden operator select","value":"grid-lite/options/inline-filtering-hide-select"}],"defaultvalue":"true when {@link ColumnFilteringOptions.operators} has a\n        single entry, otherwise `false`","type":{"names":["boolean"]}},"meta":{"fullname":"columns.filtering.hideOperatorSelect","name":"hideOperatorSelect","default":"true when {@link ColumnFilteringOptions.operators} has a\n        single entry, otherwise `false`"},"children":{}}}},"style":{"doclet":{"description":"CSS styles for the whole column, applied to the header and body cells.\nCan be a static style object or a callback that returns one.","type":{"names":["StyleValue<Column>"]}},"meta":{"fullname":"columns.style","name":"style"},"children":{}},"exportable":{"doclet":{"description":"Whether the column should be included in exports.\n\nFor unbound columns, exporting is always disabled.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"columns.exportable","name":"exportable","default":true},"children":{}},"events":{"doclet":{"description":"Events options triggered by the grid elements.","type":{"names":["ColumnEvents"]},"product":"gridpro"},"meta":{"fullname":"columns.events","name":"events"},"children":{"beforeFilter":{"doclet":{"description":"Callback function to be called when the column is filtered, after input\nkeypress or select change events, but before the filtering is applied.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.events.beforeFilter","name":"beforeFilter"},"children":{}},"afterFilter":{"doclet":{"description":"Callback function to be called when the column is filtered, after input\nkeypress or select change events, and the filtering is applied.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.events.afterFilter","name":"afterFilter"},"children":{}},"beforeSort":{"doclet":{"description":"Callback function to be called when the column is sorted,\nbefore clicking on header.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.events.beforeSort","name":"beforeSort"},"children":{}},"afterSort":{"doclet":{"description":"Callback function to be called when the column is sorted,\nafter clicking on header.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.events.afterSort","name":"afterSort"},"children":{}},"afterResize":{"doclet":{"description":"Callback function to be called when the column is resized.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Table_Column.Column.html\">Column</a> instance.</p>","type":{"names":["(this: Column) => void"]},"product":"gridpro"},"meta":{"fullname":"columns.events.afterResize","name":"afterResize"},"children":{}}}},"rowAggregator":{"doclet":{"description":"Aggregator used for parent rows of the projected tree, in the\n`treeView` and `rowGrouping` features.\n\nWhen provided as a string, the function is applied to every row that\nhas children in the projected tree, overriding the row's source\nvalue. Structural columns such as `data.idColumn`,\n`treeView.input.pathColumn`, `treeView.input.parentIdColumn`, and\n`rowGrouping.groupBy` columns never aggregate, even if configured.\n\nWhen provided as a callback, it is invoked for matching parent rows\nand should return a registered Formula processor function name, or a\nfalsy value to skip aggregation for the current row.\n\nSet it in `columnDefaults` to aggregate every column the same way,\nand to `false` in a single column to reset that default.","samples":[{"name":"TreeView data aggregation","value":"grid-pro/tree-view/data-aggregation"},{"name":"Row grouping","value":"grid-pro/options/row-grouping"}],"type":{"names":["false | string | TreeViewColumnAggregatorCallback"]},"product":"gridpro"},"meta":{"fullname":"columns.rowAggregator","name":"rowAggregator"},"children":{}},"treeView":{"doclet":{"description":"TreeView options for a single column.<p><em>Deprecated:</em> Use the column level `rowAggregator` option instead.</p>","deprecated":"3.1.0","deprnote":"Use the column level `rowAggregator` option instead.","type":{"names":["TreeViewColumnOptions"]},"product":"gridpro"},"meta":{"fullname":"columns.treeView","name":"treeView"},"children":{"aggregator":{"doclet":{"description":"Aggregator used for parent rows in the projected tree.","type":{"names":["false | string | TreeViewColumnAggregatorCallback"]},"product":"gridpro"},"meta":{"fullname":"columns.treeView.aggregator","name":"aggregator"},"children":{}}}}},"doclet":{"description":"Options for individual columns.","supportsArray":true,"type":{"names":["Array<IndividualColumnOptions>"]}},"meta":{"fullname":"columns","name":"columns"}},"credits":{"children":{"enabled":{"doclet":{"description":"Whether to show the credits.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"credits.enabled","name":"enabled","default":true},"children":{}},"href":{"doclet":{"description":"The URL that will be opened when the credits label is clicked.","defaultvalue":"https://www.highcharts.com?credits","type":{"names":["string"]}},"meta":{"fullname":"credits.href","name":"href","default":"https://www.highcharts.com?credits"},"children":{}},"text":{"doclet":{"description":"The text for the credits label.\n\nReference to Highcharts icon, that is enabled in Grid Lite, by default.","type":{"names":["string"]}},"meta":{"fullname":"credits.text","name":"text"},"children":{}},"position":{"doclet":{"description":"The position of the credits label.","defaultvalue":"bottom","type":{"names":["'bottom'","'top'"]}},"meta":{"fullname":"credits.position","name":"position","default":"bottom"},"children":{}}},"doclet":{"description":"Options for the credits label.","product":"gridpro","samples":[{"name":"Credits options","value":"grid-pro/basic/credits"}],"type":{"names":["CreditsOptions"]}},"meta":{"fullname":"credits","name":"credits"}},"data":{"children":{"local":{"doclet":{"description":"Options for data provider type <code>'local'</code>."},"meta":{"fullname":"data.local","name":"local"},"children":{"dataTable":{"doclet":{"description":"Data table as a source of data for the grid.","samples":[{"name":"Data from a DataTable instance","value":"grid-lite/options/data-table-instance"}],"type":{"names":["DataTable"]}},"meta":{"fullname":"data.local.dataTable","name":"dataTable"},"children":{}},"connector":{"doclet":{"description":"Connector instance or options used to populate the data table.","samples":[{"name":"Grid with CSV connector","value":"grid-lite/basic/data-connector"},{"name":"Grid with JSON connector","value":"grid-lite/basic/data-connector-json"},{"name":"Grid with Google Sheets connector","value":"grid-lite/basic/data-connector-google-sheets"},{"name":"Grid with HTML table connector","value":"grid-lite/basic/data-connector-html-table"}],"type":{"names":["GridDataConnectorTypeOptions","DataConnectorType"]}},"meta":{"fullname":"data.local.connector","name":"connector"},"children":{"CSV":{"doclet":{"description":"Options of the CSVConnector.","samples":[{"name":"Grid with CSV connector","value":"grid-lite/basic/data-connector"}]},"meta":{"fullname":"data.local.connector.CSV","name":"CSV"},"children":{"csv":{"doclet":{"description":"Data in CSV format passed directly to connector as a string.","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.CSV.csv","name":"csv"},"children":{}},"csvURL":{"doclet":{"description":"The URL to a remote CSV dataset","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.CSV.csvURL","name":"csvURL"},"children":{}},"decimalPoint":{"doclet":{"description":"The decimal point used for parsing numbers in the CSV.","defaultvalue":".","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.CSV.decimalPoint","name":"decimalPoint","default":"."},"children":{}},"dataRefreshRate":{"doclet":{"description":"The rate in seconds for polling for live data.\nNote that polling requires the option `enablePolling` to be true.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.CSV.dataRefreshRate","name":"dataRefreshRate"},"children":{}},"enablePolling":{"doclet":{"description":"Whether to enable polling for live data.","type":{"names":["boolean"]}},"meta":{"fullname":"data.local.connector.CSV.enablePolling","name":"enablePolling"},"children":{}},"firstRowAsNames":{"doclet":{"description":"Whether to treat the first row of the data set as series names.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"data.local.connector.CSV.firstRowAsNames","name":"firstRowAsNames","default":true},"children":{}},"itemDelimiter":{"doclet":{"description":"Item or cell delimiter for parsing CSV.","defaultvalue":",","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.CSV.itemDelimiter","name":"itemDelimiter","default":","},"children":{}},"beforeParse":{"doclet":{"description":"A custom callback function that parses the data before it's being parsed\nto the data table format inside the converter.","type":{"names":["CSVBeforeParseCallbackFunction"]}},"meta":{"fullname":"data.local.connector.CSV.beforeParse","name":"beforeParse"},"children":{}},"dataModifier":{"doclet":{"type":{"names":["DataModifierTypeOptions"]}},"meta":{"fullname":"data.local.connector.CSV.dataModifier","name":"dataModifier"},"children":{}}}},"JSON":{"doclet":{"description":"Options of the JSONConnector.","samples":[{"name":"Grid with JSON connector","value":"grid-lite/basic/data-connector-json"}]},"meta":{"fullname":"data.local.connector.JSON","name":"JSON"},"children":{"columnIds":{"doclet":{"description":"If JSON data is row oriented, these options define keys for the columns.\nIn column oriented case this is handled automatically unless the\n`firstRowAsNames` set to false, then the `columnIds` can be used.\n\nIn case of complex JSON structure, use the `ColumnIdsOptions` to define\nthe key and path to the data.\n\nIf you have more complex data, you can adjust it by  the `beforeParse`\ncallback function to manually parse the rows into valid JSON. However,\nthe resulting JSON will still be converted into a proper table structure.","type":{"names":["string[]","ColumnIdsOptions"]},"supportsArray":true},"meta":{"fullname":"data.local.connector.JSON.columnIds","name":"columnIds"},"children":{}},"data":{"doclet":{"description":"Data in JSON format.","type":{"names":["number | string[][] | Record<string, number | string>[]"]}},"meta":{"fullname":"data.local.connector.JSON.data","name":"data"},"children":{}},"dataRefreshRate":{"doclet":{"description":"Data refresh rate in seconds.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.JSON.dataRefreshRate","name":"dataRefreshRate"},"children":{}},"dataUrl":{"doclet":{"description":"URL to the JSON data. try it <a href=\"https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/data-tools/datapool-json-connector-dataurl/\">data fetched from url</a>","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.JSON.dataUrl","name":"dataUrl"},"children":{}},"enablePolling":{"doclet":{"description":"Whether polling should be enabled.","type":{"names":["boolean"]}},"meta":{"fullname":"data.local.connector.JSON.enablePolling","name":"enablePolling"},"children":{}},"firstRowAsNames":{"doclet":{"description":"Should first row be treated as names of columns.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"data.local.connector.JSON.firstRowAsNames","name":"firstRowAsNames","default":true},"children":{}},"orientation":{"doclet":{"description":"Whether data is in columns or rows.\n\nTry it:\n\n<a href=\"https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/data-tools/datapool-json-connector-orientation/\">JSON Connector orientation</a>","defaultvalue":"rows","type":{"names":["'columns'","'rows'"]}},"meta":{"fullname":"data.local.connector.JSON.orientation","name":"orientation","default":"rows"},"children":{}},"beforeParse":{"doclet":{"description":"A custom callback function that parses the data before it's being parsed\nto the data table format inside the converter.","type":{"names":["JSONBeforeParseCallbackFunction"]}},"meta":{"fullname":"data.local.connector.JSON.beforeParse","name":"beforeParse"},"children":{}},"dataModifier":{"doclet":{"type":{"names":["DataModifierTypeOptions"]}},"meta":{"fullname":"data.local.connector.JSON.dataModifier","name":"dataModifier"},"children":{}}}},"GoogleSheets":{"doclet":{"description":"Options of the GoogleSheetsConnector.","samples":[{"name":"Grid with Google Sheets connector","value":"grid-lite/basic/data-connector-google-sheets"}]},"meta":{"fullname":"data.local.connector.GoogleSheets","name":"GoogleSheets"},"children":{"dataRefreshRate":{"doclet":{"description":"The rate in seconds for polling for live data.\nNote that polling requires the option `enablePolling` to be true.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.dataRefreshRate","name":"dataRefreshRate"},"children":{}},"enablePolling":{"doclet":{"description":"Whether to enable polling for live data.","type":{"names":["boolean"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.enablePolling","name":"enablePolling"},"children":{}},"endColumn":{"doclet":{"description":"The number of the last column to load.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.endColumn","name":"endColumn"},"children":{}},"endRow":{"doclet":{"description":"The number of the last row to load.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.endRow","name":"endRow"},"children":{}},"firstRowAsNames":{"doclet":{"description":"Whether to treat the first row of the data set as series names.","type":{"names":["boolean"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.firstRowAsNames","name":"firstRowAsNames"},"children":{}},"googleAPIKey":{"doclet":{"description":"The API key for a Google Spreadsheet (user's credentials).\nSee [general information on GS](https://developers.google.com/sheets/api/quickstart/js#create_an_api_key).","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.googleAPIKey","name":"googleAPIKey"},"children":{}},"googleSpreadsheetKey":{"doclet":{"description":"The Google Spreadsheet key that identifies the sheet to use. See\n[general information on googleSpreadsheetKey](#data.googleSpreadsheetKey).\nThe key for a sheet can be extracted from the sheet's URL\n`https://docs.google.com/spreadsheets/d/{key}`.","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.googleSpreadsheetKey","name":"googleSpreadsheetKey"},"children":{}},"googleSpreadsheetRange":{"doclet":{"description":"The Google Spreadsheet `range` to use in combination with\n[googleSpreadsheetKey](#data.googleSpreadsheetKey). See\n[developers.google.com](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get)\nfor details.\n\nIf given, it takes precedence over `startColumn`, `endColumn`, `startRow` and\n`endRow`.","type":{"names":["string"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.googleSpreadsheetRange","name":"googleSpreadsheetRange"},"children":{}},"startColumn":{"doclet":{"description":"The number of the first column to load.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.startColumn","name":"startColumn"},"children":{}},"startRow":{"doclet":{"description":"The number of the first row to load.","type":{"names":["number"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.startRow","name":"startRow"},"children":{}},"beforeParse":{"doclet":{"description":"A custom callback function that parses the data before it's being parsed\nto the data table format inside the converter.","type":{"names":["GoogleSheetsBeforeParseCallbackFunction"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.beforeParse","name":"beforeParse"},"children":{}},"dataModifier":{"doclet":{"type":{"names":["DataModifierTypeOptions"]}},"meta":{"fullname":"data.local.connector.GoogleSheets.dataModifier","name":"dataModifier"},"children":{}}}},"HTMLTable":{"doclet":{"description":"Options of the HTMLTableConnector.","samples":[{"name":"Grid with HTML table connector","value":"grid-lite/basic/data-connector-html-table"}]},"meta":{"fullname":"data.local.connector.HTMLTable","name":"HTMLTable"},"children":{"htmlTable":{"doclet":{"description":"The id of the HTML data table element to load or a reference to the HTML.","type":{"names":["string","HTMLElement"]}},"meta":{"fullname":"data.local.connector.HTMLTable.htmlTable","name":"htmlTable"},"children":{}},"dataModifier":{"doclet":{"type":{"names":["DataModifierTypeOptions"]}},"meta":{"fullname":"data.local.connector.HTMLTable.dataModifier","name":"dataModifier"},"children":{}}}}}},"dataTableKey":{"doclet":{"description":"The connector data table key used as the grid data source. If omitted,\nthe first connector table is used.","type":{"names":["string"]}},"meta":{"fullname":"data.local.dataTableKey","name":"dataTableKey"},"children":{}},"columns":{"doclet":{"description":"Columns data to initialize the Grid with.","samples":[{"name":"Data from column arrays","value":"grid-lite/options/data-columns"}],"type":{"names":["Record<string, Array<DataTableValue>","TypedArray>"]}},"meta":{"fullname":"data.local.columns","name":"columns"},"children":{}},"updateOnChange":{"doclet":{"description":"Automatically update the grid when the data table changes. It is disabled\nby default unles the pagination is enabled.\n\nUse this option if you want the polling to update the grid when the data\ntable changes.","defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"data.local.updateOnChange","name":"updateOnChange","default":"false"},"children":{}},"idColumn":{"doclet":{"description":"The column ID that contains the stable, unique row IDs. If not\nprovided, the original row index is used as the row ID.","type":{"names":["string"]}},"meta":{"fullname":"data.local.idColumn","name":"idColumn"},"children":{}},"treeView":{"doclet":{"description":"Tree view options for local provider (Grid Pro module).<p><em>Deprecated:</em> Use the root level `treeView` and `rowGrouping` instead.</p>","deprecated":"3.1.0","deprnote":"Use the root level `treeView` and `rowGrouping` instead.","type":{"names":["DeprecatedTreeViewOptions"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView","name":"treeView"},"children":{"expandedRowIds":{"doclet":{"description":"Explicit set of expanded row IDs, or `'all'` to expand all tree rows\ninitially.","type":{"names":["RowId[] | 'all'"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.expandedRowIds","name":"expandedRowIds"},"children":{}},"stickyParents":{"doclet":{"description":"Enables sticky parent rows.","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.stickyParents","name":"stickyParents"},"children":{}},"enabled":{"doclet":{"description":"Enables tree view processing. It has to be set explicitly, declaring the\nremaining tree view options alone does not enable the feature.","defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.enabled","name":"enabled","default":"false"},"children":{}},"input":{"doclet":{"description":"Input format definition used to build the tree index.\n\nWhen omitted, TreeView auto-detects the standard `parentId` or `path`\ncolumns and prefers `path` when both exist. For custom input\ndefinitions, set `treeView.input.type` explicitly.","samples":[{"name":"Parent ID tree input","value":"grid-pro/tree-view/parent-id"},{"name":"Path tree input","value":"grid-pro/tree-view/input-path"}],"type":{"names":["TreeInputParentIdOptions | TreeInputPathOptions"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.input","name":"input"},"children":{"parentId":{"doclet":{"description":"Parent-child relation input based on a parent ID column.","product":"gridpro"},"meta":{"fullname":"data.local.treeView.input.parentId","name":"parentId"},"children":{"type":{"doclet":{"description":"Type of the tree input.","type":{"names":["'parentId'"]},"product":"gridpro","defaultvalue":"'parentId'"},"meta":{"fullname":"data.local.treeView.input.parentId.type","name":"type","default":"'parentId'"},"children":{}},"parentIdColumn":{"doclet":{"description":"Column ID containing parent row IDs.\n\nStructural TreeView columns are reserved and rendered readonly.","defaultvalue":"parentId","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.input.parentId.parentIdColumn","name":"parentIdColumn","default":"parentId"},"children":{}}}},"path":{"doclet":{"description":"Parent-child relation input based on full node paths.","product":"gridpro"},"meta":{"fullname":"data.local.treeView.input.path","name":"path"},"children":{"type":{"doclet":{"description":"Type of the tree input.","type":{"names":["'path'"]},"product":"gridpro","defaultvalue":"'path'"},"meta":{"fullname":"data.local.treeView.input.path.type","name":"type","default":"'path'"},"children":{}},"pathColumn":{"doclet":{"description":"Column ID containing full node paths.\n\nPath values must be unique within the source table.","defaultvalue":"path","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.input.path.pathColumn","name":"pathColumn","default":"path"},"children":{}},"separator":{"doclet":{"description":"Path segment separator, a RegExp extracting ordered path segments,\nor a callback returning ordered path segments.","samples":[{"name":"Separator callback","value":"grid-pro/tree-view/separator-callback"}],"defaultvalue":"/","type":{"names":["string | RegExp | TreeInputPathSeparatorCallback"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.input.path.separator","name":"separator","default":"/"},"children":{}},"showFullPath":{"doclet":{"description":"Defines how path values are rendered when the path column is used as\nthe tree column.\n\nIf `true`, renders complete paths. If `false`, renders only\nthe current path segment (leaf node name).","defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.input.path.showFullPath","name":"showFullPath","default":"false"},"children":{}}}}}},"treeColumn":{"doclet":{"description":"Column ID used as the tree column when rendering expand/collapse UI.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"data.local.treeView.treeColumn","name":"treeColumn"},"children":{}}}}}},"remote":{"doclet":{"description":"Options for data provider type <code>'remote'</code>.","product":"gridpro"},"meta":{"fullname":"data.remote","name":"remote"},"children":{"dataSource":{"doclet":{"description":"Serialized data source configuration, alternatively to `fetchCallback`.","samples":[{"name":"Server-side data source","value":"grid-pro/demo/serverside-data"}],"type":{"names":["DataSourceOptions"]},"product":"gridpro"},"meta":{"fullname":"data.remote.dataSource","name":"dataSource"},"children":{"urlTemplate":{"doclet":{"description":"The URL template to be used to fetch data from the remote server.\nAvailable template variables:\n- `page` - The current page number.\n- `pageSize` - The current page size.\n- `offset` - The current offset ((page - 1) * pageSize).\n- `limit` - Alias to `pageSize`.\n- `filter` - The filter conditions.\n- `sortBy` - The sort by conditions.\n- `sortOrder` - The sort order.\n\nExample: `https://api.example.com/data?page={page}&pageSize={pageSize}`\n\nThis list can be extended by adding custom template variables to the\n`templateVariables` option.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"data.remote.dataSource.urlTemplate","name":"urlTemplate"},"children":{}},"templateVariables":{"doclet":{"description":"Custom template variables to be replaced in the `urlTemplate`, extending\nor overriding the built-in set (`page`, `pageSize`, `offset`, `limit`,\n`filter`, `sortBy`, `sortOrder`). Each entry is a function that receives\nthe current `QueryState` and returns the string value to substitute.","type":{"names":["Record<string, (state: QueryState) => string>"]},"product":"gridpro"},"meta":{"fullname":"data.remote.dataSource.templateVariables","name":"templateVariables"},"children":{}},"omitEmpty":{"doclet":{"description":"If `true`, empty query parameters are omitted from the URL.","defaultvalue":true,"type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"data.remote.dataSource.omitEmpty","name":"omitEmpty","default":true},"children":{}},"parseResponse":{"doclet":{"description":"Callback to parse the response from the remote server into a\n`RemoteFetchCallbackResult` object with the following fields:\n\n- `columns` *(required)* — column data keyed by column ID, where each\n  value is an array of cell values for the fetched rows.\n\n- `totalRowCount` *(required)* — total number of rows available on the\n  server for the current query (used to calculate page count and\n  scrollbar size).\n\n- `rowIds` *(optional)* — stable identifiers for the fetched rows.\n  When omitted, the Grid assigns sequential numeric IDs starting from\n  `offset`.\n\n- `pageSize` *(optional)* — effective page size used by the backend for\n  this response. Return this when the server can clamp or otherwise\n  adjust the requested page size so the Grid can keep chunk indexing\n  aligned with the actual response.","type":{"names":["(res: Response) => Promise<RemoteFetchCallbackResult>"]},"product":"gridpro"},"meta":{"fullname":"data.remote.dataSource.parseResponse","name":"parseResponse"},"children":{}},"fetchTimeout":{"doclet":{"description":"Timeout (ms) for the remote request. Set to 0 to disable.","defaultvalue":30000,"type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"data.remote.dataSource.fetchTimeout","name":"fetchTimeout","default":30000},"children":{}}}},"fetchCallback":{"doclet":{"description":"Custom callback to fetch data from the remote server. Has higher priority\nthan `dataSource`.","param":["query\nThe current query state (sorting, filtering, pagination).","offset\nZero-based index of the first row to fetch.","limit\nNumber of rows to fetch.","signal\nAbort signal that fires when the request is superseded by a newer one."],"returns":"A `RemoteFetchCallbackResult` with `columns`, `totalRowCount`, and\noptionally `rowIds` and `pageSize`. See `RemoteFetchCallbackResult` for\nfield descriptions.","samples":[{"name":"Remote fetch callback","value":"grid-pro/options/remote-fetch-callback"}],"type":{"names":["( this: RemoteDataProvider, query: QueryingController, offset: number, limit: number, signal?: AbortSignal ) => Promise<RemoteFetchCallbackResult>"]},"product":"gridpro"},"meta":{"fullname":"data.remote.fetchCallback","name":"fetchCallback"},"children":{}},"setValueCallback":{"doclet":{"description":"Callback to persist value changes to the remote server. If not provided,\ncell value editing will not be possible.\n\nThe callback receives the column ID, row ID and value to set.","type":{"names":["( this: RemoteDataProvider, columnId: string, rowId: RowId, value: DataTableCellType ) => Promise<void>"]},"product":"gridpro"},"meta":{"fullname":"data.remote.setValueCallback","name":"setValueCallback"},"children":{}},"chunkSize":{"doclet":{"description":"The number of rows to fetch per chunk.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"data.remote.chunkSize","name":"chunkSize"},"children":{}},"chunksLimit":{"doclet":{"description":"Maximum number of chunks to keep in memory. When exceeded, the least\nrecently used (LRU) chunk is evicted. If not set, all chunks are kept.","type":{"names":["number"]},"product":"gridpro"},"meta":{"fullname":"data.remote.chunksLimit","name":"chunksLimit"},"children":{}},"requestPolicy":{"doclet":{"description":"Request policy for rapid query changes. `latest` aborts or ignores\nin-flight requests so only the final query updates the cache.","defaultvalue":"latest","type":{"names":["'latest'","'all'"]},"product":"gridpro"},"meta":{"fullname":"data.remote.requestPolicy","name":"requestPolicy","default":"latest"},"children":{}},"idColumn":{"doclet":{"description":"The column ID that contains the stable, unique row IDs. If not\nprovided, the row IDs will be extracted from the `result.rowIds` property\nif available. If `result.rowIds` is also not defined, the row IDs will\ndefault to the indices of the rows in their display order.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"data.remote.idColumn","name":"idColumn"},"children":{}}}}},"doclet":{"description":"Options for the data provider.","samples":[{"name":"Data from connector","value":"grid-lite/basic/data-connector"},{"name":"Data from a DataTable instance","value":"grid-lite/options/data-table-instance"},{"name":"Data from column arrays","value":"grid-lite/options/data-columns"},{"name":"Server-side data","value":"grid-pro/demo/serverside-data"}],"type":{"names":["DataProviderOptionsType"]}},"meta":{"fullname":"data","name":"data"}},"dataTable":{"children":{"columns":{"doclet":{"description":"Initial columns with their values.","type":{"names":["Record<string, Array<DataTableValue>","TypedArray>"]}},"meta":{"fullname":"dataTable.columns","name":"columns"},"children":{}},"id":{"doclet":{"description":"Custom ID to identify the new DataTable instance.","type":{"names":["string"]}},"meta":{"fullname":"dataTable.id","name":"id"},"children":{}},"key":{"doclet":{"description":"A reference to the specific data table key defined in the component's\nconnector options.","type":{"names":["string"]}},"meta":{"fullname":"dataTable.key","name":"key"},"children":{}},"metadata":{"doclet":{"description":"Metadata to describe the dataTable.","type":{"names":["Record<string, DataTableValue>"]}},"meta":{"fullname":"dataTable.metadata","name":"metadata"},"children":{}}},"doclet":{"deprecated":"2.3.0","deprnote":"Use `data.dataTable` instead.","description":"Data table with the data to display in the grid structure. Deprecated,\nuse <a href=\"https://api.highcharts.com/grid/data.local.dataTable\">`data.dataTable`</a>\ninstead.<p><em>Deprecated:</em> Use `data.dataTable` instead.</p>","type":{"names":["DataTable","DataTableOptionsObject"]}},"meta":{"fullname":"dataTable","name":"dataTable"}},"description":{"children":{"className":{"doclet":{"description":"The custom CSS class name for the description.","type":{"names":["string"]}},"meta":{"fullname":"description.className","name":"className"},"children":{}},"text":{"doclet":{"description":"The description of the grid.","type":{"names":["string"]}},"meta":{"fullname":"description.text","name":"text"},"children":{}}},"doclet":{"description":"Options for the description of the grid.","type":{"names":["DescriptionOptions"]}},"meta":{"fullname":"description","name":"description"}},"events":{"children":{"beforeLoad":{"doclet":{"description":"Callback function to be called before the grid is loaded.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>AnyRecord</code></li></ul>","type":{"names":["(this: Grid, e: AnyRecord) => void"]},"product":"gridpro"},"meta":{"fullname":"events.beforeLoad","name":"beforeLoad"},"children":{}},"afterLoad":{"doclet":{"description":"Callback function to be called after the grid is loaded.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>AnyRecord</code></li></ul>","type":{"names":["(this: Grid, e: AnyRecord) => void"]},"product":"gridpro"},"meta":{"fullname":"events.afterLoad","name":"afterLoad"},"children":{}},"beforeUpdate":{"doclet":{"description":"Callback function to be called before the grid options are updated.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>AnyRecord</code></li></ul>","type":{"names":["(this: Grid, e: AnyRecord) => void"]},"product":"gridpro"},"meta":{"fullname":"events.beforeUpdate","name":"beforeUpdate"},"children":{}},"afterUpdate":{"doclet":{"description":"Callback function to be called after the grid options are updated.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>AnyRecord</code></li></ul>","type":{"names":["(this: Grid, e: AnyRecord) => void"]},"product":"gridpro"},"meta":{"fullname":"events.afterUpdate","name":"afterUpdate"},"children":{}},"beforeRedraw":{"doclet":{"description":"Callback function to be called before the grid is redrawn after an\nupdate.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>AnyRecord</code></li></ul>","type":{"names":["(this: Grid, e: AnyRecord) => void"]},"product":"gridpro"},"meta":{"fullname":"events.beforeRedraw","name":"beforeRedraw"},"children":{}},"afterRedraw":{"doclet":{"description":"Callback function to be called after the grid is redrawn after an\nupdate.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>AnyRecord</code></li></ul>","type":{"names":["(this: Grid, e: AnyRecord) => void"]},"product":"gridpro"},"meta":{"fullname":"events.afterRedraw","name":"afterRedraw"},"children":{}},"beforeTreeRowToggle":{"doclet":{"description":"Callback function to be called before a tree row is toggled.\n\nCall `event.preventDefault()` to cancel the toggle.","type":{"names":["(e: BeforeTreeRowToggleEvent) => void"]},"product":"gridpro"},"meta":{"fullname":"events.beforeTreeRowToggle","name":"beforeTreeRowToggle"},"children":{}},"afterTreeRowToggle":{"doclet":{"description":"Callback function to be called after a tree row is toggled.","type":{"names":["(e: AfterTreeRowToggleEvent) => void"]},"product":"gridpro"},"meta":{"fullname":"events.afterTreeRowToggle","name":"afterTreeRowToggle"},"children":{}}},"doclet":{"description":"Events options triggered by the grid.","product":"gridpro","type":{"names":["GridEvents"]}},"meta":{"fullname":"events","name":"events"}},"exporting":{"children":{"filename":{"doclet":{"description":"The file name to use for exported the grid.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"exporting.filename","name":"filename"},"children":{}},"csv":{"doclet":{"description":"Exporting options for the CSV.","type":{"names":["Object"]},"product":"gridpro"},"meta":{"fullname":"exporting.csv","name":"csv"},"children":{"decimalPoint":{"doclet":{"description":"The decimal point to use in the CSV string.","type":{"names":["string"]}},"meta":{"fullname":"exporting.csv.decimalPoint","name":"decimalPoint"},"children":{}},"firstRowAsNames":{"doclet":{"description":"Whether to export the first row as column names. * *","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"exporting.csv.firstRowAsNames","name":"firstRowAsNames","default":true},"children":{}},"itemDelimiter":{"doclet":{"description":"The delimiter used to separate the values in the CSV string. * *","defaultvalue":",","type":{"names":["string"]}},"meta":{"fullname":"exporting.csv.itemDelimiter","name":"itemDelimiter","default":","},"children":{}},"lineDelimiter":{"doclet":{"description":"The delimiter used to separate the lines in the CSV string. * *","defaultvalue":"\\n","type":{"names":["string"]}},"meta":{"fullname":"exporting.csv.lineDelimiter","name":"lineDelimiter","default":"\\n"},"children":{}},"useLocalDecimalPoint":{"doclet":{"description":"Whether to use the local decimal point as detected from the * browser. * *","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"exporting.csv.useLocalDecimalPoint","name":"useLocalDecimalPoint","default":true},"children":{}}}}},"doclet":{"description":"Options for the exporting.","product":"gridpro","samples":[{"name":"Export to CSV","value":"grid-pro/basic/exporting"}],"type":{"names":["ExportingOptions"]}},"meta":{"fullname":"exporting","name":"exporting"}},"gridKey":{"children":{},"doclet":{"description":"Grid Key for Grid Pro. Get your Grid Key at:\nhttps://shop.highcharts.com\n\nThe Grid Key can be set globally using `Grid.setOptions()` or\non individual Grid instances.","product":"gridpro","example":["Global setting.\n\nGrid.setOptions({\n  gridKey: 'XXXX-XXXX-XXXX-AYYY-ZZZZ-WWWW'\n});","Per instance.\n\nGrid.grid('container', {\n  gridKey: 'XXXX-XXXX-XXXX-AYYY-ZZZZ-WWWW'\n});"],"type":{"names":["string"]}},"meta":{"fullname":"gridKey","name":"gridKey"}},"header":{"children":{"accessibility":{"doclet":{"description":"Accessibility options for one of the column header cells.","type":{"names":["HeaderCellA11yOptions"]}},"meta":{"fullname":"header.accessibility","name":"accessibility"},"children":{"description":{"doclet":{"description":"The aria description of the header cell.","type":{"names":["string"]}},"meta":{"fullname":"header.accessibility.description","name":"description"},"children":{}}}},"format":{"doclet":{"description":"The format of the column header. Use `{id}` to display the column id.","type":{"names":["string"]}},"meta":{"fullname":"header.format","name":"format"},"children":{}},"className":{"doclet":{"description":"The custom CSS class name for the header.","type":{"names":["string"]}},"meta":{"fullname":"header.className","name":"className"},"children":{}},"columnId":{"doclet":{"description":"The id of column with data.","type":{"names":["string"]}},"meta":{"fullname":"header.columnId","name":"columnId"},"children":{}},"columns":{"doclet":{"description":"Columns that are displayed below the header.","type":{"names":["GroupedHeaderOptions[]"]},"supportsArray":true},"meta":{"fullname":"header.columns","name":"columns"},"children":{}}},"doclet":{"description":"Defines the structure of levels in header. Used for grouping columns\nheaders.\n\nAn array where each item can be either a string (column ID) or an object\nof type <a href=\"https://api.highcharts.com/grid/typedoc/interfaces/Grid_Core_Options.GroupedHeaderOptions.html\">GroupedHeaderOptions</a>.","supportsArray":true,"samples":[{"name":"Grouped headers","value":"grid-lite/basic/grouped-headers"}],"type":{"names":["Array<GroupedHeaderOptions|string>"]}},"meta":{"fullname":"header","name":"header"}},"id":{"children":{},"doclet":{"description":"The unique id of the grid. It is generated automatically, if not set.","type":{"names":["string"]}},"meta":{"fullname":"id","name":"id"}},"lang":{"children":{"accessibility":{"doclet":{"description":"Configure the accessibility strings in the chart.","type":{"names":["LangAccessibilityOptions"]}},"meta":{"fullname":"lang.accessibility","name":"accessibility"},"children":{"sorting":{"doclet":{"description":"Language options for the accessibility descriptions in sorting.","type":{"names":["SortingLangA11yOptions"]}},"meta":{"fullname":"lang.accessibility.sorting","name":"sorting"},"children":{"sortable":{"doclet":{"description":"An additional hint (a visually hidden span) read by the voice over\nafter the column name.","defaultvalue":"Sortable.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.sorting.sortable","name":"sortable","default":"Sortable."},"children":{}},"announcements":{"doclet":{"description":"Accessibility lang options for the sorting announcements.","type":{"names":["Object"]}},"meta":{"fullname":"lang.accessibility.sorting.announcements","name":"announcements"},"children":{"ascending":{"doclet":{"description":"The message when the column was sorted in ascending order. * *","defaultvalue":"Sorted ascending.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.sorting.announcements.ascending","name":"ascending","default":"Sorted ascending."},"children":{}},"descending":{"doclet":{"description":"The message when the column was sorted in descending order. * *","defaultvalue":"Sorted descending.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.sorting.announcements.descending","name":"descending","default":"Sorted descending."},"children":{}},"none":{"doclet":{"description":"The message when the column was unsorted. * *","defaultvalue":"Not sorted.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.sorting.announcements.none","name":"none","default":"Not sorted."},"children":{}}}},"priority":{"doclet":{"description":"The message for multi-column sort priority. Use `{priority}` to insert\nthe priority index.","defaultvalue":"Priority {priority}.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.sorting.priority","name":"priority","default":"Priority {priority}."},"children":{}}}},"pagination":{"doclet":{"description":"Language options for the accessibility descriptions in pagination.","type":{"names":["PaginationLangA11yOptions"]}},"meta":{"fullname":"lang.accessibility.pagination","name":"pagination"},"children":{"announcements":{"doclet":{"description":"Language options for the accessibility descriptions in pagination.","type":{"names":["Object"]}},"meta":{"fullname":"lang.accessibility.pagination.announcements","name":"announcements"},"children":{"pageSizeChange":{"doclet":{"description":"The message when the page size was changed. * *","defaultvalue":"Page size changed to.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.pagination.announcements.pageSizeChange","name":"pageSizeChange","default":"Page size changed to."},"children":{}},"pageChange":{"doclet":{"description":"The message when the page was changed. * *","defaultvalue":"Page changed to.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.pagination.announcements.pageChange","name":"pageChange","default":"Page changed to."},"children":{}}}}}},"filtering":{"doclet":{"description":"Language options for the accessibility descriptions in filtering.","type":{"names":["FilteringLangA11yOptions"]}},"meta":{"fullname":"lang.accessibility.filtering","name":"filtering"},"children":{"announcements":{"doclet":{"description":"Language options for the accessibility descriptions in filtering.","type":{"names":["Object"]}},"meta":{"fullname":"lang.accessibility.filtering.announcements","name":"announcements"},"children":{"filterApplied":{"doclet":{"description":"The message when the filter was applied. * *","defaultvalue":"Filter applied for {columnId}, {condition} {value}. {rowsCount} results found.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.filtering.announcements.filterApplied","name":"filterApplied","default":"Filter applied for {columnId}, {condition} {value}. {rowsCount} results found."},"children":{}},"emptyFilterApplied":{"doclet":{"description":"The message when the filter was applied for empty-like conditions. * *","defaultvalue":"Filter applied for {columnId}, {condition} values. {rowsCount} results found.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.filtering.announcements.emptyFilterApplied","name":"emptyFilterApplied","default":"Filter applied for {columnId}, {condition} values. {rowsCount} results found."},"children":{}},"filterCleared":{"doclet":{"description":"The message when the filter was cleared. * *","defaultvalue":"Filter cleared for {columnId}. {rowsCount} results found.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.filtering.announcements.filterCleared","name":"filterCleared","default":"Filter cleared for {columnId}. {rowsCount} results found."},"children":{}}}}}},"columnMenu":{"doclet":{"description":"Accessible label for the minimized column header menu button. Use\n`{column}` to insert the current column label.","defaultvalue":"Open menu for {column}.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.columnMenu","name":"columnMenu","default":"Open menu for {column}."},"children":{}},"screenReaderSection":{"doclet":{"description":"Language options for screen reader sections before and after the Grid.","type":{"names":["ScreenReaderSectionLangOptions"]}},"meta":{"fullname":"lang.accessibility.screenReaderSection","name":"screenReaderSection"},"children":{"beforeRegionLabel":{"doclet":{"description":"Text for the aria-label attribute of the before screen reader region.","defaultvalue":0,"type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.screenReaderSection.beforeRegionLabel","name":"beforeRegionLabel","default":0},"children":{}},"afterRegionLabel":{"doclet":{"description":"Text for the aria-label attribute of the after screen reader region.","defaultvalue":0,"type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.screenReaderSection.afterRegionLabel","name":"afterRegionLabel","default":0},"children":{}}}},"cellEditing":{"doclet":{"description":"Language options for the accessibility descriptions in cell editing.","type":{"names":["CellEditingLangA11yOptions"]},"product":"gridpro"},"meta":{"fullname":"lang.accessibility.cellEditing","name":"cellEditing"},"children":{"editable":{"doclet":{"description":"An additional hint (a visually hidden span) read by the voice over\nafter the cell value.","defaultvalue":"Editable.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.accessibility.cellEditing.editable","name":"editable","default":"Editable."},"children":{}},"announcements":{"doclet":{"description":"Accessibility lang options for the cell editing announcements.","type":{"names":["Object"]},"product":"gridpro"},"meta":{"fullname":"lang.accessibility.cellEditing.announcements","name":"announcements"},"children":{"started":{"doclet":{"description":"The message when the cell editing started. * *","defaultvalue":"Entered cell editing mode.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.cellEditing.announcements.started","name":"started","default":"Entered cell editing mode."},"children":{}},"edited":{"doclet":{"description":"The message when the cell editing ended. * *","defaultvalue":"Edited cell value.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.cellEditing.announcements.edited","name":"edited","default":"Edited cell value."},"children":{}},"cancelled":{"doclet":{"description":"The message when the cell editing was cancelled. * *","defaultvalue":"Editing cancelled.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.cellEditing.announcements.cancelled","name":"cancelled","default":"Editing cancelled."},"children":{}},"notValid":{"doclet":{"description":"The message when the cell value is not valid. It precedes the * error messages. * *","defaultvalue":"Provided value is not valid.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.cellEditing.announcements.notValid","name":"notValid","default":"Provided value is not valid."},"children":{}}}}}},"rowPinning":{"doclet":{"description":"Accessibility language options for row pinning.","type":{"names":["RowPinningLangA11yOptions"]},"product":"gridpro"},"meta":{"fullname":"lang.accessibility.rowPinning","name":"rowPinning"},"children":{"announcements":{"doclet":{"description":"Screen reader announcements for row pinning state changes.","type":{"names":["Object"]},"product":"gridpro"},"meta":{"fullname":"lang.accessibility.rowPinning.announcements","name":"announcements"},"children":{"pinned":{"doclet":{"description":"Message announced after a row is pinned. * * Use `{rowId}` and `{position}` placeholders to insert runtime data. * *","defaultvalue":"Row {rowId} pinned to {position}.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.rowPinning.announcements.pinned","name":"pinned","default":"Row {rowId} pinned to {position}."},"children":{}},"unpinned":{"doclet":{"description":"Message announced after a row is unpinned. * * Use `{rowId}` to insert the pinned row identifier. * *","defaultvalue":"Row {rowId} unpinned.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.rowPinning.announcements.unpinned","name":"unpinned","default":"Row {rowId} unpinned."},"children":{}}}},"descriptions":{"doclet":{"description":"Additional descriptions exposed for pinned rows.","type":{"names":["Object"]},"product":"gridpro"},"meta":{"fullname":"lang.accessibility.rowPinning.descriptions","name":"descriptions"},"children":{"pinnedTop":{"doclet":{"description":"Description for rows pinned to the top section. * *","defaultvalue":"Pinned row in top section.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.rowPinning.descriptions.pinnedTop","name":"pinnedTop","default":"Pinned row in top section."},"children":{}},"pinnedBottom":{"doclet":{"description":"Description for rows pinned to the bottom section. * *","defaultvalue":"Pinned row in bottom section.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.rowPinning.descriptions.pinnedBottom","name":"pinnedBottom","default":"Pinned row in bottom section."},"children":{}},"alsoPinnedTop":{"doclet":{"description":"Description added when a rendered row also exists in the top pinned * section. * *","defaultvalue":"This row is also pinned to top section.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.rowPinning.descriptions.alsoPinnedTop","name":"alsoPinnedTop","default":"This row is also pinned to top section."},"children":{}},"alsoPinnedBottom":{"doclet":{"description":"Description added when a rendered row also exists in the bottom * pinned section. * *","defaultvalue":"This row is also pinned to bottom section.","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.rowPinning.descriptions.alsoPinnedBottom","name":"alsoPinnedBottom","default":"This row is also pinned to bottom section."},"children":{}}}}}}}},"loading":{"doclet":{"description":"The text to display when the loading indicator is shown.","defaultvalue":"Loading...","type":{"names":["string"]}},"meta":{"fullname":"lang.loading","name":"loading","default":"Loading..."},"children":{}},"noData":{"doclet":{"description":"The text to display when there is no data to show.","defaultvalue":"No data to display","type":{"names":["string"]}},"meta":{"fullname":"lang.noData","name":"noData","default":"No data to display"},"children":{}},"filter":{"doclet":{"description":"`Filter` translation.","defaultvalue":"Filter","type":{"names":["string"]}},"meta":{"fullname":"lang.filter","name":"filter","default":"Filter"},"children":{}},"sortAscending":{"doclet":{"description":"`Sort ascending` translation.","defaultvalue":"Sort ascending","type":{"names":["string"]}},"meta":{"fullname":"lang.sortAscending","name":"sortAscending","default":"Sort ascending"},"children":{}},"sortDescending":{"doclet":{"description":"`Sort descending` translation.","defaultvalue":"Sort descending","type":{"names":["string"]}},"meta":{"fullname":"lang.sortDescending","name":"sortDescending","default":"Sort descending"},"children":{}},"column":{"doclet":{"description":"`Column` translation.","defaultvalue":"Column","type":{"names":["string"]}},"meta":{"fullname":"lang.column","name":"column","default":"Column"},"children":{}},"setFilter":{"doclet":{"description":"`Set filter` translation.","defaultvalue":"Set filter","type":{"names":["string"]}},"meta":{"fullname":"lang.setFilter","name":"setFilter","default":"Set filter"},"children":{}},"filterValuePlaceholder":{"doclet":{"description":"Placeholder for the filter value input when the operator select is\nvisible.","defaultvalue":"Value...","type":{"names":["string"]}},"meta":{"fullname":"lang.filterValuePlaceholder","name":"filterValuePlaceholder","default":"Value..."},"children":{}},"columnFilteringOperators":{"doclet":{"description":"Language options for column filtering operators.","type":{"names":[" Record<ColumnFilteringCondition, string> "]}},"meta":{"fullname":"lang.columnFilteringOperators","name":"columnFilteringOperators"},"children":{}},"columnFilteringDateTimeOperators":{"doclet":{"description":"Language options for column filtering operator labels on datetime\ncolumns. Overrides matching keys from `columnFilteringOperators`.","type":{"names":[" Record<ColumnFilteringCondition, string> "]}},"meta":{"fullname":"lang.columnFilteringDateTimeOperators","name":"columnFilteringDateTimeOperators"},"children":{}},"columnFilteringConditions":{"doclet":{"description":"Language options for column filtering conditions.<p><em>Deprecated:</em> Use `columnFilteringOperators` instead.</p>","deprecated":"3.1.0","deprnote":"Use `columnFilteringOperators` instead.","type":{"names":[" Record<ColumnFilteringCondition, string> "]}},"meta":{"fullname":"lang.columnFilteringConditions","name":"columnFilteringConditions"},"children":{}},"pagination":{"doclet":{"description":"Language options for pagination text values.","type":{"names":["PaginationLangOptions"]}},"meta":{"fullname":"lang.pagination","name":"pagination"},"children":{"pageInfo":{"doclet":{"description":"Text for the page information display.\nPlaceholders: {start}, {end}, {total}, {currentPage}, {totalPages}","defaultvalue":"Showing {start} - {end} of {total} (Page {currentPage} of {totalPages})","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.pageInfo","name":"pageInfo","default":"Showing {start} - {end} of {total} (Page {currentPage} of {totalPages})"},"children":{}},"pageSizeLabel":{"doclet":{"description":"Text for the page size label.","defaultvalue":"rows per page","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.pageSizeLabel","name":"pageSizeLabel","default":"rows per page"},"children":{}},"firstPage":{"doclet":{"description":"Text for the first page button (accessibility).","defaultvalue":"First page","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.firstPage","name":"firstPage","default":"First page"},"children":{}},"previousPage":{"doclet":{"description":"Text for the previous page button (accessibility).","defaultvalue":"Previous page","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.previousPage","name":"previousPage","default":"Previous page"},"children":{}},"nextPage":{"doclet":{"description":"Text for the next page button (accessibility).","defaultvalue":"Next page","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.nextPage","name":"nextPage","default":"Next page"},"children":{}},"lastPage":{"doclet":{"description":"Text for the last page button (accessibility).","defaultvalue":"Last page","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.lastPage","name":"lastPage","default":"Last page"},"children":{}},"pageNumber":{"doclet":{"description":"Text for page number button (accessibility).\nPlaceholder: {page}","defaultvalue":"Page {page}","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.pageNumber","name":"pageNumber","default":"Page {page}"},"children":{}},"ellipsis":{"doclet":{"description":"Text for ellipsis (accessibility).","defaultvalue":"More pages","type":{"names":["string"]}},"meta":{"fullname":"lang.pagination.ellipsis","name":"ellipsis","default":"More pages"},"children":{}}}},"validationNotifications":{"doclet":{"description":"Localized validation notifications for predefined rules or custom\nvalidators.","type":{"names":["ValidationNotificationsType"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications","name":"validationNotifications"},"children":{"boolean":{"doclet":{"description":"Notification text for the `boolean` validator.","defaultvalue":"Value has to be a boolean.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.boolean","name":"boolean","default":"Value has to be a boolean."},"children":{}},"datetime":{"doclet":{"description":"Notification text for the `datetime` validator.","defaultvalue":"Value has to be parsed to a valid timestamp.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.datetime","name":"datetime","default":"Value has to be parsed to a valid timestamp."},"children":{}},"notEmpty":{"doclet":{"description":"Notification text for the `notEmpty` validator.","defaultvalue":"Value cannot be empty.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.notEmpty","name":"notEmpty","default":"Value cannot be empty."},"children":{}},"number":{"doclet":{"description":"Notification text for the `number` validator.","defaultvalue":"Value has to be a number.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.number","name":"number","default":"Value has to be a number."},"children":{}},"ignoreCaseUnique":{"doclet":{"description":"Notification text for the `ignoreCaseUnique` validator.","defaultvalue":"Value must be unique within this column (case-insensitive).","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.ignoreCaseUnique","name":"ignoreCaseUnique","default":"Value must be unique within this column (case-insensitive)."},"children":{}},"unique":{"doclet":{"description":"Notification text for the `unique` validator.","defaultvalue":"Value must be unique within this column (case-sensitive).","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.unique","name":"unique","default":"Value must be unique within this column (case-sensitive)."},"children":{}},"arrayNumber":{"doclet":{"description":"Notification text for the `arrayNumber` validator.","defaultvalue":"Value should be a list of numbers separated by commas.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.arrayNumber","name":"arrayNumber","default":"Value should be a list of numbers separated by commas."},"children":{}},"json":{"doclet":{"description":"Notification text for the `json` validator.","defaultvalue":"Value should be a valid JSON.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.json","name":"json","default":"Value should be a valid JSON."},"children":{}},"sparkline":{"doclet":{"description":"Notification text for the `sparkline` validator.","defaultvalue":"Value should be a valid JSON or a list of numbers separated by commas.","type":{"names":["string | ValidationNotificationFunction"]},"product":"gridpro"},"meta":{"fullname":"lang.validationNotifications.sparkline","name":"sparkline","default":"Value should be a valid JSON or a list of numbers separated by commas."},"children":{}}}},"rowPinning":{"doclet":{"description":"Language options for the row pinning feature.","type":{"names":["RowPinningLangOptions"]},"product":"gridpro"},"meta":{"fullname":"lang.rowPinning","name":"rowPinning"},"children":{"label":{"doclet":{"description":"Label used for the built-in row pinning context menu group.","defaultvalue":"Row pinning","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.rowPinning.label","name":"label","default":"Row pinning"},"children":{}},"pinRowTop":{"doclet":{"description":"Label used for the built-in \"pin row to top\" action.","defaultvalue":"Pin row to top","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.rowPinning.pinRowTop","name":"pinRowTop","default":"Pin row to top"},"children":{}},"pinRowBottom":{"doclet":{"description":"Label used for the built-in \"pin row to bottom\" action.","defaultvalue":"Pin row to bottom","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.rowPinning.pinRowBottom","name":"pinRowBottom","default":"Pin row to bottom"},"children":{}},"unpinRow":{"doclet":{"description":"Label used for the built-in \"unpin row\" action.","defaultvalue":"Unpin row","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.rowPinning.unpinRow","name":"unpinRow","default":"Unpin row"},"children":{}}}},"pinRowTop":{"doclet":{"description":"Label used for the built-in \"pin row to top\" action.<p><em>Deprecated:</em> Use `lang.rowPinning.pinRowTop` instead.</p>","defaultvalue":"Pin row to top","deprecated":"3.1.0","deprnote":"Use `lang.rowPinning.pinRowTop` instead.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.pinRowTop","name":"pinRowTop","default":"Pin row to top"},"children":{}},"pinRowBottom":{"doclet":{"description":"Label used for the built-in \"pin row to bottom\" action.<p><em>Deprecated:</em> Use `lang.rowPinning.pinRowBottom` instead.</p>","defaultvalue":"Pin row to bottom","deprecated":"3.1.0","deprnote":"Use `lang.rowPinning.pinRowBottom` instead.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.pinRowBottom","name":"pinRowBottom","default":"Pin row to bottom"},"children":{}},"unpinRow":{"doclet":{"description":"Label used for the built-in \"unpin row\" action.<p><em>Deprecated:</em> Use `lang.rowPinning.unpinRow` instead.</p>","defaultvalue":"Unpin row","deprecated":"3.1.0","deprnote":"Use `lang.rowPinning.unpinRow` instead.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.unpinRow","name":"unpinRow","default":"Unpin row"},"children":{}},"tableEditing":{"doclet":{"description":"Language options for the table editing feature.","type":{"names":["TableEditingLangOptions"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing","name":"tableEditing"},"children":{"rows":{"doclet":{"description":"Label used for the built-in row editing context menu group.","defaultvalue":"Rows","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.rows","name":"rows","default":"Rows"},"children":{}},"columns":{"doclet":{"description":"Label used for the built-in column editing context menu group.","defaultvalue":"Columns","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.columns","name":"columns","default":"Columns"},"children":{}},"addRowAbove":{"doclet":{"description":"Label used for the built-in \"add row above\" action.","defaultvalue":"Add row above","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.addRowAbove","name":"addRowAbove","default":"Add row above"},"children":{}},"addRowBelow":{"doclet":{"description":"Label used for the built-in \"add row below\" action.","defaultvalue":"Add row below","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.addRowBelow","name":"addRowBelow","default":"Add row below"},"children":{}},"deleteRow":{"doclet":{"description":"Label used for the built-in \"delete row\" action.","defaultvalue":"Delete row","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.deleteRow","name":"deleteRow","default":"Delete row"},"children":{}},"addColumnBefore":{"doclet":{"description":"Label used for the built-in \"add column before\" action.","defaultvalue":"Add column before","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.addColumnBefore","name":"addColumnBefore","default":"Add column before"},"children":{}},"addColumnAfter":{"doclet":{"description":"Label used for the built-in \"add column after\" action.","defaultvalue":"Add column after","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.addColumnAfter","name":"addColumnAfter","default":"Add column after"},"children":{}},"deleteColumn":{"doclet":{"description":"Label used for the built-in \"delete column\" action.","defaultvalue":"Delete column","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.tableEditing.deleteColumn","name":"deleteColumn","default":"Delete column"},"children":{}}}},"rowGrouping":{"doclet":{"description":"Language options for the row grouping feature.","type":{"names":["RowGroupingLangOptions"]},"product":"gridpro"},"meta":{"fullname":"lang.rowGrouping","name":"rowGrouping"},"children":{"columnHeader":{"doclet":{"description":"Header of the generated group column, used when the column has no header\noptions configured.","defaultvalue":"Group","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"lang.rowGrouping.columnHeader","name":"columnHeader","default":"Group"},"children":{}}}},"decimalPoint":{"doclet":{"type":{"names":["string"]}},"meta":{"fullname":"lang.decimalPoint","name":"decimalPoint"},"children":{}},"invalidDate":{"doclet":{"type":{"names":["string"]}},"meta":{"fullname":"lang.invalidDate","name":"invalidDate"},"children":{}},"locale":{"doclet":{"type":{"names":["string","Array<string>"]},"supportsArray":true},"meta":{"fullname":"lang.locale","name":"locale"},"children":{}},"months":{"doclet":{"type":{"names":["Array<string>"]},"supportsArray":true},"meta":{"fullname":"lang.months","name":"months"},"children":{}},"shortMonths":{"doclet":{"type":{"names":["Array<string>"]},"supportsArray":true},"meta":{"fullname":"lang.shortMonths","name":"shortMonths"},"children":{}},"shortWeekdays":{"doclet":{"type":{"names":["Array<string>"]},"supportsArray":true},"meta":{"fullname":"lang.shortWeekdays","name":"shortWeekdays"},"children":{}},"thousandsSep":{"doclet":{"type":{"names":["string"]}},"meta":{"fullname":"lang.thousandsSep","name":"thousandsSep"},"children":{}},"weekdays":{"doclet":{"type":{"names":["Array<string>"]},"supportsArray":true},"meta":{"fullname":"lang.weekdays","name":"weekdays"},"children":{}},"weekFrom":{"doclet":{"type":{"names":["string"]}},"meta":{"fullname":"lang.weekFrom","name":"weekFrom"},"children":{}}},"doclet":{"description":"Language options for the grid.","samples":[{"name":"Internationalization","value":"grid-lite/demo/internationalization"}],"type":{"names":["LangOptions"]}},"meta":{"fullname":"lang","name":"lang"}},"pagination":{"children":{"enabled":{"doclet":{"description":"Whether the pagination should be rendered.","samples":[{"name":"Pagination alignment","value":"grid-lite/basic/pagination-alignment-controls"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"pagination.enabled","name":"enabled","default":"false"},"children":{}},"className":{"doclet":{"description":"Additional CSS class name(s) for the pagination container.","type":{"names":["string"]}},"meta":{"fullname":"pagination.className","name":"className"},"children":{}},"page":{"doclet":{"description":"The current page number.","defaultvalue":1,"type":{"names":["number"]}},"meta":{"fullname":"pagination.page","name":"page","default":1},"children":{}},"pageSize":{"doclet":{"description":"Initial number of items per page when the Grid is initialized.\nThis value will be used as the default page size if not specified\nin pageSizeSelector options.","defaultvalue":10,"type":{"names":["number"]}},"meta":{"fullname":"pagination.pageSize","name":"pageSize","default":10},"children":{}},"position":{"doclet":{"description":"Position of the pagination container relative to the table.","defaultvalue":"bottom","type":{"names":["string"]}},"meta":{"fullname":"pagination.position","name":"position","default":"bottom"},"children":{}},"align":{"doclet":{"description":"Alignment of the pagination elements within the wrapper.","samples":[{"name":"Pagination alignment","value":"grid-lite/basic/pagination-alignment-controls"}],"type":{"names":["'left'","'center'","'right'","'distributed'"]}},"meta":{"fullname":"pagination.align","name":"align"},"children":{}},"controls":{"doclet":{"description":"Controls options for pagination UI elements.","type":{"names":["PaginationControlsOptions"]}},"meta":{"fullname":"pagination.controls","name":"controls"},"children":{"className":{"doclet":{"description":"Additional CSS class name(s) for the controls container.","type":{"names":["string"]}},"meta":{"fullname":"pagination.controls.className","name":"className"},"children":{}},"pageSizeSelector":{"doclet":{"description":"Page size selector configuration including available options and enabled\nstate. Users can select from the options to change the number of items\ndisplayed per page.","defaultvalue":"{ enabled: true, options: [10, 20, 50, 100] }","type":{"names":["boolean","PageSizeSelectorOptions"]}},"meta":{"fullname":"pagination.controls.pageSizeSelector","name":"pageSizeSelector","default":"{ enabled: true, options: [10, 20, 50, 100] }"},"children":{"enabled":{"doclet":{"description":"Whether the page size selector is enabled.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"pagination.controls.pageSizeSelector.enabled","name":"enabled","default":true},"children":{}},"options":{"doclet":{"description":"Available options for page size dropdown.","defaultvalue":"[10, 20, 50, 100]","type":{"names":["Array<number>"]},"supportsArray":true},"meta":{"fullname":"pagination.controls.pageSizeSelector.options","name":"options","default":"[10, 20, 50, 100]"},"children":{}},"className":{"doclet":{"description":"Additional CSS class name(s) for the page size container.","type":{"names":["string"]}},"meta":{"fullname":"pagination.controls.pageSizeSelector.className","name":"className"},"children":{}}}},"pageInfo":{"doclet":{"description":"Whether to show the page information text\n(e.g., \"Showing 1 - 20 of 200\").","defaultvalue":true,"type":{"names":["boolean","PageInfoOptions"]}},"meta":{"fullname":"pagination.controls.pageInfo","name":"pageInfo","default":true},"children":{"enabled":{"doclet":{"description":"Whether to show the page information text.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"pagination.controls.pageInfo.enabled","name":"enabled","default":true},"children":{}},"className":{"doclet":{"description":"Additional CSS class name(s) for the page info element.","type":{"names":["string"]}},"meta":{"fullname":"pagination.controls.pageInfo.className","name":"className"},"children":{}}}},"firstLastButtons":{"doclet":{"description":"Whether to show the first/last page controls buttons.","defaultvalue":true,"type":{"names":["boolean","FirstLastButtonsOptions"]}},"meta":{"fullname":"pagination.controls.firstLastButtons","name":"firstLastButtons","default":true},"children":{"enabled":{"doclet":{"description":"Whether to show the first/last page navigation buttons.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"pagination.controls.firstLastButtons.enabled","name":"enabled","default":true},"children":{}}}},"previousNextButtons":{"doclet":{"description":"Whether to show the previous/next page controls buttons.","defaultvalue":true,"type":{"names":["boolean","PreviousNextButtonsOptions"]}},"meta":{"fullname":"pagination.controls.previousNextButtons","name":"previousNextButtons","default":true},"children":{"enabled":{"doclet":{"description":"Whether to show the previous/next page navigation buttons.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"pagination.controls.previousNextButtons.enabled","name":"enabled","default":true},"children":{}}}},"pageButtons":{"doclet":{"description":"Page number buttons configuration.","defaultvalue":"{ enabled: true, count: 5 }","type":{"names":["boolean","PageButtonsOptions"]}},"meta":{"fullname":"pagination.controls.pageButtons","name":"pageButtons","default":"{ enabled: true, count: 5 }"},"children":{"enabled":{"doclet":{"description":"Whether to show page number buttons.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"pagination.controls.pageButtons.enabled","name":"enabled","default":true},"children":{}},"count":{"doclet":{"description":"Maximum number of page number buttons to show before using ellipsis.","defaultvalue":5,"type":{"names":["number"]}},"meta":{"fullname":"pagination.controls.pageButtons.count","name":"count","default":5},"children":{}}}}}},"events":{"doclet":{"description":"Pagination events.","type":{"names":["PaginationEvents"]},"product":"gridpro"},"meta":{"fullname":"pagination.events","name":"events"},"children":{"beforePageChange":{"doclet":{"description":"Fired before a page change occurs.","param":"e\nThe event object.","type":{"names":["(e: BeforePageChangeEvent) => void"]},"product":"gridpro"},"meta":{"fullname":"pagination.events.beforePageChange","name":"beforePageChange"},"children":{}},"afterPageChange":{"doclet":{"description":"Fired after a page change occurs.","param":"e\nThe event object.","type":{"names":["(e: AfterPageChangeEvent) => void"]},"product":"gridpro"},"meta":{"fullname":"pagination.events.afterPageChange","name":"afterPageChange"},"children":{}},"beforePageSizeChange":{"doclet":{"description":"Fired before the page size setting changes.","param":"e\nThe event object.","type":{"names":["(e: BeforePageSizeChangeEvent) => void"]},"product":"gridpro"},"meta":{"fullname":"pagination.events.beforePageSizeChange","name":"beforePageSizeChange"},"children":{}},"afterPageSizeChange":{"doclet":{"description":"Fired after the page size setting changes.","param":"e\nThe event object.","type":{"names":["(e: AfterPageSizeChangeEvent) => void"]},"product":"gridpro"},"meta":{"fullname":"pagination.events.afterPageSizeChange","name":"afterPageSizeChange"},"children":{}}}}},"doclet":{"description":"Pagination options for the grid.","samples":[{"name":"Pagination","value":"grid-lite/basic/pagination-alignment-controls"}],"type":{"names":["PaginationOptions"]}},"meta":{"fullname":"pagination","name":"pagination"}},"rendering":{"children":{"icons":{"doclet":{"description":"Custom or override icons for the grid. Keys are icon names (either\nbuilt-in names from the default registry or custom names). Values\nare either an SVG definition object or a raw SVG markup string.\nBuilt-in icons can be overridden; new names can be used for custom\nicons and referenced where an icon name is accepted (e.g. menu\nitems, pagination buttons).","example":"```js\nrendering: {\n  icons: {\n    chevronRight: '<svg>...</svg>',\n    myCustomIcon: { width: 16, height: 16, children: [{ d: '...' }] }\n  }\n}\n```","samples":[{"name":"Custom icons","value":"grid-lite/basic/custom-icons"}],"type":{"names":["Record<string, IconRegistryValue>"]}},"meta":{"fullname":"rendering.icons","name":"icons"},"children":{}},"columns":{"doclet":{"description":"Options to control the columns rendering.","type":{"names":["ColumnsSettings"]}},"meta":{"fullname":"rendering.columns","name":"columns"},"children":{"bufferSize":{"doclet":{"description":"Buffer of columns to render outside the visible area from the left and\nfrom the right while scrolling. The bigger the buffer, the less flicker\nwill be seen while scrolling, but the more columns will have to be\nrendered.\n\nCannot be lower than 0.","defaultvalue":2,"type":{"names":["number"]}},"meta":{"fullname":"rendering.columns.bufferSize","name":"bufferSize","default":2},"children":{}},"resizing":{"doclet":{"description":"Options for the columns resizing.","type":{"names":["ResizingOptions"]}},"meta":{"fullname":"rendering.columns.resizing","name":"resizing"},"children":{"enabled":{"doclet":{"description":"Whether the columns resizing is enabled. If `true`, the user can\nresize the columns by dragging the column header edges.","samples":[{"name":"Column resizing disabled","value":"grid-lite/basic/column-resizing-disabled"}],"defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"rendering.columns.resizing.enabled","name":"enabled","default":true},"children":{}},"mode":{"doclet":{"description":"Determines how column widths are adjusted when resizing.\n- `'adjacent'`: Resizing a column will also adjust the width of its\n  immediate neighbor, keeping the rest of the columns in the same place.\n  This is the default mode.\n- `'independent'`: Only the resized column is changed; all columns to\n  its right retain their current pixel widths, effectively \"freezing\"\n  their widths.\n- `'distributed'`: Only the resized column is affected; other column\n  width settings will not be changed.","samples":[{"name":"Column resizing","value":"grid-lite/basic/column-resizing"},{"name":"Custom resizing mode","value":"grid-lite/basic/custom-column-resizing-mode"}],"defaultvalue":"adjacent","type":{"names":["ColumnResizingMode"]}},"meta":{"fullname":"rendering.columns.resizing.mode","name":"mode","default":"adjacent"},"children":{}}}},"strictWidths":{"doclet":{"description":"Whether all columns should use one fixed width, resolved from\n`columnDefaults.width` or a fallback width. When enabled, the grid skips\nper-column width and offset calculations, column resizing mode\ninitialization and column resize handles.\n\nEnabling this option can improve initialization performance for very wide\ngrids, especially together with column virtualization.","samples":[{"name":"Column virtualization","value":"grid-lite/options/columns-virtualization"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"rendering.columns.strictWidths","name":"strictWidths","default":"false"},"children":{}},"virtualization":{"doclet":{"description":"Columns virtualization option renders columns that are visible in the\nviewport only. In case of wide data sets, the enabled option improves\nperformance and saves memory.\n\nThe option is automatically set to `true` when the number of columns\nreaches the `virtualizationThreshold` option value. If defined, it takes\nprecedence over the `virtualizationThreshold` option.","samples":[{"name":"Column virtualization","value":"grid-lite/options/columns-virtualization"}],"defaultvalue":"undefined","type":{"names":["boolean"]}},"meta":{"fullname":"rendering.columns.virtualization","name":"virtualization","default":"undefined"},"children":{}},"virtualizationThreshold":{"doclet":{"description":"The columns virtualization threshold option sets the column count limit\nat which virtualization is activated. When the number of columns reaches\nthis threshold, virtualization is enabled to optimize performance.\n\nThe option has no effect when the `virtualization` option is defined.","defaultvalue":20,"type":{"names":["number"]}},"meta":{"fullname":"rendering.columns.virtualizationThreshold","name":"virtualizationThreshold","default":20},"children":{}}}},"rows":{"doclet":{"description":"Options to control the rows rendering.","type":{"names":["RowsSettings"]}},"meta":{"fullname":"rendering.rows","name":"rows"},"children":{"bufferSize":{"doclet":{"description":"Buffer of rows to render outside the visible area from the top and from\nthe bottom while scrolling. The bigger the buffer, the less flicker will\nbe seen while scrolling, but the more rows will have to be rendered.\n\nCannot be lower than 0.","defaultvalue":10,"type":{"names":["number"]}},"meta":{"fullname":"rendering.rows.bufferSize","name":"bufferSize","default":10},"children":{}},"minVisibleRows":{"doclet":{"description":"Defines the minimum height of the table body (`tbody`) based on the\nnumber of rows that should be visible in the viewport.\n\nIf set to `null`, the minimum height will not be enforced.\n\nIt's ignored when height of the container is set or the `min-height`\nstyle is set on the `tbody` by the user.","defaultvalue":2,"type":{"names":["number","null"]}},"meta":{"fullname":"rendering.rows.minVisibleRows","name":"minVisibleRows","default":2},"children":{}},"strictHeights":{"doclet":{"description":"Whether the height of the rows should be calculated automatically based\non the content of the cells. If `true`, the ellipsis will be used to\nindicate that the content is too long to fit in the cell.\n\nWhen there is no need to have different row heights, it is recommended\nto set this option to `true` for the performance reasons, to avoid the\nunnecessary calculations.","samples":[{"name":"Strict row heights","value":"grid-lite/basic/strict-row-heights"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"rendering.rows.strictHeights","name":"strictHeights","default":"false"},"children":{}},"virtualization":{"doclet":{"description":"Rows virtualization option render rows that are visible in the viewport\nonly. In case of large data set, the enabled option improve performance\nand saves memory.\n\nThe option is automatically set to `true` when the number of rows reaches\nthe `virtualizationThreshold` option value. If defined, it takes the\nprecedence over the `virtualizationThreshold` option.","samples":[{"name":"Row virtualization","value":"grid-lite/options/rows-virtualization"}],"defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"rendering.rows.virtualization","name":"virtualization","default":"false"},"children":{}},"virtualizationThreshold":{"doclet":{"description":"The rows virtualization threshold option sets the row count limit at\nwhich virtualization is activated. When the number of rows reaches this\nthreshold, virtualization is enabled to optimize performance.\n\nThe option has no effect when the `virtualization` option is defined.","defaultvalue":50,"type":{"names":["number"]}},"meta":{"fullname":"rendering.rows.virtualizationThreshold","name":"virtualizationThreshold","default":50},"children":{}},"className":{"doclet":{"description":"Additional CSS class names applied to every body row (`<tr>`).","type":{"names":["string"]}},"meta":{"fullname":"rendering.rows.className","name":"className"},"children":{}},"evenClassName":{"doclet":{"description":"Additional CSS class names applied to even body rows (`<tr>`), matching\nthe `.hcg-row-even` parity used by the grid.","type":{"names":["string"]}},"meta":{"fullname":"rendering.rows.evenClassName","name":"evenClassName"},"children":{}},"pinning":{"doclet":{"description":"Row pinning options for rendering dedicated sections above or below\nthe scrollable table body.","samples":[{"name":"Row pinning","value":"grid-pro/demo/row-pinning"}],"type":{"names":["RowPinningOptions"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning","name":"pinning"},"children":{"enabled":{"doclet":{"description":"Whether built-in row pinning UI is enabled.\n\nThis controls UI affordances such as context menu actions. Configured\npinned rows and the runtime row pinning API continue to work when it is\ndisabled.","defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.enabled","name":"enabled","default":"false"},"children":{}},"topIds":{"doclet":{"description":"Row IDs pinned to the top section on initial render.","type":{"names":["RowId[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.topIds","name":"topIds"},"children":{}},"bottomIds":{"doclet":{"description":"Row IDs pinned to the bottom section on initial render.","type":{"names":["RowId[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.bottomIds","name":"bottomIds"},"children":{}},"top":{"doclet":{"description":"Layout options for the top pinned rows section.","type":{"names":["RowPinningSectionOptions"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.top","name":"top"},"children":{"maxHeight":{"doclet":{"description":"Maximum height for this pinned tbody. Enables vertical scrolling in the\npinned section when content exceeds this height.","type":{"names":["number","string"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.top.maxHeight","name":"maxHeight"},"children":{}}}},"bottom":{"doclet":{"description":"Layout options for the bottom pinned rows section.","type":{"names":["RowPinningSectionOptions"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.bottom","name":"bottom"},"children":{"maxHeight":{"doclet":{"description":"Maximum height for this pinned tbody. Enables vertical scrolling in the\npinned section when content exceeds this height.","type":{"names":["number","string"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.bottom.maxHeight","name":"maxHeight"},"children":{}}}},"events":{"doclet":{"description":"Event callbacks fired when rows are pinned or unpinned.","type":{"names":["RowPinningEvents"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.events","name":"events"},"children":{"beforeRowPin":{"doclet":{"description":"Fires before a row pinning change is applied.\n\nCall `event.preventDefault()` to cancel the change.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>GridEvent<Grid> & RowPinningChangeEvent</code></li></ul>","type":{"names":["( this: Grid, e: GridEvent<Grid> & RowPinningChangeEvent ) => void"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.events.beforeRowPin","name":"beforeRowPin"},"children":{}},"afterRowPin":{"doclet":{"description":"Fires after a row pinning change has been applied.<p>The <code>this</code> context refers to the <a href=\"/grid/typedoc/classes/Grid_Core_Grid.Grid.html\">Grid</a> instance.</p><p>Callback parameters:</p><ul><li><code>e</code> — <code>GridEvent<Grid> & RowPinningChangeEvent</code></li></ul>","type":{"names":["( this: Grid, e: GridEvent<Grid> & RowPinningChangeEvent ) => void"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.events.afterRowPin","name":"afterRowPin"},"children":{}}}},"resolve":{"doclet":{"description":"Callback used to derive the initial pinned position for each row.\n\nReturn `'top'` or `'bottom'` to pin the row, or `null` / `undefined`\nto keep it in the regular scrollable body.","type":{"names":["(row: RowObjectType) => ('top'|'bottom'|null|undefined)"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.pinning.resolve","name":"resolve"},"children":{}}}},"expandedLevels":{"doclet":{"description":"Number of tree levels expanded initially, or `'all'` to expand every\nlevel. A row is initially expanded when its depth is lower than the\nconfigured number of levels, or when its ID is listed in\n`expandedRowIds`.\n\nApplies to `treeView` and `rowGrouping`.","defaultvalue":0,"type":{"names":["number | 'all'"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.expandedLevels","name":"expandedLevels","default":0},"children":{}},"expandedRowIds":{"doclet":{"description":"Explicit set of row IDs expanded initially, in addition to the rows\nexpanded by `expandedLevels`.\n\nApplies to `treeView` and `rowGrouping`.","defaultvalue":"[]","type":{"names":["(number | string)[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"rendering.rows.expandedRowIds","name":"expandedRowIds","default":"[]"},"children":{}},"stickyParents":{"doclet":{"description":"Enables sticky parent rows.\n\nApplies to `treeView` and `rowGrouping`.","samples":[{"name":"Sticky parents","value":"grid-pro/tree-view/sticky-parents"}],"defaultvalue":true,"type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"rendering.rows.stickyParents","name":"stickyParents","default":true},"children":{}}}},"header":{"doclet":{"description":"Options to control the header rendering.","type":{"names":["HeaderSettings"]}},"meta":{"fullname":"rendering.header","name":"header"},"children":{"enabled":{"doclet":{"description":"Whether the header should be rendered.","defaultvalue":true,"type":{"names":["boolean"]}},"meta":{"fullname":"rendering.header.enabled","name":"enabled","default":true},"children":{}}}},"table":{"doclet":{"description":"Options to control the table rendering.","type":{"names":["TableSettings"]}},"meta":{"fullname":"rendering.table","name":"table"},"children":{"className":{"doclet":{"description":"The custom CSS class name for the table.","type":{"names":["string"]}},"meta":{"fullname":"rendering.table.className","name":"className"},"children":{}}}},"theme":{"doclet":{"description":"Theme class name(s) on the grid container.\nA non-empty value also adds `.hcg-themed`, which applies table surface\nstyles. An empty string disables theming.","defaultvalue":"hcg-theme-default","type":{"names":["string"]}},"meta":{"fullname":"rendering.theme","name":"theme","default":"hcg-theme-default"},"children":{}}},"doclet":{"description":"Options to control the way grid is rendered.","type":{"names":["RenderingSettings"]}},"meta":{"fullname":"rendering","name":"rendering"}},"responsive":{"children":{"rules":{"doclet":{"description":"A set of rules for responsive settings. The rules are executed from\nthe top down.","samples":[{"name":"Responsive rules","value":"grid-lite/demo/responsive-rules"}],"type":{"names":["Array<RuleOptions>"]},"supportsArray":true},"meta":{"fullname":"responsive.rules","name":"rules"},"children":{"gridOptions":{"doclet":{"description":"A full set of grid options to apply as overrides to the general grid\noptions. The grid options are applied when the given rule is active.","type":{"names":["Exclude<Options, 'responsive'|'id'>"]}},"meta":{"fullname":"responsive.rules.gridOptions","name":"gridOptions"},"children":{}},"condition":{"doclet":{"description":"Under which conditions the rule applies.","type":{"names":["RuleConditionOptions"]}},"meta":{"fullname":"responsive.rules.condition","name":"condition"},"children":{"callback":{"doclet":{"description":"A callback function to gain complete control on when the responsive\nrule applies. Return `true` if it applies. This opens for checking\nagainst other metrics than the grid size, for example the document\nsize or other elements.","type":{"names":["(this: Grid, grid: Grid) => boolean"]}},"meta":{"fullname":"responsive.rules.condition.callback","name":"callback"},"children":{}},"maxWidth":{"doclet":{"description":"The responsive rule applies if the grid width is less or equal to this.","type":{"names":["number"]}},"meta":{"fullname":"responsive.rules.condition.maxWidth","name":"maxWidth"},"children":{}},"maxHeight":{"doclet":{"description":"The responsive rule applies if the grid height is less or equal to this.","type":{"names":["number"]}},"meta":{"fullname":"responsive.rules.condition.maxHeight","name":"maxHeight"},"children":{}},"minWidth":{"doclet":{"description":"The responsive rule applies if the grid width is greater or equal to\nthis.","type":{"names":["number"]}},"meta":{"fullname":"responsive.rules.condition.minWidth","name":"minWidth"},"children":{}},"minHeight":{"doclet":{"description":"The responsive rule applies if the grid height is greater or equal to\nthis.","type":{"names":["number"]}},"meta":{"fullname":"responsive.rules.condition.minHeight","name":"minHeight"},"children":{}}}}}}},"doclet":{"description":"Allows setting a set of rules to apply for different screen or grid\nsizes. Each rule specifies additional grid options.","samples":[{"name":"Responsive rules","value":"grid-lite/demo/responsive-rules"}],"type":{"names":["ResponsiveOptions"]}},"meta":{"fullname":"responsive","name":"responsive"}},"rowGrouping":{"children":{"enabled":{"doclet":{"description":"Enables row grouping. It has to be set explicitly, declaring the\nremaining row grouping options alone does not enable the feature.","samples":[{"name":"Row grouping","value":"grid-pro/options/row-grouping"}],"defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"rowGrouping.enabled","name":"enabled","default":"false"},"children":{}},"groupBy":{"doclet":{"description":"Source column ID or IDs used as row grouping levels, ordered from the\ntop level down.","samples":[{"name":"Row grouping","value":"grid-pro/options/row-grouping"}],"type":{"names":["string","string[]"]},"supportsArray":true,"product":"gridpro"},"meta":{"fullname":"rowGrouping.groupBy","name":"groupBy"},"children":{}},"groupColumnId":{"doclet":{"description":"ID of the generated column rendering group row labels. It must not\ncollide with a source column ID, because it would shadow that column's\ndata.\n\nThe generated column is the tree column of the grouped table unless\n`treeView.treeColumn` is set.","defaultvalue":"group","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"rowGrouping.groupColumnId","name":"groupColumnId","default":"group"},"children":{}},"hideGroupByColumns":{"doclet":{"description":"Whether the columns listed in `groupBy` are hidden from the rendered\ntable.\n\nWhen `false`, grouped columns stay visible and group rows repeat the\ngroup value of their own and their ancestor levels.","defaultvalue":true,"type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"rowGrouping.hideGroupByColumns","name":"hideGroupByColumns","default":true},"children":{}}},"doclet":{"description":"Row grouping options, turning repeated values of the selected\ncolumns into expandable group rows.","product":"gridpro","samples":[{"name":"Row grouping","value":"grid-pro/options/row-grouping"}],"type":{"names":["RowGroupingOptions"]}},"meta":{"fullname":"rowGrouping","name":"rowGrouping"}},"tableEditing":{"children":{"enabled":{"doclet":{"description":"Whether built-in structural table editing UI is enabled.\n\nWhen enabled, Grid Pro adds built-in context menu actions for adding and\ndeleting rows and columns.","defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"tableEditing.enabled","name":"enabled","default":"false"},"children":{}}},"doclet":{"description":"Options for built-in structural table editing.","product":"gridpro","samples":[{"name":"Table editing","value":"grid-pro/basic/table-editing"}],"type":{"names":["TableEditingOptions"]}},"meta":{"fullname":"tableEditing","name":"tableEditing"}},"time":{"children":{"timezone":{"doclet":{"description":"The timezone to use for formatting time and date. The time zone names\ncan be different between browsers, as described in [mdn docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#timezone).","defaultvalue":"UTC","type":{"names":["string"]}},"meta":{"fullname":"time.timezone","name":"timezone","default":"UTC"},"children":{}}},"doclet":{"description":"Time options for the grid.","type":{"names":["TimeOptions"]}},"meta":{"fullname":"time","name":"time"}},"treeView":{"children":{"enabled":{"doclet":{"description":"Enables tree view processing. It has to be set explicitly, declaring the\nremaining tree view options alone does not enable the feature.","defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"treeView.enabled","name":"enabled","default":"false"},"children":{}},"input":{"doclet":{"description":"Input format definition used to build the tree index.\n\nWhen omitted, TreeView auto-detects the standard `parentId` or `path`\ncolumns and prefers `path` when both exist. For custom input\ndefinitions, set `treeView.input.type` explicitly.","samples":[{"name":"Parent ID tree input","value":"grid-pro/tree-view/parent-id"},{"name":"Path tree input","value":"grid-pro/tree-view/input-path"}],"type":{"names":["TreeInputParentIdOptions | TreeInputPathOptions"]},"product":"gridpro"},"meta":{"fullname":"treeView.input","name":"input"},"children":{"parentId":{"doclet":{"description":"Parent-child relation input based on a parent ID column.","product":"gridpro"},"meta":{"fullname":"treeView.input.parentId","name":"parentId"},"children":{"type":{"doclet":{"description":"Type of the tree input.","type":{"names":["'parentId'"]},"product":"gridpro","defaultvalue":"'parentId'"},"meta":{"fullname":"treeView.input.parentId.type","name":"type","default":"'parentId'"},"children":{}},"parentIdColumn":{"doclet":{"description":"Column ID containing parent row IDs.\n\nStructural TreeView columns are reserved and rendered readonly.","defaultvalue":"parentId","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"treeView.input.parentId.parentIdColumn","name":"parentIdColumn","default":"parentId"},"children":{}}}},"path":{"doclet":{"description":"Parent-child relation input based on full node paths.","product":"gridpro"},"meta":{"fullname":"treeView.input.path","name":"path"},"children":{"type":{"doclet":{"description":"Type of the tree input.","type":{"names":["'path'"]},"product":"gridpro","defaultvalue":"'path'"},"meta":{"fullname":"treeView.input.path.type","name":"type","default":"'path'"},"children":{}},"pathColumn":{"doclet":{"description":"Column ID containing full node paths.\n\nPath values must be unique within the source table.","defaultvalue":"path","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"treeView.input.path.pathColumn","name":"pathColumn","default":"path"},"children":{}},"separator":{"doclet":{"description":"Path segment separator, a RegExp extracting ordered path segments,\nor a callback returning ordered path segments.","samples":[{"name":"Separator callback","value":"grid-pro/tree-view/separator-callback"}],"defaultvalue":"/","type":{"names":["string | RegExp | TreeInputPathSeparatorCallback"]},"product":"gridpro"},"meta":{"fullname":"treeView.input.path.separator","name":"separator","default":"/"},"children":{}},"showFullPath":{"doclet":{"description":"Defines how path values are rendered when the path column is used as\nthe tree column.\n\nIf `true`, renders complete paths. If `false`, renders only\nthe current path segment (leaf node name).","defaultvalue":"false","type":{"names":["boolean"]},"product":"gridpro"},"meta":{"fullname":"treeView.input.path.showFullPath","name":"showFullPath","default":"false"},"children":{}}}}}},"treeColumn":{"doclet":{"description":"Column ID used as the tree column when rendering expand/collapse UI.","type":{"names":["string"]},"product":"gridpro"},"meta":{"fullname":"treeView.treeColumn","name":"treeColumn"},"children":{}}},"doclet":{"description":"Tree view options, turning hierarchical data into expandable parent\nand child rows.","product":"gridpro","samples":[{"name":"Parent ID tree input","value":"grid-pro/tree-view/parent-id"},{"name":"Path tree input","value":"grid-pro/tree-view/input-path"}],"type":{"names":["TreeViewOptions"]}},"meta":{"fullname":"treeView","name":"treeView"}}}