Class StiVariablesCollection

Hierarchy

CollectionBase<StiVariable>
- StiVariablesCollection

Implements

Index

Properties

list

Accessors

count
length

Properties

list

list: StiVariable[] = []

Accessors

count

get count(): number

Inherited from CollectionBase.count

Gets the number of elements contained in the CollectionBase instance.

Returns number

length

get length(): number

Inherited from CollectionBase.length

Returns number

Methods

add

add(variable: StiVariable): void

Overrides CollectionBase.add

Parameters
- variable: StiVariable
Returns void

addRange

addRange(variables: StiVariablesCollection): void

Overrides CollectionBase.addRange

Parameters
- variables: StiVariablesCollection
Returns void

clear

clear(): void

Implementation of ICollection.clear

Inherited from CollectionBase.clear

Removes all objects from the CollectionBase instance.

Returns void

clone

clone(): any

Implementation of ICloneable.clone

Returns any

compare

compare(x: StiVariable, y: StiVariable): number

Parameters
- x: StiVariable
- y: StiVariable
Returns number

contains

contains(name: string): boolean

Overrides CollectionBase.contains

Parameters
- name: string
Returns boolean

containsCategory

containsCategory(name: string): boolean

Parameters
- name: string
Returns boolean

getByIndex

getByIndex(index: number): StiVariable

Implementation of ICollection.getByIndex

Inherited from CollectionBase.getByIndex

Parameters
- index: number
Returns StiVariable

getByName

getByName(name: string): StiVariable

Parameters
- name: string
Returns StiVariable

getFirstCategoryIndex

getFirstCategoryIndex(category: string): number

Parameters
- category: string
Returns number

getLastCategoryIndex

getLastCategoryIndex(category: string): number

Parameters
- category: string
Returns number

getVariablesCount

getVariablesCount(category: string): number

Parameters
- category: string
Returns number

implements

implements(): any[]

Returns any[]

indexOf

indexOf(data: string | StiVariable): number

Overrides CollectionBase.indexOf

Parameters
- data: string | StiVariable
Returns number

insert

insert(index: number, value: StiVariable): void

Inherited from CollectionBase.insert

Parameters
- index: number
- value: StiVariable
Returns void

loadFromJsonObject

loadFromJsonObject(jObject: StiJson, report: StiReport): void

Parameters
- jObject: StiJson
- report: StiReport
Returns void

loadFromXml

loadFromXml(xmlNode: XmlNode, report: StiReport): void

Parameters
- xmlNode: XmlNode
- report: StiReport
Returns void

moveCategoryTo

moveCategoryTo(fromCategory: string, toCategory: string): void

Parameters
- fromCategory: string
- toCategory: string
Returns void

remove

remove(data: string | StiVariable): void

Overrides CollectionBase.remove

Parameters
- data: string | StiVariable
Returns void

removeAt

removeAt(index: number): void

Implementation of ICollection.removeAt

Inherited from CollectionBase.removeAt

Parameters
- index: number
Returns void

removeCategory

removeCategory(category: string): void

Parameters
- category: string
Returns void

renameCategory

renameCategory(oldName: string, newName: string): void

Parameters
- oldName: string
- newName: string
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Parameters
- mode: StiJsonSaveMode
Returns StiJson

setByIndex

setByIndex(index: number, value: StiVariable): void

Inherited from CollectionBase.setByIndex

Parameters
- index: number
- value: StiVariable
Returns void

setByName

setByName(name: string, value: StiVariable): void

Parameters
- name: string
- value: StiVariable
Returns void

sort

sort(order?: StiSortOrder): void

Parameters
- Default value order: StiSortOrder = StiSortOrder.Asc
Returns void

toCast

toCast<C>(): C[]

Implementation of ICollection.toCast

Inherited from CollectionBase.toCast

Type parameters
- C
Returns C[]

toList

toList(): List<StiVariable>

Inherited from CollectionBase.toList

Returns List<StiVariable>

Generated using TypeDoc