Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 7.6.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

attribute

attribute: IAttribute

attributeQualifiedName

attributeQualifiedName: string

children

children: IList<Element>

container

container: AbstractElement

containerAsElement

containerAsElement: Element

containerAsEntityMessageDefinition

containerAsEntityMessageDefinition: EntityMessageDefinition

containerAsJsonStructure

containerAsJsonStructure: JsonStructure

documentation

documentation: string

In version 7.15.0: introduced

elementType

elementType: ElementType

errorMessage

errorMessage: string

example

example: string

In version 7.15.0: introduced

exposedItemName

exposedItemName: string

In version 7.6.0: introduced

exposedName

exposedName: string

fractionDigits

fractionDigits: number

id

id: string

isDefaultType

isDefaultType: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

maxLength

maxLength: number

maxOccurs

maxOccurs: number

minOccurs

minOccurs: number

model

model: IModel

nillable

nillable: boolean

originalName

originalName: string

path

path: string

The value of this property is conceptually of type mappings.ElementPath.

primitiveType

primitiveType: XmlPrimitiveType

structureTypeName

structureTypeName: string

totalDigits

totalDigits: number

unit

unit: ModelUnit

warningMessage

warningMessage: string

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

Static createInElementUnderChildren

  • Creates and returns a new ExposedAttribute instance in the SDK and on the server. The new ExposedAttribute will be automatically stored in the 'children' property of the parent mappings.Element element passed as argument.

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

    Parameters

    Returns ExposedAttribute

Static createInJsonStructureUnderElements

  • Creates and returns a new ExposedAttribute instance in the SDK and on the server. The new ExposedAttribute will be automatically stored in the 'elements' property of the parent jsonstructures.JsonStructure element passed as argument.

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

    Parameters

    Returns ExposedAttribute

Generated using TypeDoc