Class StiGaugeElementCollection

Hierarchy

CollectionBase<StiGaugeElement>
- StiGaugeElementCollection

Implements

Index

Constructors

constructor

Properties

list

Accessors

Methods

Constructors

constructor

new StiGaugeElementCollection(scale: StiScaleBase): StiGaugeElementCollection

Parameters
- scale: StiScaleBase
Returns StiGaugeElementCollection

Properties

list

list: StiGaugeElement[] = []

Accessors

count

get count(): number

Inherited from CollectionBase.count

Gets the number of elements contained in the CollectionBase instance.

Returns number

isReadOnly

get isReadOnly(): boolean

Returns boolean

length

get length(): number

Inherited from CollectionBase.length

Returns number

Methods

add

add(element: StiGaugeElement): void

Overrides CollectionBase.add

Parameters
- element: StiGaugeElement
Returns void

addRange

addRange(elements: StiGaugeElement[]): void

Overrides CollectionBase.addRange

Parameters
- elements: StiGaugeElement[]
Returns void

clear

clear(): void

Implementation of ICollection.clear

Inherited from CollectionBase.clear

Removes all objects from the CollectionBase instance.

Returns void

clone

clone(): StiGaugeElementCollection

Implementation of ICloneable.clone

Creates a new object that is a copy of the current instance.

Returns StiGaugeElementCollection

A new object that is a copy of this instance.

contains

contains(item: StiGaugeElement | any): boolean

Inherited from CollectionBase.contains

Parameters
- item: StiGaugeElement | any
Returns boolean

copyTo

copyTo(elements: StiGaugeElement[], arrayIndex: number): void

Parameters
- elements: StiGaugeElement[]
- arrayIndex: number
Returns void

getByIndex

getByIndex(index: number): StiGaugeElement

Implementation of ICollection.getByIndex

Inherited from CollectionBase.getByIndex

Parameters
- index: number
Returns StiGaugeElement

indexOf

indexOf(item: StiGaugeElement): number

Inherited from CollectionBase.indexOf

Parameters
- item: StiGaugeElement
Returns number

insert

insert(index: number, element: StiGaugeElement): void

Overrides CollectionBase.insert

Parameters
- index: number
- element: StiGaugeElement
Returns void

loadFromJsonObject

loadFromJsonObject(jObject: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Parameters
- jObject: StiJson
Returns void

loadFromXml

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

Parameters
- xmlNode: XmlNode
- report: StiReport
Returns void

moveDown

moveDown(element: StiGaugeElement): boolean

Parameters
- element: StiGaugeElement
Returns boolean

moveUp

moveUp(element: StiGaugeElement): boolean

Parameters
- element: StiGaugeElement
Returns boolean

remove

remove(element: StiGaugeElement): boolean

Overrides CollectionBase.remove

Parameters
- element: StiGaugeElement
Returns boolean

removeAt

removeAt(index: number): void

Implementation of ICollection.removeAt

Inherited from CollectionBase.removeAt

Parameters
- index: number
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

setByIndex

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

Overrides CollectionBase.setByIndex

Parameters
- index: number
- value: StiGaugeElement
Returns void

toArray

toArray(): StiGaugeElement[]

Returns StiGaugeElement[]

toCast

toCast<C>(): C[]

Implementation of ICollection.toCast

Inherited from CollectionBase.toCast

Type parameters
- C
Returns C[]

toList

toList(): List<StiGaugeElement>

Inherited from CollectionBase.toList

Returns List<StiGaugeElement>

Generated using TypeDoc