Type alias ConfigType

ConfigType: { chiliEnvironmentUrl?: string; documentType?: DocumentType; editorId?: string; editorLink?: string; onActionsChanged?: ((state: DocumentAction[]) => void); onAsyncError?: ((asyncError: AsyncError) => void); onAuthExpired?: ((authRefreshRequest: AuthRefreshRequest) => Promise<AuthCredentials | null>); onBarcodeValidationChanged?: ((validationResults: BarcodeFrameValidationResult[]) => void); onCharacterStylesChanged?: ((characterStyles: CharacterStyle[]) => void); onColorsChanged?: ((colors: DocumentColor[]) => void); onConnectorEvent?: ((event: ConnectorEvent) => void); onConnectorsChanged?: ((connectors: ConnectorInstance[]) => void); onCropActiveFrameIdChanged?: ((id?: Id) => void); onDocumentLoaded?: (() => void); onFontFamiliesChanged?: ((fontFamilies: DocumentFontFamily[]) => void); onFrameAnimationsChanged?: ((animationState: FrameAnimationType[]) => void); onLayoutsChanged?: ((layouts: LayoutListItemType[]) => void); onPageSelectionChanged?: (() => void); onPageSizeChanged?: ((pageSize: PageSize) => void); onParagraphStylesChanged?: ((paragraphStyles: ParagraphStyle[]) => void); onScrubberPositionChanged?: ((state: AnimationPlaybackType) => void); onSelectedFrameContentChanged?: ((state: Frame | null) => void); onSelectedFrameLayoutChanged?: ((state: FrameLayoutType) => void); onSelectedFramesContentChanged?: ((state: Frame[]) => void); onSelectedFramesLayoutChanged?: ((states: FrameLayoutType[]) => void); onSelectedLayoutFramesChanged?: ((frames: SelectedLayoutFrame[]) => void); onSelectedLayoutIdChanged?: ((layoutId: string) => void); onSelectedLayoutPropertiesChanged?: ((state: LayoutPropertiesType) => void); onSelectedLayoutUnitChanged?: ((unit: MeasurementUnit) => void); onSelectedTextStyleChanged?: ((styles: SelectedTextStyle) => void); onSelectedToolChanged?: ((tool: ToolType) => void); onShapeCornerRadiusChanged?: ((cornerRadius: CornerRadiusUpdateModel) => void); onStateChanged?: (() => void); onUndoStackStateChanged?: ((undoStackState: UndoState) => void); onVariableListChanged?: ((variableList: Variable[]) => void); onViewModeChanged?: ((tool: ViewMode) => void); onViewportRequested?: (() => Viewport | null); onZoomChanged?: ((scaleFactor: number) => void); studioOptions?: StudioOptionsDeltaUpdate; studioStyling?: StudioStyling }

Type declaration

Optional chiliEnvironmentUrl?: string
Optional documentType?: DocumentType
Optional editorId?: string
Optional editorLink?: string
Optional onActionsChanged?: ((state: DocumentAction[]) => void)
- - (state: DocumentAction[]): void
  - Parameters
    - state: DocumentAction[]
    Returns void
Optional onAsyncError?: ((asyncError: AsyncError) => void)
- - (asyncError: AsyncError): void
  - Parameters
    - asyncError: AsyncError
    Returns void
Optional onAuthExpired?: ((authRefreshRequest: AuthRefreshRequest) => Promise<AuthCredentials | null>)
- - (authRefreshRequest: AuthRefreshRequest): Promise<AuthCredentials | null>
  - Parameters
    - authRefreshRequest: AuthRefreshRequest
    Returns Promise<AuthCredentials | null>
Optional onBarcodeValidationChanged?: ((validationResults: BarcodeFrameValidationResult[]) => void)
- - (validationResults: BarcodeFrameValidationResult[]): void
  - Parameters
    - validationResults: BarcodeFrameValidationResult[]
    Returns void
