SettingsPanelOptions

Options for managing the AdapTable Settings Panel

TypeScript

export interface

Properties

Property	Type	Description	Default
alwaysShowInDashboard	`boolean`	Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard	false
alwaysShowInToolPanel	`boolean`	Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel	false
customSettingsPanels	`CustomSettingsPanel[]`	Custom Settings Panels provided by developers at design-time
gridInfoTabs	`GridInfoTabs`	Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'	['Grid Options', 'Grid Summary', 'Grid State']
icon	`'ConfigurationIcon' \| 'ApplicationIcon' \|AdaptableIcon`	Icon shown in top left of Settings Panel: Can be `ConfigurationIcon`, `ApplicationIcon` or custom Icon	`ConfigurationIcon`
navigation	`SettingsPanelNavigationConfigurer\|LegacyFlatSettingsPanelNavigation`	Configure grouped navigation for the Settings Panel; use SettingsPanelNavigationConfigurer but backwards compatibility via the deprecated LegacyFlatSettingsPanelNavigation is supported	all available AdapTable modules in the default grouped order
popupType	`PopupType`	How the Settings Panel is rendered: `'modal'` (centred and unmovable and resizable) or `'window'` (supports size, position, drag and resize)	'modal'
position	`SettingsPanelPosition`	Initial position of Settings Panel — pixel offset of top-left corner from top-left of viewport (requires `popupType` to be `'window'`)	Middle of Screen
showModuleIcons	`boolean`	Whether to show Icons for each Module in the Setting Panel	true
size	`SettingsPanelSize`	Initial size (in pixels) of Settings Panel (requires `popupType` to be `'window'`)	Computed based on size of screen
title	`string`	Title for Settings Panel	'Settings Panel'

Property Details

alwaysShowInDashboard

Whether a Settings Panel button should always be displayed in ModuleButtons area of Dashboard

TypeScript

alwaysShowInDashboard?: boolean;

Default Value

false

Property Value

boolean

alwaysShowInToolPanel

Whether a Settings Panel button should always be displayed in ModuleButtons area of ToolPanel

TypeScript

alwaysShowInToolPanel?: boolean;

Default Value

false

Property Value

boolean

customSettingsPanels

Custom Settings Panels provided by developers at design-time

TypeScript

customSettingsPanels?: CustomSettingsPanel[];

Property Value

CustomSettingsPanel[]

gridInfoTabs

Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'

TypeScript

gridInfoTabs?: GridInfoTabs;

Default Value

['Grid Options', 'Grid Summary', 'Grid State']

Property Value

GridInfoTabs

icon

Icon shown in top left of Settings Panel: Can be ConfigurationIcon, ApplicationIcon or custom Icon

TypeScript

icon?: 'ConfigurationIcon' | 'ApplicationIcon' | AdaptableIcon;

Default Value

ConfigurationIcon

Property Value

'ConfigurationIcon' | 'ApplicationIcon' |AdaptableIcon

Configure grouped navigation for the Settings Panel; use SettingsPanelNavigationConfigurer but backwards compatibility via the deprecated LegacyFlatSettingsPanelNavigation is supported

TypeScript

navigation?: SettingsPanelNavigationConfigurer | LegacyFlatSettingsPanelNavigation;

Default Value

all available AdapTable modules in the default grouped order

Property Value

SettingsPanelNavigationConfigurer|LegacyFlatSettingsPanelNavigation

popupType

How the Settings Panel is rendered: 'modal' (centred and unmovable and resizable) or 'window' (supports size, position, drag and resize)

TypeScript

popupType?: PopupType;

Default Value

'modal'

Property Value

PopupType

position

Initial position of Settings Panel — pixel offset of top-left corner from top-left of viewport (requires popupType to be 'window')

TypeScript

position?: SettingsPanelPosition;

Default Value

Middle of Screen

Property Value

SettingsPanelPosition

showModuleIcons

Whether to show Icons for each Module in the Setting Panel

TypeScript

showModuleIcons?: boolean;

Default Value

true

Property Value

boolean

size

Initial size (in pixels) of Settings Panel (requires popupType to be 'window')

TypeScript

size?: SettingsPanelSize;

Default Value

Computed based on size of screen

Property Value

SettingsPanelSize

title

Title for Settings Panel

TypeScript

title?: string;

Default Value

'Settings Panel'

Property Value

string

PreviousSettingsPanelNavigationGroup NextSettingsPanelPosition