Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Style

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___backgroundColor

___backgroundColor: any

Private ___bold

___bold: any

Private ___borderColorBottom

___borderColorBottom: any

Private ___borderColorLeft

___borderColorLeft: any

Private ___borderColorRight

___borderColorRight: any

Private ___borderColorTop

___borderColorTop: any

Private ___borderStyleBottom

___borderStyleBottom: any

Private ___borderStyleLeft

___borderStyleLeft: any

Private ___borderStyleRight

___borderStyleRight: any

Private ___borderStyleTop

___borderStyleTop: any

Private ___borderWidthBottom

___borderWidthBottom: any

Private ___borderWidthLeft

___borderWidthLeft: any

Private ___borderWidthRight

___borderWidthRight: any

Private ___borderWidthTop

___borderWidthTop: any

Private ___customStyles

___customStyles: any

Private ___fontColor

___fontColor: any

Private ___fontFamily

___fontFamily: any

Private ___fontSize

___fontSize: any

Private ___italic

___italic: any

Private ___overrideBackgroundColor

___overrideBackgroundColor: any

Private ___overrideBold

___overrideBold: any

Private ___overrideFontColor

___overrideFontColor: any

Private ___overrideFontFamily

___overrideFontFamily: any

Private ___overrideFontSize

___overrideFontSize: any

Private ___overrideItalic

___overrideItalic: any

Private ___textAlign

___textAlign: any

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

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

textAlign

textAlign: TextAlign

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

  • 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.

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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