Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRange

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

id

id: string

model

model: IModel

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

containerAsDatabaseRetrieveSource

containerAsImportMappingCall

isLoaded

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

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

    Returns boolean

limitExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

limitExpressionModel

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

    In version 7.9.0: introduced

    Returns Expression

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

    In version 7.9.0: introduced

    Parameters

    Returns any

offsetExpression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

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

    Parameters

    • newValue: string

    Returns any

offsetExpressionModel

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

    In version 7.9.0: introduced

    Returns Expression

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

    In version 7.9.0: introduced

    Parameters

    Returns any

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this
  • 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 this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>
  • 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: this): void
        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

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