Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Element

In version 6.6.0: introduced

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Mappings$Element"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

children

container

  • get container(): TContainer

  • Returns TContainer

containerAsCSVSheet

  • get containerAsCSVSheet(): CSVSheet

  • Returns CSVSheet

containerAsElement

containerAsEntityMessageDefinition

containerAsExcelSheet

  • get containerAsExcelSheet(): ExcelSheet

  • Returns ExcelSheet

containerAsJsonStructure

elementType

errorMessage

  • get errorMessage(): string
  • set errorMessage(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

exposedItemName

  • get exposedItemName(): string
  • set exposedItemName(newValue: string): void

  • In version 7.6.0: introduced

    Returns string

  • In version 7.6.0: introduced

    Parameters

    • newValue: string

    Returns void

exposedName

  • get exposedName(): string
  • set exposedName(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

fractionDigits

  • get fractionDigits(): number
  • set fractionDigits(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

isDefaultType

  • get isDefaultType(): boolean
  • set isDefaultType(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

maxLength

  • get maxLength(): number
  • set maxLength(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

maxOccurs

  • get maxOccurs(): number
  • set maxOccurs(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

minOccurs

  • get minOccurs(): number
  • set minOccurs(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

model

  • get model(): TModel

  • Returns TModel

nillable

  • get nillable(): boolean
  • set nillable(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

path

  • get path(): string
  • set path(newValue: string): void

  • 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 void

primitiveType

totalDigits

  • get totalDigits(): number
  • set totalDigits(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

unit

warningMessage

  • get warningMessage(): string
  • set warningMessage(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

Methods

allProperties

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 mappings.Element

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

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

    Returns mappings.Element

findElementById

Protected getContainerAs

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

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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<mappings.Element>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • 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

  • 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

    Returns void

traverseFind

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

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

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

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

Generated using TypeDoc