Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExposedAttribute

In version 7.6.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

attribute

attributeQualifiedName

  • get (): string

  • Returns string

children

container

containerAsElement

containerAsEntityMessageDefinition

containerAsJsonStructure

documentation

  • get (): string
  • set (newValue: string): any

elementType

errorMessage

  • get (): string
  • set (newValue: string): any

example

  • get (): string
  • set (newValue: string): any

exposedItemName

  • get (): string
  • set (newValue: string): any

exposedName

  • get (): string
  • set (newValue: string): any

fractionDigits

  • get (): number
  • set (newValue: number): any

isDefaultType

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

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

maxLength

  • get (): number
  • set (newValue: number): any

maxOccurs

  • get (): number
  • set (newValue: number): any

minOccurs

  • get (): number
  • set (newValue: number): any

model

nillable

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

originalName

  • get (): string
  • set (newValue: string): any

path

  • get (): string
  • set (newValue: string): any

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

    Returns string

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

    Parameters

    • newValue: string

    Returns any

primitiveType

totalDigits

  • get (): number
  • set (newValue: number): any

unit

warningMessage

  • get (): string
  • set (newValue: string): any

Methods

allProperties

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

asLoaded

  • asLoaded(): this

  • 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

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

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

    Returns this

findElementById

Protected getContainerAs

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

load

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

  • 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

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

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

publicProperties

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

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