Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetValue

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "CustomWidgets$WidgetValue"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

action

  • In version 7.19.0: introduced

    Returns ClientAction

  • In version 7.19.0: introduced

    Parameters

    Returns void

attributePath

  • get attributePath(): string
  • set attributePath(newValue: string): void

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

attributeRef

  • In version 7.11.0: introduced

    Returns null | AttributeRef

  • In version 7.11.0: introduced

    Parameters

    Returns void

container

  • get container(): TContainer

  • Returns TContainer

containerAsWidgetProperty

dataSource

  • In version 8.3.0: introduced

    Returns null | DataSource

  • In version 8.3.0: introduced

    Parameters

    Returns void

entityPath

  • get entityPath(): string
  • set entityPath(newValue: string): void

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

entityRef

  • In version 7.11.0: introduced

    Returns null | EntityRef

  • In version 7.11.0: introduced

    Parameters

    Returns void

expression

  • get expression(): string
  • set expression(newValue: string): void

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

icon

  • get icon(): null | Icon
  • set icon(newValue: null | Icon): void

  • In version 8.0.0: introduced

    Returns null | Icon

  • In version 8.0.0: introduced

    Parameters

    • newValue: null | Icon

    Returns void

image

  • get image(): null | IImage
  • set image(newValue: null | IImage): void

  • Returns null | IImage

  • Parameters

    Returns void

imageQualifiedName

  • get imageQualifiedName(): null | string

  • Returns null | string

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

microflow

microflowQualifiedName

  • get microflowQualifiedName(): null | string

  • Returns null | string

model

  • get model(): TModel

  • Returns TModel

nanoflow

  • In version 7.13.0: introduced

    Returns null | INanoflow

  • In version 7.13.0: introduced

    Parameters

    Returns void

nanoflowQualifiedName

  • get nanoflowQualifiedName(): null | string

  • Returns null | string

objects

page

  • get page(): null | IPage
  • set page(newValue: null | IPage): void

  • Returns null | IPage

  • Parameters

    Returns void

pageQualifiedName

  • get pageQualifiedName(): null | string

  • Returns null | string

primitiveValue

  • get primitiveValue(): string
  • set primitiveValue(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

selection

sourceVariable

  • In version 8.8.0: introduced

    Returns null | PageVariable

  • In version 8.8.0: introduced

    Parameters

    Returns void

textTemplate

  • In version 7.23.0: introduced

    Returns null | ClientTemplate

  • In version 7.23.0: introduced

    Parameters

    Returns void

translatableValue

  • get translatableValue(): null | Text
  • set translatableValue(newValue: null | Text): void

  • Returns null | Text

  • Parameters

    • newValue: null | Text

    Returns void

type

unit

widgets

xPathConstraint

  • get xPathConstraint(): string
  • set xPathConstraint(newValue: string): void

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

Methods

allProperties

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.

    Returns WidgetValue

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

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

    Returns WidgetValue

findElementById

Protected getContainerAs

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

load

  • load(callback: (elem: WidgetValue) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<WidgetValue>

  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<WidgetValue>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): 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

    • model: IModel

    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