LayoutConfig

Index

Constructors

• constructor

Properties

• currentSchemaVersion
• layoutValidator

Methods

• createConfigToApply
• createConfigToSave
• createFlexLayoutModelJson
• getPresetConfig
• isUserLayoutValid
• upgradeLayout

Constructors

constructor

• LayoutConfig(): LayoutConfig

• Returns LayoutConfig

Properties

publicstaticcurrentSchemaVersion

currentSchemaVersion: number = 2

publicstaticlayoutValidator

layoutValidator: any = ...

Methods

publicstaticcreateConfigToApply

• createConfigToApply(newParentContent: any, parentContent: any, componentConfigs: any[]): void

• Legacy compatibility: Collects component configs from abstract layout tree. Used when applying a layout to initialize widget stores before creating the FlexLayout model.

  ---

  Parameters

  • newParentContent: any

  • parentContent: any

  • componentConfigs: any[]

  Returns void

publicstaticcreateConfigToSave

• createConfigToSave(appStore: AppStore, modelJson: any): { docked: { content: any[]; type: string }; floating: any[]; layoutVersion: number } | null

• Creates the abstract config from the current FlexLayout model for saving.

  ---

  Parameters

  • appStore: AppStore

  • modelJson: any

  Returns { docked: { content: any[]; type: string }; floating: any[]; layoutVersion: number } | null

publicstaticcreateFlexLayoutModelJson

• createFlexLayoutModelJson(dockedConfig: any, componentConfigs: any[]): IJsonModel

• Converts the app's abstract layout config into a FlexLayout IJsonModel. Also collects component configs for initializing widget stores.

  ---

  Parameters

  • dockedConfig: any

  • componentConfigs: any[]

  Returns IJsonModel

publicstaticgetPresetConfig

• getPresetConfig(presetName: string): { docked: { content: { content: any; type: string; width: number }[]; type: string }; floating: never[]; layoutVersion: number } | null

• Parameters

  • presetName: string

  Returns { docked: { content: { content: any; type: string; width: number }[]; type: string }; floating: never[]; layoutVersion: number } | null

publicstaticisUserLayoutValid

• isUserLayoutValid(layoutName: string, layoutConfig: any): boolean

• Parameters

  • layoutName: string

  • layoutConfig: any

  Returns boolean

publicstaticupgradeLayout

• upgradeLayout(layout: { docked: any; floating: any; layoutVersion: 1 | 2 }): void

• Parameters

  • layout: { docked: any; floating: any; layoutVersion: 1 | 2 }

  • docked: any

  • floating: any

  • layoutVersion: 1 | 2

  Returns void