Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

backgroundColor

backgroundColor: IColor

bold

bold: boolean

borderColorBottom

borderColorBottom: IColor

borderColorLeft

borderColorLeft: IColor

borderColorRight

borderColorRight: IColor

borderColorTop

borderColorTop: IColor

borderStyleBottom

borderStyleBottom: BorderStyle

borderStyleLeft

borderStyleLeft: BorderStyle

borderStyleRight

borderStyleRight: BorderStyle

borderStyleTop

borderStyleTop: BorderStyle

borderWidthBottom

borderWidthBottom: number

borderWidthLeft

borderWidthLeft: number

borderWidthRight

borderWidthRight: number

borderWidthTop

borderWidthTop: number

container

container: AbstractElement

containerAsDataGridCell

containerAsDataGridCell: DataGridCell

containerAsDataGridColumn

containerAsDataGridColumn: DataGridColumn

containerAsDocumentTemplate

containerAsDocumentTemplate: DocumentTemplate

containerAsDynamicLabel

containerAsDynamicLabel: DynamicLabel

containerAsGrid

containerAsGrid: Grid

containerAsStaticLabel

containerAsStaticLabel: StaticLabel

containerAsTable

containerAsTable: Table

containerAsTableCell

containerAsTableCell: TableCell

containerAsTitle

containerAsTitle: Title

customStyles

customStyles: string

fontColor

fontColor: IColor

fontFamily

fontFamily: FontFamily

fontSize

fontSize: number

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

  • if false, a load is required to access these properties.

italic

italic: boolean

model

model: IModel

overrideBackgroundColor

overrideBackgroundColor: boolean

overrideBold

overrideBold: boolean

overrideFontColor

overrideFontColor: boolean

overrideFontFamily

overrideFontFamily: boolean

overrideFontSize

overrideFontSize: boolean

overrideItalic

overrideItalic: boolean

structureTypeName

structureTypeName: string

textAlign

textAlign: TextAlign

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

  • asLoaded()
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach()
  • Detaches this element from the model, so that it can be attached in a different place.

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new Style instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns Style

Static createInDataGridCellUnderStyle

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DataGridCell element passed as argument.

    Parameters

    Returns Style

Static createInDataGridColumnUnderStyle

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DataGridColumn element passed as argument.

    Parameters

    Returns Style

Static createInDocumentTemplateUnderStyle

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DocumentTemplate element passed as argument.

    Parameters

    Returns Style

Static createInDynamicLabelUnderStyle

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DynamicLabel element passed as argument.

    Parameters

    Returns Style

Static createInGridUnderStyle

  • createInGridUnderStyle(container: Grid): Style
  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent Grid element passed as argument.

    Parameters

    Returns Style

Static createInStaticLabelUnderStyle

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent StaticLabel element passed as argument.

    Parameters

    Returns Style

Static createInTableCellUnderStyle

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent TableCell element passed as argument.

    Parameters

    Returns Style

Static createInTableUnderStyle

  • createInTableUnderStyle(container: Table): Style
  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent Table element passed as argument.

    Parameters

    Returns Style

Static createInTitleUnderStyle

  • createInTitleUnderStyle(container: Title): Style
  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent Title element passed as argument.

    Parameters

    Returns Style

Generated using TypeDoc