Class PageVariable

In version 8.4.0: introduced

Hierarchy

Element<IModel>

Implements

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new PageVariable(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): PageVariable

Overwrites Element.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns PageVariable

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

get (): AbstractElement

Inherited from AbstractUnit.container

Returns AbstractElement

containerAsAttributeWidget

get (): AttributeWidget

Returns AttributeWidget

containerAsMicroflowParameterMapping

get (): MicroflowParameterMapping

Returns MicroflowParameterMapping

containerAsNanoflowParameterMapping

get (): NanoflowParameterMapping

Returns NanoflowParameterMapping

containerAsPageParameterMapping

get (): PageParameterMapping

Returns PageParameterMapping

containerAsWidgetValue

get (): WidgetValue

Returns WidgetValue

isLoaded

get (): boolean

Inherited from Element.isLoaded

Overwrites AbstractElement.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

pageParameter

get (): PageParameter | null
set (newValue: PageParameter | null): any

In version 9.5.0: introduced

Returns PageParameter | null
In version 9.5.0: introduced

Parameters
- newValue: PageParameter | null
Returns any

pageParameterLocalName

get (): string | null

Returns string | null

unit

get (): ModelUnit<IAbstractModel>

Inherited from Element.unit

Overwrites AbstractUnit.unit

Returns ModelUnit<IAbstractModel>

useAllPages

get (): boolean
set (newValue: boolean): any

Returns boolean
Parameters
- newValue: boolean
Returns any

widget

get (): Widget | null
set (newValue: Widget | null): any

Returns Widget | null
Parameters
- newValue: Widget | null
Returns any

widgetLocalName

get (): string | null

Returns string | null

Methods

allProperties

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

Implementation of IElement.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of IElement.asLoaded

Inherited from ModelUnit.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 this

deepCopy

deepCopy(targetModel: IAbstractModel): this

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns this

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): object

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 object
- copy: Element
- idMap: IMap<Structure>

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites AbstractUnit.delete

Deletes this element from the model.

Returns void

detach

detach(): this

Inherited from Element.detach

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

Returns this

findElementById

findElementById(id: string): AbstractElement | null

Implementation of IElement.findElementById

Inherited from AbstractElement.findElementById

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

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: function, forceRefresh?: undefined | false | true): void
load(forceRefresh?: undefined | false | true): Promise<this>

Inherited from ModelUnit.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: function
  - - (elem: this): void
    - Parameters
      - elem: this
      Returns void
- Optional forceRefresh: undefined | false | true
Returns void
Implementation of IElement.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

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

Implementation of IElement.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IElement.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IElement.toJSON

Inherited from AbstractUnit.toJSON

Returns IStructureJSON

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: function): T | null

Inherited from AbstractUnit.traverseFind

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

traversePublicParts

traversePublicParts(visit: function): void

Inherited from AbstractUnit.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): PageVariable

Creates and returns a new PageVariable 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 PageVariable

Static createInAttributeWidgetUnderSourceVariable

createInAttributeWidgetUnderSourceVariable(container: AttributeWidget): PageVariable

Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'sourceVariable' property of the parent AttributeWidget element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 8.8.0 and higher

Parameters
- container: AttributeWidget
Returns PageVariable

Static createInMicroflowParameterMappingUnderVariable

createInMicroflowParameterMappingUnderVariable(container: MicroflowParameterMapping): PageVariable

Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'variable' property of the parent MicroflowParameterMapping element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 8.4.0 and higher

Parameters
- container: MicroflowParameterMapping
Returns PageVariable

Static createInNanoflowParameterMappingUnderVariable

createInNanoflowParameterMappingUnderVariable(container: NanoflowParameterMapping): PageVariable

Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'variable' property of the parent NanoflowParameterMapping element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 8.4.0 and higher

Parameters
- container: NanoflowParameterMapping
Returns PageVariable

Static createInPageParameterMappingUnderVariable

createInPageParameterMappingUnderVariable(container: PageParameterMapping): PageVariable

Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'variable' property of the parent PageParameterMapping element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 9.7.0 and higher

Parameters
- container: PageParameterMapping
Returns PageVariable

Static createInWidgetValueUnderSourceVariable

createInWidgetValueUnderSourceVariable(container: WidgetValue): PageVariable

Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'sourceVariable' property of the parent customwidgets.WidgetValue element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 8.8.0 and higher

Parameters
- container: WidgetValue
Returns PageVariable

Generated using TypeDoc