LayoutOptions

Options for configuring Layouts; manage Column visibility, order, sorting, grouping, width etc.

export interface

Properties

Property Details

isRowSelectionCheckboxVisible

Function which checks if the Row Selection checkbox should be visible for a given row.

When provided, this overrides LayoutRowSelection.Checkboxes and any gridOptions.rowSelection.checkboxes value, and forces AG Grid hideDisabledCheckboxes: true so returning false hides (rather than greys out) the checkbox.

Does not apply when the Layout sets RowSelection: false (row selection is fully disabled for that Layout).

Use context.rowNode for group / footer / pinned / total rows (data may be undefined for those).

isRowSelectionCheckboxVisible?: (context: LayoutRowSelectionContext<TData>) => boolean;

Property Value

(context:LayoutRowSelectionContext<TData>) => boolean

layoutCreationDefaultProperties

Default properties to apply when creating a new Layout (Table or Pivot)

layoutCreationDefaultProperties?: LayoutCreationDefaultProperties | ((context: LayoutCreationDefaultPropertiesContext) => TableLayoutCreationDefaultProperties | PivotLayoutCreationDefaultProperties);

Property Value

LayoutCreationDefaultProperties| ((context:LayoutCreationDefaultPropertiesContext) =>TableLayoutCreationDefaultProperties|PivotLayoutCreationDefaultProperties)

layoutTagOptions

Set of options for leveraging Object Tags to extend Layouts

layoutTagOptions?: LayoutTagOptions;

Property Value

LayoutTagOptions

layoutViewOptions

Set of options for how Layouts are displayed in Settings Panel

layoutViewOptions?: LayoutViewOptions;

Property Value

LayoutViewOptions

pivotPreviewColumns

Columns to display in Table that opens when viewing Pivot Cell contents

pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);

Property Value

string[] | ((context:PivotPreviewColumnsContext) => string[])