Class WidgetValueType

Hierarchy

Element<IModel>
- WidgetValueType

Constructors

constructor

new WidgetValueType(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): WidgetValueType

Overrides Element.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns WidgetValueType

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "CustomWidgets$WidgetValueType"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

actionVariables

get actionVariables(): IList<WidgetActionVariable>

In version 10.21.0: introduced

Returns IList<WidgetActionVariable>

allowNonPersistableEntities

get allowNonPersistableEntities(): boolean
set allowNonPersistableEntities(newValue: boolean): void

Returns boolean
Parameters
- newValue: boolean
Returns void

associationTypes

get associationTypes(): IList<CustomWidgetAssociationType>

In version 9.12.0: introduced

Returns IList<CustomWidgetAssociationType>

attributeTypes

get attributeTypes(): IList<CustomWidgetAttributeType>

Returns IList<CustomWidgetAttributeType>

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

containerAsWidgetPropertyType

get containerAsWidgetPropertyType(): WidgetPropertyType

Returns WidgetPropertyType

dataSourceProperty

get dataSourceProperty(): string
set dataSourceProperty(newValue: string): void

In version 8.4.0: introduced

Returns string
In version 8.4.0: introduced

Parameters
- newValue: string
Returns void

defaultType

get defaultType(): DefaultTypeEnum
set defaultType(newValue: DefaultTypeEnum): void

In version 10.15.0: introduced

Returns DefaultTypeEnum
In version 10.15.0: introduced

Parameters
- newValue: DefaultTypeEnum
Returns void

defaultValue

get defaultValue(): string
set defaultValue(newValue: string): void

Returns string
Parameters
- newValue: string
Returns void

entityProperty

get entityProperty(): string
set entityProperty(newValue: string): void

Returns string
Parameters
- newValue: string
Returns void

enumerationValues

get enumerationValues(): IList<WidgetEnumerationValue>

Returns IList<WidgetEnumerationValue>

isLinked

get isLinked(): boolean
set isLinked(newValue: boolean): void

In version 10.14.0: introduced

Returns boolean
In version 10.14.0: introduced

Parameters
- newValue: boolean
Returns void

isList

get isList(): boolean
set isList(newValue: boolean): void

Returns boolean
Parameters
- newValue: boolean
Returns void

isLoaded

get isLoaded(): boolean

Inherited from internal.Element.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

isMetaData

get isMetaData(): boolean
set isMetaData(newValue: boolean): void

In version 10.14.0: introduced

Returns boolean
In version 10.14.0: introduced

Parameters
- newValue: boolean
Returns void

isPath

get isPath(): IsPath
set isPath(newValue: IsPath): void

Returns IsPath
Parameters
- newValue: IsPath
Returns void

model

get model(): TModel

Inherited from internal.Element.model
Returns TModel

multiline

get multiline(): boolean
set multiline(newValue: boolean): void

Returns boolean
Parameters
- newValue: boolean
Returns void

objectType

get objectType(): null | WidgetObjectType
set objectType(newValue: null | WidgetObjectType): void

Returns null | WidgetObjectType
Parameters
- newValue: null | WidgetObjectType
Returns void

onChangeProperty

get onChangeProperty(): string
set onChangeProperty(newValue: string): void

In version 8.0.0: introduced

Returns string
In version 8.0.0: introduced

Parameters
- newValue: string
Returns void

parameterIsList

get parameterIsList(): boolean
set parameterIsList(newValue: boolean): void

Returns boolean
Parameters
- newValue: boolean
Returns void

pathType

get pathType(): PathType
set pathType(newValue: PathType): void

Returns PathType
Parameters
- newValue: PathType
Returns void

required

get required(): boolean
set required(newValue: boolean): void

Returns boolean
Parameters
- newValue: boolean
Returns void

returnType

get returnType(): null | WidgetReturnType
set returnType(newValue: null | WidgetReturnType): void

Returns null | WidgetReturnType
Parameters
- newValue: null | WidgetReturnType
Returns void

selectableObjectsProperty

get selectableObjectsProperty(): string
set selectableObjectsProperty(newValue: string): void

In version 9.12.0: introduced

Returns string
In version 9.12.0: introduced

Parameters
- newValue: string
Returns void

selectionTypes

get selectionTypes(): IList<CustomWidgetSelectionType>

In version 9.23.0: introduced

Returns IList<CustomWidgetSelectionType>

setLabel

get setLabel(): boolean
set setLabel(newValue: boolean): void

In version 10.5.0: introduced

Returns boolean
In version 10.5.0: introduced

Parameters
- newValue: boolean
Returns void

translations

get translations(): IList<WidgetTranslation>

Returns IList<WidgetTranslation>

type

get type(): WidgetValueTypeEnum
set type(newValue: WidgetValueTypeEnum): void

Returns WidgetValueTypeEnum
Parameters
- newValue: WidgetValueTypeEnum
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from internal.Element.unit
Returns ModelUnit<IAbstractModel>

universeDataSourceProperty

get universeDataSourceProperty(): string
set universeDataSourceProperty(newValue: string): void

In version 9.12.0: deleted In version 9.10.0: introduced

Returns string
In version 9.12.0: deleted In version 9.10.0: introduced

Parameters
- newValue: string
Returns void

Methods

allProperties

allProperties(): AbstractProperty<any, any>[]

Inherited from Element.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): WidgetValueType

Inherited from Element.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 WidgetValueType

deepCopy

deepCopy(targetModel: IAbstractModel): WidgetValueType

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns WidgetValueType

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from Element.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from Element.delete

Deletes this element from the model.

Returns void

detach

detach(): WidgetValueType

Inherited from Element.detach

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

Returns WidgetValueType

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Inherited from Element.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from Element.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

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

Inherited from Element.load
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: (elem: WidgetValueType) => void
  - - (elem: WidgetValueType): void
    - Parameters
      - elem: WidgetValueType
      Returns void
- Optional forceRefresh: boolean
Returns void
Inherited from Element.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<WidgetValueType>

loadedProperties

loadedProperties(): AbstractProperty<any, any>[]

Inherited from Element.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

publicProperties(): AbstractProperty<any, any>[]

Inherited from Element.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Inherited from Element.toJSON

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

Inherited from Element.traverse

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

traverseFind

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

Inherited from Element.traverseFind

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

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

traversePublicParts(visit: (structure: IStructure) => void): void

Inherited from Element.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): WidgetValueType

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
- model: IModel
Returns WidgetValueType

Static createIn

createIn(container: WidgetPropertyType): WidgetValueType

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
- container: WidgetPropertyType
Returns WidgetValueType

Generated using TypeDoc