Layout Options

Options for manging Layouts.

Layouts are groups of Column-related properties, i.e. visibility, order, grouping, pivoting, aggregation and width.

note

Filters and Query manage which Rows are displayed; Layouts decide which Columns are displayed.

Default Layouts

There must always be at least one Layout in AdapTable at any time.

This means that if there is no Layout in the Layout Predefined Config, AdapTable will create one called Default Layout based on the current grid setup.

Setting the createDefaultLayout property to true, ensures a Default Layout is created even if there are other Layouts in Predefined Config.

Auto-Sizing Layouts

Two useful options allow you to auto-size columns in regular and pivot Layotus the first time one is loaded.

This is useful when screen estate is at a premium.

note

This only works if you have not set your own widths in the Layout config.

caution

If you have the the GridOptions suppressColumnVirtualisation property set to true (in ag-Grid), then only the visible columns will be auto sized

Auto-Saving Layouts

The autoSaveLayouts property (which defaults to true) specifies whether Layouts will automatically save when their contents change.

If this property is false then a save button will appear in the Layout Toolbar and only upon clicking that will the Layout save.

tip

The Layout object itself also has an AutoSave property. If set, that will take precedence of the value set here in Layout Options (but it defaults to using this property).

Layout Options Properties

PropertyDescriptionDefault
autoSaveLayoutsLayouts save whenever Grid's column / sort info changes; if false, a Save button will displaytrue
autoSizeColumnsInLayoutColumns auto-size when Layout loads for first timefalse
autoSizeColumnsInPivotLayoutColumns auto-size when Pivot-based Layout loads first timefalse
createDefaultLayoutWhether a "Default Layout" will be created in addition to Layouts in Config (if none there, Default Layout is always created)false
includeExpandedRowGroupsLayouts will include details of expanded grouped rows; if true these will be re-applied at start-upfalse

More Information