Class SearchableParameterList

Searchable parameters list. Container for different types of values.

Hierarchy (View Summary)

ParameterList
- SearchableParameterList

Index

Constructors

Accessors

first isEmpty isNotEmpty last length mapId pointerId

Constructors

constructor

new SearchableParameterList(
    id: any,
    mapId: number,
    className?: string,
    initializer?: (data: any, mapId: number) => GemParameter,
): SearchableParameterList
Internal
Parameters
- id: any
- mapId: number
- className: string = 'SearchableParameterList'
- initializer: (data: any, mapId: number) => GemParameter = ...
Returns SearchableParameterList
Overrides ParameterList.constructor
- Defined in core/parameters.ts:379

Accessors

first

get first(): T
Returns T
Inherited from ParameterList.first
- Defined in core/types.ts:774

isEmpty

get isEmpty(): boolean
Returns boolean
Inherited from ParameterList.isEmpty
- Defined in core/types.ts:766

isNotEmpty

get isNotEmpty(): boolean
Returns boolean
Inherited from ParameterList.isNotEmpty
- Defined in core/types.ts:770

last

get last(): T
Returns T
Inherited from ParameterList.last
- Defined in core/types.ts:781

length

get length(): number
Returns number
Inherited from ParameterList.length
- Defined in core/types.ts:762

mapId

get mapId(): number
Returns number
Inherited from ParameterList.mapId
- Defined in core/types.ts:703

pointerId

get pointerId(): any
Returns any
Inherited from ParameterList.pointerId
- Defined in core/types.ts:700

Methods

[iterator]

"[iterator]"(): Iterator<GemParameter>
Returns Iterator<GemParameter>
Inherited from ParameterList.[iterator]
- Defined in core/types.ts:731

add

add(parameter: GemParameter): void
Adds a parameter to the list
Parameters
- parameter: GemParameter
  The parameter to add
Returns void
Inherited from ParameterList.add
- Defined in core/parameters.ts:324

asJson

asJson(): Record<string, any>[]
Returns the parameters as a deeply structured JSON list. Each entry includes the key, value, and, if available, name. The value is formatted according to its type. Only parameters with non-null key, value, and type are included.

Returns Record<string, any>[]
Inherited from ParameterList.asJson
- Defined in core/parameters.ts:334

at

at(position: number): GemParameter
Parameters
- position: number
Returns GemParameter
Inherited from ParameterList.at
- Defined in core/types.ts:746

contains

contains(element: GemParameter): boolean
Parameters
- element: GemParameter
Returns boolean
Inherited from ParameterList.contains
- Defined in core/types.ts:788

dispose

dispose(): void
Returns void
Overrides ParameterList.dispose
- Defined in core/parameters.ts:427

elementAt

elementAt(index: number): GemParameter
Parameters
- index: number
Returns GemParameter
Inherited from ParameterList.elementAt
- Defined in core/types.ts:797

every

every(predicate: (item: GemParameter) => boolean): boolean
Parameters
- predicate: (item: GemParameter) => boolean
Returns boolean
Inherited from ParameterList.every
- Defined in core/types.ts:848

filter

filter(predicate: (item: GemParameter) => boolean): GemParameter[]
Parameters
- predicate: (item: GemParameter) => boolean
Returns GemParameter[]
Inherited from ParameterList.filter
- Defined in core/types.ts:830

find

find(predicate: (item: GemParameter) => boolean): GemParameter | undefined
Parameters
- predicate: (item: GemParameter) => boolean
Returns GemParameter | undefined
Inherited from ParameterList.find
- Defined in core/types.ts:866

findAll

findAll(key: string): ParameterList
Search for all occurrences of a parameter identifier in a list.
Parameters
- key: string
  Parameter key as string
Returns ParameterList
The list of parameters. Is empty if there are no matches.

Throws
An exception if it fails.
- Defined in core/parameters.ts:406

findByName

findByName(key: string): string
Search for first occurrence of a parameter identifier and get the name of the parameter.
Parameters
- key: string
  Parameter key as string
Returns string
The name of the parameter if found. Empty string otherwise.

Throws
An exception if it fails.
- Defined in core/parameters.ts:395

findIndex

findIndex(predicate: (item: GemParameter) => boolean): number
Parameters
- predicate: (item: GemParameter) => boolean
Returns number
Inherited from ParameterList.findIndex
- Defined in core/types.ts:875

findParameter

findParameter(key: string): GemParameter
Search for first occurrence of a parameter identifier.
Parameters
- key: string
  Parameter key as string
Returns GemParameter
GemParameter object. If not found then GemParameter.key is an empty string.

Throws
An exception if it fails.
- Defined in core/parameters.ts:417

forEach

forEach(callback: (item: GemParameter) => void): void
Parameters
- callback: (item: GemParameter) => void
Returns void
Inherited from ParameterList.forEach
- Defined in core/types.ts:816

join

join(separator?: string): string
Parameters
- separator: string = ''
Returns string
Inherited from ParameterList.join
- Defined in core/types.ts:886

map

map<R>(transform: (item: GemParameter) => R): R[]
Type Parameters
- R
Parameters
- transform: (item: GemParameter) => R
Returns R[]
Inherited from ParameterList.map
- Defined in core/types.ts:822

reduce

reduce<R>(
combine: (accumulator: R, item: GemParameter) => R,
initialValue: R,
): R
Type Parameters
- R
Parameters
- combine: (accumulator: R, item: GemParameter) => R
- initialValue: R
Returns R
Inherited from ParameterList.reduce
- Defined in core/types.ts:840

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from ParameterList.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

size

size(): number
Returns number
Inherited from ParameterList.size
- Defined in core/types.ts:741

some

some(predicate: (item: GemParameter) => boolean): boolean
Parameters
- predicate: (item: GemParameter) => boolean
Returns boolean
Inherited from ParameterList.some
- Defined in core/types.ts:857

toArray

toArray(): GemParameter[]
Returns GemParameter[]
Inherited from ParameterList.toArray
- Defined in core/types.ts:804

toSet

toSet(): Set<GemParameter>
Returns Set<GemParameter>
Inherited from ParameterList.toSet
- Defined in core/types.ts:812

`Static`create

create(mapId?: number, parameterList?: ParameterList): SearchableParameterList
Creates a new SearchableParameterList instance
Parameters
- mapId: number = 0
- OptionalparameterList: ParameterList
  Optional parameter list to be used for the object initialization. If no value is passed then it will instantiate an empty list.
Returns SearchableParameterList
Overrides ParameterList.create
- Defined in core/parameters.ts:356

`Static`init

init<T>(
    pointerId: any,
    mapId: number,
    className: string,
    initializer: (data: any, mapId: number) => T,
): GemList<T>
Type Parameters
- T
Parameters
- pointerId: any
- mapId: number
- className: string
- initializer: (data: any, mapId: number) => T
Returns GemList<T>
Inherited from ParameterList.init
- Defined in core/types.ts:721