Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImportValueMappingElement

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

attribute

attribute: IAttribute | null

attributeQualifiedName

attributeQualifiedName: string | null

container

container: AbstractElement

containerAsMappingDocument

containerAsMappingDocument: MappingDocument

containerAsObjectMappingElement

containerAsObjectMappingElement: ObjectMappingElement

converter

converter: IMicroflow | null

converterQualifiedName

converterQualifiedName: string | null

documentation

documentation: string

elementType

elementType: ElementType

expectedContentTypes

expectedContentTypes: string

In version 6.4.1: deleted

exposedName

exposedName: string

In version 6.6.0: introduced

fractionDigits

fractionDigits: number

id

id: string

isContent

isContent: boolean

isKey

isKey: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

isXmlAttribute

isXmlAttribute: boolean

jsonPath

jsonPath: string

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

In version 7.6.0: introduced

maxLength

maxLength: number

maxOccurs

maxOccurs: number

minOccurs

minOccurs: number

model

model: IModel

nillable

nillable: boolean

path

path: string

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

In version 7.6.0: deleted

structureTypeName

structureTypeName: string

totalDigits

totalDigits: number

type

type: DataType

In version 7.9.0: introduced

unit

unit: ModelUnit

xmlDataType

xmlDataType: string

The value of this property is conceptually of type dataTypes.LegacyDataType.

In version 7.9.0: deleted

xmlPath

xmlPath: string

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

In version 7.6.0: introduced

xmlPrimitiveType

xmlPrimitiveType: XmlPrimitiveType

In version 6.1.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

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

Static createIn

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

    Parameters

    Returns ImportValueMappingElement

Generated using TypeDoc