SettingsPanelOptions

Options for managing the AdapTable Settings Panel

export interface

Properties

Property Details

alwaysShowInDashboard

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

alwaysShowInDashboard?: boolean;

Default Value

false

Property Value

boolean

alwaysShowInToolPanel

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

alwaysShowInToolPanel?: boolean;

Default Value

false

Property Value

boolean

customSettingsPanels

Custom Settings Panels provided by developers at design-time

customSettingsPanels?: CustomSettingsPanel[];

Property Value

CustomSettingsPanel[]

icon

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

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

Default Value

ConfigurationIcon

Property Value

'ConfigurationIcon' | 'ApplicationIcon' |AdaptableIcon

navigation

Ordered items to display at side of Settings Panel

navigation?: {
        items?: (AdaptableSettingsPanel | string | '-')[];
    };

Default Value

all available AdapTable modules

Property Value

\{ items?: (AdaptableSettingsPanel | string | '-')[]; \}

popupType

Whether Settings Panel is 'window' (i.e. movable, resizable, no backdrop) or 'modal' (centre of screen with backdrop)

popupType?: PopupType;

Default Value

'window'

Property Value

PopupType

position

Initial position of Settings Panel window

position?: {
        x: number;
        y: number;
    };

Default Value

Middle of Screen

Property Value

\{ x: number; y: number; \}

showModuleIcons

Whether to show Icons for each Module in the Setting Panel

showModuleIcons?: boolean;

Default Value

true

Property Value

boolean

size

Initial size of Settings Panel

size?: {
        width: number;
        height: number;
    };

Default Value

Computed based on size of screen

Property Value

\{ width: number; height: number; \}

title

Title for the Settings Panel

title?: string;

Default Value

'Settings Panel'

Property Value

string