Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScrollContainerRegion

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns any

class

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

container

containerAsScrollContainer

isLoaded

  • get (): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

model

size

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

  • Parameters

    • newValue: number

    Returns any

sizeMode

style

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

toggleMode

  • In version 6.10.0: introduced

    Returns ToggleMode

  • In version 6.10.0: introduced

    Parameters

    Returns any

unit

widget

  • In version 7.15.0: deleted

    Returns Widget | null

  • In version 7.15.0: deleted

    Parameters

    Returns any

widgets

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 ScrollContainerRegion 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 ScrollContainerRegion

Static createInScrollContainerUnderBottom

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

    Parameters

    Returns ScrollContainerRegion

Static createInScrollContainerUnderCenter

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

    Parameters

    Returns ScrollContainerRegion

Static createInScrollContainerUnderLeft

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

    Parameters

    Returns ScrollContainerRegion

Static createInScrollContainerUnderRight

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

    Parameters

    Returns ScrollContainerRegion

Static createInScrollContainerUnderTop

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

    Parameters

    Returns ScrollContainerRegion

Generated using TypeDoc