Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Style

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

backgroundColor

bold

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

borderColorBottom

borderColorLeft

borderColorRight

borderColorTop

borderStyleBottom

borderStyleLeft

borderStyleRight

borderStyleTop

borderWidthBottom

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

borderWidthLeft

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

borderWidthRight

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

borderWidthTop

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

container

containerAsDataGridCell

containerAsDataGridColumn

containerAsDocumentTemplate

containerAsDynamicLabel

containerAsGrid

containerAsStaticLabel

containerAsTable

containerAsTableCell

containerAsTitle

customStyles

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

fontColor

fontFamily

fontSize

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

italic

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

model

overrideBackgroundColor

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

overrideBold

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

overrideFontColor

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

overrideFontFamily

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

overrideFontSize

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

overrideItalic

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

textAlign

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

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

    Returns this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

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

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

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