Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetValue

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

id

id: string

model

model: IModel

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

action

  • In version 7.19.0: introduced

    Returns ClientAction

  • In version 7.19.0: introduced

    Parameters

    Returns any

attributePath

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Returns string

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

    In version 7.11.0: deleted

    Parameters

    • newValue: string

    Returns any

attributeRef

  • In version 7.11.0: introduced

    Returns AttributeRef | null

  • In version 7.11.0: introduced

    Parameters

    Returns any

containerAsWidgetProperty

dataSource

  • In version 8.3.0: introduced

    Returns DataSource | null

  • In version 8.3.0: introduced

    Parameters

    Returns any

entityPath

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type paths.LegacyEntityPath.

    In version 7.11.0: deleted

    Returns string

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

    In version 7.11.0: deleted

    Parameters

    • newValue: string

    Returns any

entityRef

  • In version 7.11.0: introduced

    Returns EntityRef | null

  • In version 7.11.0: introduced

    Parameters

    Returns any

expression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 8.0.0: introduced

    Returns string

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns any

icon

  • get (): Icon | null
  • set (newValue: Icon | null): any
  • In version 8.0.0: introduced

    Returns Icon | null

  • In version 8.0.0: introduced

    Parameters

    • newValue: Icon | null

    Returns any

image

  • Returns IImage | null

  • Parameters

    Returns any

imageQualifiedName

  • get (): string | null
  • Returns string | null

isLoaded

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

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

    Returns boolean

microflow

microflowQualifiedName

  • get (): string | null
  • Returns string | null

nanoflow

  • In version 7.13.0: introduced

    Returns INanoflow | null

  • In version 7.13.0: introduced

    Parameters

    Returns any

nanoflowQualifiedName

  • get (): string | null
  • Returns string | null

objects

page

  • get (): IPage | null
  • set (newValue: IPage | null): any
  • Returns IPage | null

  • Parameters

    Returns any

pageQualifiedName

  • get (): string | null
  • Returns string | null

primitiveValue

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

  • Parameters

    • newValue: string

    Returns any

sourceVariable

  • In version 8.8.0: introduced

    Returns PageVariable | null

  • In version 8.8.0: introduced

    Parameters

    Returns any

textTemplate

  • In version 7.23.0: introduced

    Returns ClientTemplate | null

  • In version 7.23.0: introduced

    Parameters

    Returns any

translatableValue

  • get (): Text | null
  • set (newValue: Text | null): any
  • Returns Text | null

  • Parameters

    • newValue: Text | null

    Returns any

type

unit

widgets

xPathConstraint

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type xPathConstraints.XPathConstraint.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

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