Skip to main content
Version: Next

LayoutConfig

Index

Constructors

constructor

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: any[]; type: any }; floating: any[]; layoutVersion: number }
  • Parameters

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

    • docked: { content: any[]; type: any }
      • content: any[]
      • type: any
    • floating: any[]
    • layoutVersion: number

publicstaticGetPresetConfig

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

    • presetName: string

    Returns { docked: { content: ({ content: any[]; type: string; width: number } | { content: any; type: string; width?: undefined })[]; type: string }; floating: any[]; layoutVersion: number }

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

publicstaticIsUserLayoutValid

  • IsUserLayoutValid(layoutName: string, layoutConfig: any): boolean
  • Parameters

    • layoutName: string
    • layoutConfig: any

    Returns boolean

publicstaticUpgradeLayout

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

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

    Returns void