AdapTable Types Reference

SettingsPanelApi

Provides run-time access to the Settings Panel

TypeScript
export interface

Methods

MethodDescription
closeSettingsPanel()Closes Settings Panel
openCustomSettingsPanel(name)Opens Settings Panel with the Custom Settings Panel, provided by name, displayed
openSettingsPanel(moduleName)Opens Settings Panel and displays specified Module (if provided) or first available one

Method Details

closeSettingsPanel

Closes Settings Panel

TypeScript
closeSettingsPanel(): void;
Returns

void

openCustomSettingsPanel

Opens Settings Panel with the Custom Settings Panel, provided by name, displayed

TypeScript
openCustomSettingsPanel(name: string): void;
Parameters
ParameterTypeDescription
namestringname of Custom Settings Panel to display
Returns

void

openSettingsPanel

Opens Settings Panel and displays specified Module (if provided) or first available one

TypeScript
openSettingsPanel(moduleName?: AdaptableModule): void;
Parameters
ParameterTypeDescription
moduleNameAdaptableModulename of Module to display
Returns

void

PreviousSetPrimaryKeyValueContextNextSettingsPanelOptions