Interface IConfig

Package: ui-framework

Properties

applicationInsightsKey

Key for appInsight logging.

Declaration

applicationInsightsKey?: string

Property Value

Type	Description
string	Key for appInsight logging.

authRequiredToSaveProject

Declaration

authRequiredToSaveProject?: boolean

Property Value

Type	Description
boolean

autoShowPopup

If true, automatically shows editor popup at startup.

Declaration

autoShowPopup?: boolean

Property Value

Type	Description
boolean	If true, automatically shows editor popup at startup.

clearDesignOnStep

Declaration

clearDesignOnStep: 0

Property Value

Type	Description
0

css

Declaration

css: string

Property Value

Type	Description
string

cssMobile

Declaration

cssMobile: string

Property Value

Type	Description
string

defaultStep

The name of default step.

Declaration

defaultStep: string

Property Value

Type	Description
string	The name of default step.

displayInPopup

If true, shows editor in pop-up window.

Declaration

displayInPopup: boolean

Property Value

Type	Description
boolean	If true, shows editor in pop-up window.

driver

Monkey patching driver values.

Declaration

driver?: [key: string]: unknown

Property Value

Type	Description
[key: string]: unknown	Monkey patching driver values.

globalCss

Declaration

globalCss?: string

Property Value

Type	Description
string

globalCssMobile

Declaration

globalCssMobile?: string

Property Value

Type	Description
string

hiddenWidgets

Declaration

hiddenWidgets: Array<IWidget>

Property Value

Type	Description
Array<IWidget>

icons

Declaration

icons: [key: string]: string

Property Value

Type	Description
[key: string]: string

language

Declaration

language: string

Property Value

Type	Description
string

layout

Sets the editor layout. Available values: verticalmobile.

Declaration

layout?: string

Property Value

Type	Description
string	Sets the editor layout. Available values: verticalmobile.

leaveWarning

Declaration

leaveWarning: boolean

Property Value

Type	Description
boolean

localization

Declaration

localization: ILocalizationSettings[]

Property Value

Type	Description
ILocalizationSettings[]

logo

TopToolBar clickable logo: src of image, url of link.

Declaration

logo?: ILogo

Property Value

Type	Description
ILogo	TopToolBar clickable logo: src of image, url of link.

modals

Declaration

modals: IModalWindowDefinition[]

Property Value

Type	Description
IModalWindowDefinition[]

onInit

Declaration

onInit?: Function | Function[]

Property Value

Type	Description
Function | Function[]

onInitScript

Declaration

onInitScript?: string

Property Value

Type	Description
string

onMobileBackAction

Execute this functions when customer tap 'Back' button on mobile phone.

Declaration

onMobileBackAction?: Function[]

Property Value

Type	Description
Function[]	Execute this functions when customer tap 'Back' button on mobile phone.

openSavedProjectsIcon

Declaration

openSavedProjectsIcon?: IIcon

Property Value

Type	Description
IIcon

restoration

Declaration

restoration: IRestorationConfig

Property Value

Type	Description
IRestorationConfig

saveProjectData

Declaration

saveProjectData?: Object

Property Value

Type	Description
Object

saveProjectFilterFunction

Declaration

saveProjectFilterFunction?: Function | Function[]

Property Value

Type	Description
Function | Function[]

saveProjectIcon

Declaration

saveProjectIcon?: IIcon

Property Value

Type	Description
IIcon

showButtonNavigation

If false, hides buttons on the top navigation panel.

Declaration

showButtonNavigation?: boolean

Property Value

Type	Description
boolean	If false, hides buttons on the top navigation panel.

showCustomTopPanel

Declaration

showCustomTopPanel?: boolean

Property Value

Type	Description
boolean

showOpenSavedProjectsButton

Declaration

showOpenSavedProjectsButton?: boolean

Property Value

Type	Description
boolean

showSaveProjectButton

Declaration

showSaveProjectButton?: boolean

Property Value

Type	Description
boolean

showStepNavigation

If false, hides steps on the top navigation panel.

Declaration

showStepNavigation?: boolean

Property Value

Type	Description
boolean	If false, hides steps on the top navigation panel.

showSteps

OBSOLETE If true, shows steps panel.

Declaration

showSteps: boolean | string

Property Value

Type	Description
boolean | string	OBSOLETE If true, shows steps panel.

steps

Declaration

steps: Array<IStep>

Property Value

Type	Description
Array<IStep>

style

Custom styles (css vars).

Declaration

style: [key: string]: string

Property Value

Type	Description
[key: string]: string	Custom styles (css vars).

styleMobile

Declaration

styleMobile: [key: string]: string

Property Value

Type	Description
[key: string]: string

toolPanelPosition

Declaration

toolPanelPosition: "left" | "right"

Property Value

Type	Description
"left" | "right"

useCustomStepLayout

If true, uses custom step layout.

Declaration

useCustomStepLayout?: boolean

Property Value

Type	Description
boolean	If true, uses custom step layout.

widgets

Declaration

widgets: Array<IWidget>

Property Value

Type	Description
Array<IWidget>