LayoutOptions

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

TypeScript
export interface

Properties

PropertyTypeDescription
layoutCreationDefaultPropertiesLayoutCreationDefaultProperties| ((context:LayoutCreationDefaultPropertiesContext) =>TableLayoutCreationDefaultProperties|PivotLayoutCreationDefaultProperties)Default properties to apply when creating a new Layout (Table or Pivot)
layoutTagOptionsLayoutTagOptionsSet of options for leveraging Object Tags to extend Layouts
layoutViewOptionsLayoutViewOptionsSet of options for how Layouts are displayed in Settings Panel
pivotPreviewColumnsstring[] | ((context:PivotPreviewColumnsContext) => string[])Columns to display in Table that opens when viewing Pivot Cell contents

Property Details

layoutCreationDefaultProperties

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

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

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

layoutTagOptions

Set of options for leveraging Object Tags to extend Layouts

TypeScript
layoutTagOptions?: LayoutTagOptions;
Property Value

LayoutTagOptions

layoutViewOptions

Set of options for how Layouts are displayed in Settings Panel

TypeScript
layoutViewOptions?: LayoutViewOptions;
Property Value

LayoutViewOptions

pivotPreviewColumns

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

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

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