Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetValue

Hierarchy

Implements

Index

Constructors

constructor

Properties

action

action: ClientAction

In version 7.19.0: introduced

attributePath

attributePath: string

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

In version 7.11.0: deleted

attributeRef

attributeRef: AttributeRef | null

In version 7.11.0: introduced

container

container: AbstractElement

containerAsWidgetProperty

containerAsWidgetProperty: WidgetProperty

entityPath

entityPath: string

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

In version 7.11.0: deleted

entityRef

entityRef: EntityRef | null

In version 7.11.0: introduced

id

id: string

image

image: IImage | null

imageQualifiedName

imageQualifiedName: string | null

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

microflow

microflow: IMicroflow | null

microflowQualifiedName

microflowQualifiedName: string | null

model

model: IModel

nanoflow

nanoflow: INanoflow | null

In version 7.13.0: introduced

nanoflowQualifiedName

nanoflowQualifiedName: string | null

objects

page

page: IPage | null

pageQualifiedName

pageQualifiedName: string | null

primitiveValue

primitiveValue: string

structureTypeName

structureTypeName: string

textTemplate

textTemplate: ClientTemplate | null

In version 7.23.0: introduced

translatableValue

translatableValue: Text | null

type

unit

unit: ModelUnit

xPathConstraint

xPathConstraint: string

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

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