Optional onCharacterStylesChanged?: ((characterStyles: CharacterStyle[]) => void)
- - (characterStyles: CharacterStyle[]): void
  - Parameters
    - characterStyles: CharacterStyle[]
    Returns void
Optional onColorsChanged?: ((colors: DocumentColor[]) => void)
- - (colors: DocumentColor[]): void
  - Parameters
    - colors: DocumentColor[]
    Returns void
Optional onConnectorEvent?: ((event: ConnectorEvent) => void)
- - (event: ConnectorEvent): void
  - Parameters
    - event: ConnectorEvent
    Returns void
Optional onConnectorsChanged?: ((connectors: ConnectorInstance[]) => void)
- - (connectors: ConnectorInstance[]): void
  - Parameters
    - connectors: ConnectorInstance[]
    Returns void
Optional onCropActiveFrameIdChanged?: ((id?: Id) => void)
- - (id?: Id): void
  - Parameters
    - Optional id: Id
    Returns void
Optional onDocumentLoaded?: (() => void)
- - (): void
  - Returns void
Optional onFontFamiliesChanged?: ((fontFamilies: DocumentFontFamily[]) => void)
- - (fontFamilies: DocumentFontFamily[]): void
  - Parameters
    - fontFamilies: DocumentFontFamily[]
    Returns void
Optional onFrameAnimationsChanged?: ((animationState: FrameAnimationType[]) => void)
- - (animationState: FrameAnimationType[]): void
  - Parameters
    - animationState: FrameAnimationType[]
    Returns void
Optional onLayoutsChanged?: ((layouts: LayoutListItemType[]) => void)
- - (layouts: LayoutListItemType[]): void
  - Parameters
    - layouts: LayoutListItemType[]
    Returns void
Optional onPageSelectionChanged?: (() => void)
- - (): void
  - Returns void
Optional onPageSizeChanged?: ((pageSize: PageSize) => void)
- - (pageSize: PageSize): void
  - Parameters
    - pageSize: PageSize
    Returns void
Optional onParagraphStylesChanged?: ((paragraphStyles: ParagraphStyle[]) => void)
- - (paragraphStyles: ParagraphStyle[]): void
  - Parameters
    - paragraphStyles: ParagraphStyle[]
    Returns void
Optional onScrubberPositionChanged?: ((state: AnimationPlaybackType) => void)
- - (state: AnimationPlaybackType): void
  - Parameters
    - state: AnimationPlaybackType
    Returns void
Optional onSelectedFrameContentChanged?: ((state: Frame | null) => void)
- - (state: Frame | null): void
  - Deprecated
    use onSelectedFramesContentChanged instead
    Parameters
    - state: Frame | null
    Returns void
Optional onSelectedFrameLayoutChanged?: ((state: FrameLayoutType) => void)
- - (state: FrameLayoutType): void
  - Deprecated
    use onSelectedFramesLayoutChanged instead
    Parameters
    - state: FrameLayoutType
    Returns void
Optional onSelectedFramesContentChanged?: ((state: Frame[]) => void)
- - (state: Frame[]): void
  - Parameters
    - state: Frame[]
    Returns void
Optional onSelectedFramesLayoutChanged?: ((states: FrameLayoutType[]) => void)
- - (states: FrameLayoutType[]): void
  - Parameters
    - states: FrameLayoutType[]
    Returns void
Optional onSelectedLayoutFramesChanged?: ((frames: SelectedLayoutFrame[]) => void)
- - (frames: SelectedLayoutFrame[]): void
  - Parameters
    - frames: SelectedLayoutFrame[]
    Returns void
Optional onSelectedLayoutIdChanged?: ((layoutId: string) => void)
- - (layoutId: string): void
  - Parameters
    - layoutId: string
    Returns void
Optional onSelectedLayoutPropertiesChanged?: ((state: LayoutPropertiesType) => void)
- - (state: LayoutPropertiesType): void
  - Parameters
    - state: LayoutPropertiesType
    Returns void
Optional onSelectedLayoutUnitChanged?: ((unit: MeasurementUnit) => void)
- - (unit: MeasurementUnit): void
  - Parameters
    - unit: MeasurementUnit
    Returns void
