Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CSVSheet

In version 11.7.0: removed experimental In version 10.15.0: added public In version 10.6.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "ExcelDataImporter$CSVSheet"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

columnAttributeMappings

container

  • get container(): TContainer

  • Returns TContainer

containerAsCSVTemplateContents

containerAsExcelTemplateContents

csvRootElement

delimiter

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

entity

  • get entity(): null | IEntity
  • set entity(newValue: null | IEntity): void

  • In version 10.16.0: added optional

    Returns null | IEntity

  • In version 10.16.0: added optional

    Parameters

    Returns void

entityQualifiedName

  • get entityQualifiedName(): null | string

  • Returns null | string

escapeChar

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

headerIncluded

  • get headerIncluded(): boolean
  • set headerIncluded(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

model

  • get model(): TModel

  • Returns TModel

name

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

  • In version 10.15.0: introduced

    Returns string

  • In version 10.15.0: introduced

    Parameters

    • newValue: string

    Returns void

qualifiedName

  • get qualifiedName(): null | string

  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

quoteChar

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

unit

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 CSVSheet

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

    Returns CSVSheet

findElementById

Protected getContainerAs

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

load

  • load(callback: (elem: CSVSheet) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<CSVSheet>

  • 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: (elem: CSVSheet) => void
    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<CSVSheet>

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

traversePublicParts

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

Static create

  • Creates and returns a new CSVSheet 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

    • model: IModel

    Returns CSVSheet

Static createIn

  • Creates and returns a new CSVSheet instance in the SDK and on the server. The new CSVSheet will be automatically stored in the 'sheet' property of the parent CSVTemplateContents element passed as argument.

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

    Parameters

    Returns CSVSheet

Generated using TypeDoc