Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RangeSearchField

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___includeLower

___includeLower: any

Private ___includeUpper

___includeUpper: any

Private ___lowerBound

___lowerBound: any

Private ___upperBound

___upperBound: any

caption

caption: Text

container

container: AbstractElement

containerAsControlBar

containerAsControlBar: ControlBar

containerAsGridControlBar

containerAsGridControlBar: GridControlBar

defaultValue

defaultValue: string

id

id: string

includeLower

includeLower: boolean

includeUpper

includeUpper: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

lowerBound

lowerBound: string

The value of this property is conceptually of type paths.AttributePath.

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

type

type: SearchFieldType

typeName

typeName: string

unit

unit: ModelUnit

upperBound

upperBound: string

The value of this property is conceptually of type paths.AttributePath.

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): 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.

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

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

Static createIn

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

    Parameters

    Returns RangeSearchField

Generated using TypeDoc