Optional onSelectedTextStyleChanged?: ((styles: SelectedTextStyle) => void)
- - (styles: SelectedTextStyle): void
  - Parameters
    - styles: SelectedTextStyle
    Returns void
Optional onSelectedToolChanged?: ((tool: ToolType) => void)
- - (tool: ToolType): void
  - Parameters
    - tool: ToolType
    Returns void
Optional onShapeCornerRadiusChanged?: ((cornerRadius: CornerRadiusUpdateModel) => void)
- - (cornerRadius: CornerRadiusUpdateModel): void
  - Parameters
    - cornerRadius: CornerRadiusUpdateModel
    Returns void
Optional onStateChanged?: (() => void)
- - (): void
  - Returns void
Optional onUndoStackStateChanged?: ((undoStackState: UndoState) => void)
- - (undoStackState: UndoState): void
  - Parameters
    - undoStackState: UndoState
    Returns void
Optional onVariableListChanged?: ((variableList: Variable[]) => void)
- - (variableList: Variable[]): void
  - Parameters
    - variableList: Variable[]
    Returns void
Optional onViewModeChanged?: ((tool: ViewMode) => void)
- - (tool: ViewMode): void
  - Parameters
    - tool: ViewMode
    Returns void
Optional onViewportRequested?: (() => Viewport | null)
- - (): Viewport | null
  - Returns Viewport | null
Optional onZoomChanged?: ((scaleFactor: number) => void)
- - (scaleFactor: number): void
  - Parameters
    - scaleFactor: number
    Returns void
Optional studioOptions?: StudioOptionsDeltaUpdate
Optional studioStyling?: StudioStyling

Type alias ConfigType

Type declaration

Optional chiliEnvironmentUrl?: string

Optional documentType?: DocumentType

Optional editorId?: string

Optional editorLink?: string

Optional onActionsChanged?: ((state: DocumentAction[]) => void)

Parameters

state: DocumentAction[]

Returns void

Optional onAsyncError?: ((asyncError: AsyncError) => void)

Parameters

asyncError: AsyncError

Returns void

Optional onAuthExpired?: ((authRefreshRequest: AuthRefreshRequest) => Promise<AuthCredentials | null>)

Parameters

authRefreshRequest: AuthRefreshRequest

Returns Promise<AuthCredentials | null>

Optional onBarcodeValidationChanged?: ((validationResults: BarcodeFrameValidationResult[]) => void)

Parameters

validationResults: BarcodeFrameValidationResult[]

Returns void

Optional onCharacterStylesChanged?: ((characterStyles: CharacterStyle[]) => void)

Parameters

characterStyles: CharacterStyle[]

Returns void

Optional onColorsChanged?: ((colors: DocumentColor[]) => void)

Parameters

colors: DocumentColor[]

Returns void

Optional onConnectorEvent?: ((event: ConnectorEvent) => void)

Parameters

event: ConnectorEvent

Returns void

Optional onConnectorsChanged?: ((connectors: ConnectorInstance[]) => void)

Parameters

connectors: ConnectorInstance[]

Returns void

Optional onCropActiveFrameIdChanged?: ((id?: Id) => void)

Parameters

Optional id: Id

Returns void

Optional onDocumentLoaded?: (() => void)

Returns void

Optional onFontFamiliesChanged?: ((fontFamilies: DocumentFontFamily[]) => void)

Parameters

fontFamilies: DocumentFontFamily[]

Returns void

Optional onFrameAnimationsChanged?: ((animationState: FrameAnimationType[]) => void)

Parameters

animationState: FrameAnimationType[]

Returns void

Optional onLayoutsChanged?: ((layouts: LayoutListItemType[]) => void)

Parameters

layouts: LayoutListItemType[]

Returns void

Optional onPageSelectionChanged?: (() => void)

Returns void

Optional onPageSizeChanged?: ((pageSize: PageSize) => void)

Parameters

