Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRange

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsDatabaseRetrieveSource

containerAsDatabaseRetrieveSource: DatabaseRetrieveSource

containerAsImportMappingCall

containerAsImportMappingCall: ImportMappingCall

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

limitExpression

limitExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

limitExpressionModel

limitExpressionModel: Expression

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

In version 7.9.0: introduced

model

model: IModel

offsetExpression

offsetExpression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

offsetExpressionModel

offsetExpressionModel: Expression

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

In version 7.9.0: introduced

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

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

Static createInDatabaseRetrieveSourceUnderRange

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

    Parameters

    Returns CustomRange

Static createInImportMappingCallUnderRange

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

    Parameters

    Returns CustomRange

Generated using TypeDoc