Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetValueType

Hierarchy

Implements

Index

Constructors

constructor

Properties

allowNonPersistableEntities

allowNonPersistableEntities: boolean

attributeTypes

container

container: AbstractElement

containerAsWidgetPropertyType

containerAsWidgetPropertyType: WidgetPropertyType

defaultValue

defaultValue: string

entityProperty

entityProperty: string

enumerationValues

enumerationValues: IList<WidgetEnumerationValue>

id

id: string

isList

isList: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

isPath

isPath: IsPath

model

model: IModel

multiline

multiline: boolean

objectType

objectType: WidgetObjectType | null

parameterIsList

parameterIsList: boolean

pathType

pathType: PathType

required

required: boolean

returnType

returnType: WidgetReturnType | null

structureTypeName

structureTypeName: string

translations

translations: IList<WidgetTranslation>

type

unit

unit: ModelUnit

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

Static createIn

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

    Parameters

    Returns WidgetValueType

Generated using TypeDoc