LayoutConfig

Index

Constructors

• constructor

Properties

• currentSchemaVersion
• layoutValidator

Methods

• createConfigToApply
• createConfigToSave
• 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

• Parameters

  • newParentContent: any

  • parentContent: any

  • componentConfigs: any[]

  Returns void

publicstaticcreateConfigToSave

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

• Parameters

  • appStore: AppStore

  • rootConfig: any

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

publicstaticgetPresetConfig

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

• Parameters

  • presetName: string

  Returns { docked: { content: ({ content: any[]; type: string; width: number } | { content: any; type: string; width?: undefined })[]; 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