pageSize: PageSize

Returns void

Optional onParagraphStylesChanged?: ((paragraphStyles: ParagraphStyle[]) => void)

Parameters

paragraphStyles: ParagraphStyle[]

Returns void

Optional onScrubberPositionChanged?: ((state: AnimationPlaybackType) => void)

Parameters

state: AnimationPlaybackType

Returns void

Optional onSelectedFrameContentChanged?: ((state: Frame | null) => void)

Deprecated

Parameters

state: Frame | null

Returns void

Optional onSelectedFrameLayoutChanged?: ((state: FrameLayoutType) => void)

Deprecated

Parameters

state: FrameLayoutType

Returns void

`Optional` chiliEnvironmentUrl?: string

`Optional` documentType?: DocumentType

`Optional` editorId?: string

`Optional` editorLink?: string

`Optional` onActionsChanged?: ((state: DocumentAction[]) => void)

`Optional` onAsyncError?: ((asyncError: AsyncError) => void)

`Optional` onAuthExpired?: ((authRefreshRequest: AuthRefreshRequest) => Promise<AuthCredentials | null>)

`Optional` onBarcodeValidationChanged?: ((validationResults: BarcodeFrameValidationResult[]) => void)

`Optional` onCharacterStylesChanged?: ((characterStyles: CharacterStyle[]) => void)

`Optional` onColorsChanged?: ((colors: DocumentColor[]) => void)

`Optional` onConnectorEvent?: ((event: ConnectorEvent) => void)

`Optional` onConnectorsChanged?: ((connectors: ConnectorInstance[]) => void)

`Optional` onCropActiveFrameIdChanged?: ((id?: Id) => void)

`Optional` id: Id

`Optional` onDocumentLoaded?: (() => void)

`Optional` onFontFamiliesChanged?: ((fontFamilies: DocumentFontFamily[]) => void)

`Optional` onFrameAnimationsChanged?: ((animationState: FrameAnimationType[]) => void)

`Optional` onLayoutsChanged?: ((layouts: LayoutListItemType[]) => void)

`Optional` onPageSelectionChanged?: (() => void)

`Optional` onPageSizeChanged?: ((pageSize: PageSize) => void)

`Optional` onParagraphStylesChanged?: ((paragraphStyles: ParagraphStyle[]) => void)

`Optional` onScrubberPositionChanged?: ((state: AnimationPlaybackType) => void)

`Optional` onSelectedFrameContentChanged?: ((state: Frame | null) => void)

`Optional` onSelectedFrameLayoutChanged?: ((state: FrameLayoutType) => void)

`Optional` onSelectedFramesContentChanged?: ((state: Frame[]) => void)

`Optional` onSelectedFramesLayoutChanged?: ((states: FrameLayoutType[]) => void)

`Optional` onSelectedLayoutFramesChanged?: ((frames: SelectedLayoutFrame[]) => void)

`Optional` onSelectedLayoutIdChanged?: ((layoutId: string) => void)

`Optional` onSelectedLayoutPropertiesChanged?: ((state: LayoutPropertiesType) => void)

`Optional` onSelectedLayoutUnitChanged?: ((unit: MeasurementUnit) => void)

`Optional` onSelectedTextStyleChanged?: ((styles: SelectedTextStyle) => void)

`Optional` onSelectedToolChanged?: ((tool: ToolType) => void)

`Optional` onShapeCornerRadiusChanged?: ((cornerRadius: CornerRadiusUpdateModel) => void)

`Optional` onStateChanged?: (() => void)

`Optional` onUndoStackStateChanged?: ((undoStackState: UndoState) => void)

`Optional` onVariableListChanged?: ((variableList: Variable[]) => void)

`Optional` onViewModeChanged?: ((tool: ViewMode) => void)

`Optional` onViewportRequested?: (() => Viewport | null)

`Optional` onZoomChanged?: ((scaleFactor: number) => void)

`Optional` studioOptions?: StudioOptionsDeltaUpdate

`Optional` studioStyling?: StudioStyling