@vaadin/grid

{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "vaadin-grid.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-tree-toggle.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-tree-toggle.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-tree-column.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-tree-column.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-sorter.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-sorter.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-sort-column.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-sort-column.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-selection-column.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-selection-column.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-filter.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-filter.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-filter-column.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-filter-column.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-column.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-column.js" } } ] }, { "kind": "javascript-module", "path": "vaadin-grid-column-group.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-column-group.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-a11y-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "A11yMixin", "members": [ { "kind": "field", "name": "accessibleName", "privacy": "public", "type": { "text": "string" }, "description": "String used to label the grid to screen reader users.", "attribute": "accessible-name" } ], "attributes": [ { "name": "accessible-name", "type": { "text": "string" }, "description": "String used to label the grid to screen reader users.", "fieldName": "accessibleName" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "A11yMixin", "declaration": { "name": "A11yMixin", "module": "src/vaadin-grid-a11y-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-active-item-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ActiveItemMixin", "members": [ { "kind": "field", "name": "activeItem", "privacy": "public", "type": { "text": "GridItem" }, "description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.", "attribute": "active-item" } ], "events": [ { "name": "cell-activate", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "active-item", "type": { "text": "GridItem" }, "description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.", "fieldName": "activeItem" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ActiveItemMixin", "declaration": { "name": "ActiveItemMixin", "module": "src/vaadin-grid-active-item-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-array-data-provider-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ArrayDataProviderMixin", "members": [ { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "Array<!GridItem> | undefined" }, "description": "An array containing the items which will be passed to renderer functions.", "attribute": "items" } ], "attributes": [], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ArrayDataProviderMixin", "declaration": { "name": "ArrayDataProviderMixin", "module": "src/vaadin-grid-array-data-provider-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-column-auto-width-mixin.js", "declarations": [ { "kind": "mixin", "description": "A mixin providing grid column auto-width functionality.", "name": "ColumnAutoWidthMixin", "members": [ { "kind": "method", "name": "recalculateColumnWidths", "description": "Updates the `width` of all columns which have `autoWidth` set to `true`." } ], "attributes": [], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "ColumnAutoWidthMixin", "declaration": { "name": "ColumnAutoWidthMixin", "module": "src/vaadin-grid-column-auto-width-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-column-group-mixin.js", "declarations": [ { "kind": "mixin", "description": "A mixin providing common vaadin-grid-column-group functionality.", "name": "GridColumnGroupMixin", "members": [ { "kind": "field", "name": "flexGrow", "privacy": "public", "type": { "text": "number" }, "description": "Flex grow ratio for the column group as the sum of the ratios of its child columns.", "attribute": "flex-grow", "readonly": true }, { "kind": "field", "name": "footerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "attribute": "footer-part-name", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "footerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "footer-renderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "frozen", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.", "attribute": "frozen", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "frozenToEnd", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.", "attribute": "frozen-to-end", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "header", "privacy": "public", "type": { "text": "string" }, "description": "Text content to display in the header cell of the column.", "attribute": "header", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "headerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the header cell.", "attribute": "header-part-name", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "headerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "header-renderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "hidden", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the cells for this column are hidden.", "attribute": "hidden", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "resizable", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the column is user-resizable.", "default": "false", "attribute": "resizable", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "rowHeader", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.", "attribute": "row-header", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "textAlign", "privacy": "public", "type": { "text": "string" }, "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "attribute": "text-align", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "width", "privacy": "public", "type": { "text": "string" }, "description": "Width of the column group as the sum of the widths of its child columns.", "attribute": "width", "readonly": true } ], "attributes": [ { "name": "flex-grow", "type": { "text": "number" }, "description": "Flex grow ratio for the column group as the sum of the ratios of its child columns.", "fieldName": "flexGrow" }, { "name": "footer-part-name", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "fieldName": "footerPartName", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "footer-renderer", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "fieldName": "footerRenderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "frozen", "type": { "text": "boolean" }, "description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.", "fieldName": "frozen", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "frozen-to-end", "type": { "text": "boolean" }, "description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.", "fieldName": "frozenToEnd", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "header", "type": { "text": "string" }, "description": "Text content to display in the header cell of the column.", "fieldName": "header", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "header-part-name", "type": { "text": "string" }, "description": "Custom part name for the header cell.", "fieldName": "headerPartName", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "header-renderer", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "fieldName": "headerRenderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "hidden", "type": { "text": "boolean" }, "description": "When set to true, the cells for this column are hidden.", "fieldName": "hidden", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "resizable", "type": { "text": "boolean" }, "description": "When set to true, the column is user-resizable.", "default": "false", "fieldName": "resizable", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "row-header", "type": { "text": "boolean" }, "description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.", "fieldName": "rowHeader", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "text-align", "type": { "text": "string" }, "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "fieldName": "textAlign", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "width", "type": { "text": "string" }, "description": "Width of the column group as the sum of the widths of its child columns.", "fieldName": "width" } ], "mixins": [ { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "GridColumnGroupMixin", "declaration": { "name": "GridColumnGroupMixin", "module": "src/vaadin-grid-column-group-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-column-group.js", "declarations": [ { "kind": "class", "description": "A `<vaadin-grid-column-group>` is used to make groups of columns in `<vaadin-grid>` and\nto configure additional headers and footers.\n\nGroups can be nested to create complex header and footer configurations.\n\n#### Example:\n```html\n<vaadin-grid-column-group resizable id=\"columnGroup\">\n <vaadin-grid-column id=\"column1\"></vaadin-grid-column>\n <vaadin-grid-column id=\"column2\"></vaadin-grid-column>\n</vaadin-grid-column-group>\n```\n\n```js\nconst columnGroup = document.querySelector('#columnGroup');\ncolumnGroup.headerRenderer = (root, columnGroup) => {\n root.textContent = 'header';\n}\n\nconst column1 = document.querySelector('#column1');\ncolumn1.headerRenderer = (root, column) => { ... };\ncolumn1.renderer = (root, column, model) => { ... };\n\nconst column2 = document.querySelector('#column2');\ncolumn2.headerRenderer = (root, column) => { ... };\ncolumn2.renderer = (root, column, model) => { ... };\n```", "name": "GridColumnGroup", "members": [ { "kind": "field", "name": "flexGrow", "privacy": "public", "type": { "text": "number" }, "description": "Flex grow ratio for the column group as the sum of the ratios of its child columns.", "attribute": "flex-grow", "readonly": true, "inheritedFrom": { "name": "GridColumnGroupMixin", "module": "src/vaadin-grid-column-group-mixin.js" } }, { "kind": "field", "name": "footerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "attribute": "footer-part-name", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "footerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "footer-renderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "frozen", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.", "attribute": "frozen", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "frozenToEnd", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.", "attribute": "frozen-to-end", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "header", "privacy": "public", "type": { "text": "string" }, "description": "Text content to display in the header cell of the column.", "attribute": "header", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "headerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the header cell.", "attribute": "header-part-name", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "headerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "header-renderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "hidden", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the cells for this column are hidden.", "attribute": "hidden", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "resizable", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the column is user-resizable.", "default": "false", "attribute": "resizable", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "rowHeader", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.", "attribute": "row-header", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "textAlign", "privacy": "public", "type": { "text": "string" }, "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "attribute": "text-align", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "width", "privacy": "public", "type": { "text": "string" }, "description": "Width of the column group as the sum of the widths of its child columns.", "attribute": "width", "readonly": true, "inheritedFrom": { "name": "GridColumnGroupMixin", "module": "src/vaadin-grid-column-group-mixin.js" } } ], "mixins": [ { "name": "GridColumnGroupMixin", "module": "src/vaadin-grid-column-group-mixin.js" }, { "name": "PolylitMixin", "package": "@vaadin/component-base/src/polylit-mixin.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "vaadin-grid-column-group", "customElement": true, "attributes": [ { "name": "flex-grow", "type": { "text": "number" }, "description": "Flex grow ratio for the column group as the sum of the ratios of its child columns.", "fieldName": "flexGrow", "inheritedFrom": { "name": "GridColumnGroupMixin", "module": "src/vaadin-grid-column-group-mixin.js" } }, { "name": "footer-part-name", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "fieldName": "footerPartName", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "footer-renderer", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "fieldName": "footerRenderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "frozen", "type": { "text": "boolean" }, "description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.", "fieldName": "frozen", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "frozen-to-end", "type": { "text": "boolean" }, "description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.", "fieldName": "frozenToEnd", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "header", "type": { "text": "string" }, "description": "Text content to display in the header cell of the column.", "fieldName": "header", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "header-part-name", "type": { "text": "string" }, "description": "Custom part name for the header cell.", "fieldName": "headerPartName", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "header-renderer", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "fieldName": "headerRenderer", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "hidden", "type": { "text": "boolean" }, "description": "When set to true, the cells for this column are hidden.", "fieldName": "hidden", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "resizable", "type": { "text": "boolean" }, "description": "When set to true, the column is user-resizable.", "default": "false", "fieldName": "resizable", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "row-header", "type": { "text": "boolean" }, "description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.", "fieldName": "rowHeader", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "text-align", "type": { "text": "string" }, "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "fieldName": "textAlign", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "name": "width", "type": { "text": "string" }, "description": "Width of the column group as the sum of the widths of its child columns.", "fieldName": "width", "inheritedFrom": { "name": "GridColumnGroupMixin", "module": "src/vaadin-grid-column-group-mixin.js" } } ], "events": [] } ], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-grid-column-group-mixin.js" } }, { "kind": "js", "name": "GridColumnGroup", "declaration": { "name": "GridColumnGroup", "module": "src/vaadin-grid-column-group.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-grid-column-mixin.js", "declarations": [ { "kind": "mixin", "description": "", "name": "ColumnBaseMixin", "members": [ { "kind": "field", "name": "footerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "attribute": "footer-part-name" }, { "kind": "field", "name": "footerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "footer-renderer" }, { "kind": "field", "name": "frozen", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.", "attribute": "frozen" }, { "kind": "field", "name": "frozenToEnd", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.", "attribute": "frozen-to-end" }, { "kind": "field", "name": "header", "privacy": "public", "type": { "text": "string" }, "description": "Text content to display in the header cell of the column.", "attribute": "header" }, { "kind": "field", "name": "headerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the header cell.", "attribute": "header-part-name" }, { "kind": "field", "name": "headerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "header-renderer" }, { "kind": "field", "name": "hidden", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the cells for this column are hidden.", "attribute": "hidden" }, { "kind": "field", "name": "resizable", "privacy": "public", "type": { "text": "boolean" }, "description": "When set to true, the column is user-resizable.", "default": "false", "attribute": "resizable" }, { "kind": "field", "name": "rowHeader", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.", "attribute": "row-header" }, { "kind": "field", "name": "textAlign", "privacy": "public", "type": { "text": "string" }, "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "attribute": "text-align" } ], "attributes": [ { "name": "footer-part-name", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "fieldName": "footerPartName" }, { "name": "footer-renderer", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "fieldName": "footerRenderer" }, { "name": "frozen", "type": { "text": "boolean" }, "description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.", "fieldName": "frozen" }, { "name": "frozen-to-end", "type": { "text": "boolean" }, "description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.", "fieldName": "frozenToEnd" }, { "name": "header", "type": { "text": "string" }, "description": "Text content to display in the header cell of the column.", "fieldName": "header" }, { "name": "header-part-name", "type": { "text": "string" }, "description": "Custom part name for the header cell.", "fieldName": "headerPartName" }, { "name": "header-renderer", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "fieldName": "headerRenderer" }, { "name": "hidden", "type": { "text": "boolean" }, "description": "When set to true, the cells for this column are hidden.", "fieldName": "hidden" }, { "name": "resizable", "type": { "text": "boolean" }, "description": "When set to true, the column is user-resizable.", "default": "false", "fieldName": "resizable" }, { "name": "row-header", "type": { "text": "boolean" }, "description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.", "fieldName": "rowHeader" }, { "name": "text-align", "type": { "text": "string" }, "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "fieldName": "textAlign" } ], "parameters": [ { "name": "superClass" } ] }, { "kind": "mixin", "description": "", "name": "GridColumnMixin", "members": [ { "kind": "field", "name": "autoWidth", "privacy": "public", "type": { "text": "boolean" }, "description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.", "attribute": "auto-width" }, { "kind": "field", "name": "flexGrow", "privacy": "public", "type": { "text": "number" }, "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "attribute": "flex-grow" }, { "kind": "field", "name": "footerPartName", "privacy": "public", "type": { "text": "string" }, "description": "Custom part name for the footer cell.", "attribute": "footer-part-name", "inheritedFrom": { "name": "ColumnBaseMixin", "module": "src/vaadin-grid-column-mixin.js" } }, { "kind": "field", "name": "footerRenderer", "privacy": "public", "type": { "text": "GridHeaderFooterRenderer | null | undefined" }, "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.", "attribute": "footer-renderer", "inheritedFrom": { "name