Class StiPagesCollection

Hierarchy

CollectionBase<StiPage>
- StiPagesCollection

Implements

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new StiPagesCollection(report: StiReport, originalPages?: StiPagesCollection): StiPagesCollection

Parameters
- report: StiReport
- Default value originalPages: StiPagesCollection = null
Returns StiPagesCollection

Properties

cacheMode

cacheMode: boolean = false

canUseCacheMode

canUseCacheMode: boolean = false

list

list: StiPage[] = []

notCachedPages

notCachedPages: StiPage[] = null

report

report: StiReport

Accessors

containsDashboards

get containsDashboards(): boolean

Returns boolean

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(page: StiPage): void

Overrides CollectionBase.add

Parameters
- page: StiPage
Returns void

addRange

addRange(data: StiPage[] | CollectionBase<StiPage>): void

Inherited from CollectionBase.addRange

Parameters
- data: StiPage[] | CollectionBase<StiPage>
Returns void

addV2Internal

addV2Internal(page: StiPage): void

Parameters
- page: StiPage
Returns void

clear

clear(): void

Implementation of ICollection.clear

Inherited from CollectionBase.clear

Removes all objects from the CollectionBase instance.

Returns void

clearAllStates

clearAllStates(): void

Implementation of IStiStateSaveRestore.clearAllStates

Returns void

contains

contains(item: StiPage | any): boolean

Inherited from CollectionBase.contains

Parameters
- item: StiPage | any
Returns boolean

getByIndex

getByIndex(index: number): StiPage

Implementation of ICollection.getByIndex

Inherited from CollectionBase.getByIndex

Parameters
- index: number
Returns StiPage

getByName

getByName(name: string): StiPage

Parameters
- name: string
Returns StiPage

getComponentByName

getComponentByName(componentName: string): StiComponent

Parameters
- componentName: string
Returns StiComponent

getPage

getPage(page: StiPage): StiPage

Parameters
- page: StiPage
Returns StiPage

getPageWithoutCache

getPageWithoutCache(pageIndex: number): StiPage

Parameters
- pageIndex: number
Returns StiPage

implements

implements(): any[]

Returns any[]

indexOf

indexOf(item: StiPage): number

Inherited from CollectionBase.indexOf

Parameters
- item: StiPage
Returns number

insert

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

Inherited from CollectionBase.insert

Parameters
- index: number
- value: StiPage
Returns void

isNotSavedPage

isNotSavedPage(page: StiPage): boolean

Parameters
- page: StiPage
Returns boolean

loadFromJsonObject

loadFromJsonObject(jObject: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Parameters
- jObject: StiJson
Returns void

loadFromXml

loadFromXml(xmlNode: XmlNode): void

Parameters
- xmlNode: XmlNode
Returns void

markPageAsNotSaved

markPageAsNotSaved(page: StiPage): void

Parameters
- page: StiPage
Returns void

remove

remove(page: StiPage): any
remove(startIndex: number, endCount: number): any

Overrides CollectionBase.remove

Parameters
- page: StiPage
Returns any
Overrides CollectionBase.remove

Parameters
- startIndex: number
- endCount: number
Returns any

removeAt

removeAt(index: number): void

Implementation of ICollection.removeAt

Inherited from CollectionBase.removeAt

Parameters
- index: number
Returns void

restoreState

restoreState(stateName: string): void

Implementation of IStiStateSaveRestore.restoreState

Parameters
- stateName: string
Returns void

savePage

savePage(page: StiPage): void

Parameters
- page: StiPage
Returns void

saveState

saveState(stateName: string): void

Implementation of IStiStateSaveRestore.saveState

Parameters
- stateName: string
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

setByIndex

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

Inherited from CollectionBase.setByIndex

Parameters
- index: number
- value: StiPage
Returns void

setByName

setByName(name: string, page: StiPage): void

Parameters
- name: string
- page: StiPage
Returns void

toCast

toCast<C>(): C[]

Implementation of ICollection.toCast

Inherited from CollectionBase.toCast

Type parameters
- C
Returns C[]

toList

toList(): List<StiPage>

Inherited from CollectionBase.toList

Returns List<StiPage>

Generated using TypeDoc