Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Mappings$ValueMappingElement"
versionInfo: StructureVersionInfo = ...

Accessors

  • get attributeQualifiedName(): null | string
  • Returns null | string

  • get container(): TContainer
  • Returns TContainer

  • Returns MappingDocument

  • get converterQualifiedName(): null | string
  • Returns null | string

  • get documentation(): string
  • set documentation(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • Returns ElementType

  • Parameters

    Returns void

  • get expectedContentTypes(): string
  • set expectedContentTypes(newValue: string): void
  • In version 6.4.1: deleted

    Returns string

  • In version 6.4.1: deleted

    Parameters

    • newValue: string

    Returns void

  • get exposedName(): string
  • set exposedName(newValue: string): void
  • In version 6.6.0: introduced

    Returns string

  • In version 6.6.0: introduced

    Parameters

    • newValue: string

    Returns void

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

  • Parameters

    • newValue: number

    Returns void

  • get isContent(): boolean
  • set isContent(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get isKey(): boolean
  • set isKey(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

  • get isXmlAttribute(): boolean
  • set isXmlAttribute(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get jsonPath(): string
  • set jsonPath(newValue: string): void
  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: introduced

    Returns string

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

    In version 7.6.0: introduced

    Parameters

    • newValue: string

    Returns void

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

  • Parameters

    • newValue: number

    Returns void

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

  • Parameters

    • newValue: number

    Returns void

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

  • Parameters

    • newValue: number

    Returns void

  • get model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: boolean

    Returns void

  • get originalValue(): string
  • set originalValue(newValue: string): void
  • In version 10.3.0: introduced

    Returns string

  • In version 10.3.0: introduced

    Parameters

    • newValue: string

    Returns void

  • get path(): string
  • set path(newValue: string): void
  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: deleted

    Returns string

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

    In version 7.6.0: deleted

    Parameters

    • newValue: string

    Returns void

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

  • Parameters

    • newValue: number

    Returns void

  • In version 7.9.0: introduced

    Returns DataType

  • In version 7.9.0: introduced

    Parameters

    Returns void

  • get xmlDataType(): string
  • set xmlDataType(newValue: string): void
  • The value of this property is conceptually of type dataTypes.LegacyDataType.

    In version 7.9.0: deleted

    Returns string

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

    In version 7.9.0: deleted

    Parameters

    • newValue: string

    Returns void

  • get xmlPath(): string
  • set xmlPath(newValue: string): void
  • The value of this property is conceptually of type mappings.ElementPath.

    In version 7.6.0: introduced

    Returns string

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

    In version 7.6.0: introduced

    Parameters

    • newValue: string

    Returns void

Methods

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

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • 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<ValueMappingElement>

  • 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(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<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(visit: (structure: IStructure) => void): void

Generated using TypeDoc