Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetValue

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___attributePath

___attributePath: any

Private ___entityPath

___entityPath: any

Private ___image

___image: any

Private ___microflow

___microflow: any

Private ___objects

___objects: any

Private ___page

___page: any

Private ___primitiveValue

___primitiveValue: any

Private ___translatableValue

___translatableValue: any

Private ___type

___type: any

Private ___xPathConstraint

___xPathConstraint: any

attributePath

attributePath: string

The value of this property is conceptually of type paths.AttributePath.

container

container: AbstractElement

containerAsWidgetProperty

containerAsWidgetProperty: WidgetProperty

entityPath

entityPath: string

The value of this property is conceptually of type paths.EntityPath.

id

id: string

image

image: IImage

imageQualifiedName

imageQualifiedName: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

microflow

microflow: IMicroflow

microflowQualifiedName

microflowQualifiedName: string

model

model: IModel

objects

objects: IList<WidgetObject>

page

page: IPage

pageQualifiedName

pageQualifiedName: string

primitiveValue

primitiveValue: string

qualifiedName

qualifiedName: string

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

translatableValue

translatableValue: Text

type

type: WidgetValueType

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

xPathConstraint

xPathConstraint: string

The value of this property is conceptually of type xPathConstraints.XPathConstraint.

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

Static createIn

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

    Parameters

    Returns WidgetValue

Generated using TypeDoc