StiPage | main

Hierarchy

StiPanel
- StiPage
  - StiDashboard

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StiPage(report?: StiReport, isSuper?: boolean): StiPage

Overrides StiContainer.constructor

Parameters
- Optional report: StiReport
- Default value isSuper: boolean = false
Returns StiPage

Properties

afterPrintEvent

afterPrintEvent: StiEvent = new StiEvent()

alias

alias: string = ""

beforePrintEvent

beforePrintEvent: StiEvent = new StiEvent()

beginRenderEvent

beginRenderEvent: StiEvent = new StiEvent()

border

border: StiBorder = new StiBorder()

clickEvent

clickEvent: StiEvent = new StiEvent()

collapsedValue

collapsedValue: any = null

collapsingIndex

collapsingIndex: number = 0

collapsingTreePath

collapsingTreePath: string = null

columnBeginRenderEvent

columnBeginRenderEvent: StiEvent = new StiEvent()

columnEndRenderEvent

columnEndRenderEvent: StiEvent = new StiEvent()

columnGaps

columnGaps: number = 0

columnWidth

columnWidth: number = 0

columns

columns: number = 0

componentPlacement

componentPlacement: string = ""

cornerRadius

cornerRadius: StiCornerRadius = null

currentBookmark

currentBookmark: StiBookmark

currentHeightSegment

currentHeightSegment: number

currentPointer

currentPointer: StiBookmark

currentWidthSegment

currentWidthSegment: number

defaultClientRectangle

defaultClientRectangle: Rectangle = new Rectangle(0, 0, 100, 100)

doubleClickEvent

doubleClickEvent: StiEvent = new StiEvent()

drillDownActivated

drillDownActivated: boolean = false

endRenderEvent

endRenderEvent: StiEvent = new StiEvent()

excelSheet

excelSheet: string = ""

excelSheetValue

excelSheetValue: string = null

expressions

expressions: StiAppExpressionCollection = new StiAppExpressionCollection()

Gets the collection of meta tags. Meta tags can be used for storing specific information in report. Meta tags will be saved in report file.

gapAfterLastColumn

gapAfterLastColumn: boolean = true

getBookmarkEvent

getBookmarkEvent: StiEvent = new StiEvent()

getDrillDownReportEvent

getDrillDownReportEvent: StiEvent = new StiEvent()

getExcelSheetEvent

getExcelSheetEvent: StiEvent = new StiEvent()

getHyperlinkEvent

getHyperlinkEvent: StiEvent = new StiEvent()

getPointerEvent

getPointerEvent: StiEvent = new StiEvent()

getTagEvent

getTagEvent: StiEvent = new StiEvent()

getToolTipEvent

getToolTipEvent: StiEvent = new StiEvent()

guid

guid: string = null

icon

icon: number[]

infographicsDisplayRectangle

infographicsDisplayRectangle: RectangleD = new RectangleD(0, 0, 0, 0)

isRendered

isRendered: boolean = false

largeHeight

largeHeight: boolean = false

margins

margins: StiMargins = new StiMargins(39, 39, 39, 39)

mirrorMargins

mirrorMargins: boolean = false

mouseEnterEvent

mouseEnterEvent: StiEvent = new StiEvent()

mouseLeaveEvent

mouseLeaveEvent: StiEvent = new StiEvent()

offsetRectangle

offsetRectangle: RectangleD = RectangleD.empty

onClick

onClick: Function

onDoubleClick

onDoubleClick: Function

onMouseEnter

onMouseEnter: Function

onMouseLeave

onMouseLeave: Function

paperSourceOfFirstPage

paperSourceOfFirstPage: string = ""

paperSourceOfOtherPages

paperSourceOfOtherPages: string = ""

parentBookmark

parentBookmark: StiBookmark

parentComponentIsBand

parentComponentIsBand: boolean = false

parentComponentIsCrossBand

parentComponentIsCrossBand: boolean = false

parentPointer

parentPointer: StiBookmark

pointerValue

pointerValue: any = null

printHeadersFootersFromPreviousPage

printHeadersFootersFromPreviousPage: boolean = false

printOn

printOn: StiPrintOnType = StiPrintOnType.AllPages

printOnPreviousPage

printOnPreviousPage: boolean = false

renderingEvent

renderingEvent: StiEvent = new StiEvent()

reportUnit

reportUnit: StiUnit = null

resetPageNumber

resetPageNumber: boolean = false

rightToLeft

rightToLeft: boolean = false

stopBeforePrint

stopBeforePrint: number = 0

stretchToPrintArea

stretchToPrintArea: boolean = false

unlimitedBreakable

unlimitedBreakable: boolean = true

unlimitedHeight

unlimitedHeight: boolean = false

unlimitedWidth

unlimitedWidth: boolean = true

Static Protected propertyBlocked

propertyBlocked: string = Math.random().toString().substr(2)

Static Protected propertyCanBreak

propertyCanBreak: string = Math.random().toString().substr(2)

Static Protected propertyComponentStyle

propertyComponentStyle: string = Math.random().toString().substr(2)

Static Protected propertyDockable

propertyDockable: string = Math.random().toString().substr(2)

Static Protected propertyLinked

propertyLinked: string = Math.random().toString().substr(2)

Static Protected propertyLocked

propertyLocked: string = Math.random().toString().substr(2)

Static Protected propertyPlaceOnToolbox

propertyPlaceOnToolbox: string = Math.random().toString().substr(2)

Static Protected propertyRestrictions

propertyRestrictions: string = Math.random().toString().substr(2)

Accessors

anchor

get anchor(): StiAnchorMode
set anchor(value: StiAnchorMode): void

Inherited from StiComponent.anchor

Returns StiAnchorMode
Inherited from StiComponent.anchor

Parameters
- value: StiAnchorMode
Returns void

blocked

get blocked(): boolean
set blocked(value: boolean): void

Inherited from StiContainer.blocked

Returns boolean
Inherited from StiContainer.blocked

Parameters
- value: boolean
Returns void

bookmark

get bookmark(): string
set bookmark(value: string): void

Inherited from StiComponent.bookmark

Returns string
Inherited from StiComponent.bookmark

Parameters
- value: string
Returns void

bookmarkValue

get bookmarkValue(): any
set bookmarkValue(value: any): void

Inherited from StiComponent.bookmarkValue

Returns any
Inherited from StiComponent.bookmarkValue

Parameters
- value: any
Returns void

bottom

get bottom(): number

Overrides StiComponent.bottom

Returns number

brush

get brush(): StiBrush
set brush(value: StiBrush): void

Inherited from StiContainer.brush

Returns StiBrush
Inherited from StiContainer.brush

Parameters
- value: StiBrush
Returns void

cacheGuid

get cacheGuid(): string
set cacheGuid(value: string): void

Returns string
Parameters
- value: string
Returns void

canBreak

get canBreak(): boolean
set canBreak(value: boolean): void

Inherited from StiContainer.canBreak

Returns boolean
Inherited from StiContainer.canBreak

Parameters
- value: boolean
Returns void

canGrow

get canGrow(): boolean
set canGrow(value: boolean): void

Inherited from StiComponent.canGrow

Returns boolean
Inherited from StiComponent.canGrow

Parameters
- value: boolean
Returns void

canShrink

get canShrink(): boolean
set canShrink(value: boolean): void

Inherited from StiComponent.canShrink

Returns boolean
Inherited from StiComponent.canShrink

Parameters
- value: boolean
Returns void

clientRectangle

get clientRectangle(): RectangleD
set clientRectangle(value: RectangleD): void

Overrides StiComponent.clientRectangle

Returns RectangleD
Overrides StiComponent.clientRectangle

Parameters
- value: RectangleD
Returns void

componentStyle

get componentStyle(): string
set componentStyle(value: string): void

Inherited from StiComponent.componentStyle

Returns string
Inherited from StiComponent.componentStyle

Parameters
- value: string
Returns void

componentType

get componentType(): StiComponentType

Inherited from StiContainer.componentType

Overrides StiComponent.componentType

Returns StiComponentType

components

get components(): StiComponentsCollection
set components(value: StiComponentsCollection): void

Inherited from StiContainer.components

Returns StiComponentsCollection
Inherited from StiContainer.components

Parameters
- value: StiComponentsCollection
Returns void

conditions

get conditions(): StiConditionsCollection
set conditions(value: StiConditionsCollection): void

Inherited from StiComponent.conditions

Returns StiConditionsCollection
Inherited from StiComponent.conditions

Parameters
- value: StiConditionsCollection
Returns void

containerInfo

get containerInfo(): StiContainerInfo

Inherited from StiContainer.containerInfo

Returns StiContainerInfo

displayRectangle

get displayRectangle(): RectangleD
set displayRectangle(value: RectangleD): void

Inherited from StiComponent.displayRectangle

Returns RectangleD
Inherited from StiComponent.displayRectangle

Parameters
- value: RectangleD
Returns void

dockStyle

get dockStyle(): StiDockStyle
set dockStyle(value: StiDockStyle): void

Inherited from StiComponent.dockStyle

Returns StiDockStyle
Inherited from StiComponent.dockStyle

Parameters
- value: StiDockStyle
Returns void

dockable

get dockable(): boolean
set dockable(value: boolean): void

Inherited from StiComponent.dockable

Returns boolean
Inherited from StiComponent.dockable

Parameters
- value: boolean
Returns void

drillDownParameters

get drillDownParameters(): any[]
set drillDownParameters(value: any[]): void

Inherited from StiComponent.drillDownParameters

Returns any[]
Inherited from StiComponent.drillDownParameters

Parameters
- value: any[]
Returns void

enabled

get enabled(): boolean
set enabled(value: boolean): void

Inherited from StiComponent.enabled

Returns boolean
Inherited from StiComponent.enabled

Parameters
- value: boolean
Returns void

gridSize

get gridSize(): number

Returns number

growToHeight

get growToHeight(): boolean
set growToHeight(value: boolean): void

Inherited from StiComponent.growToHeight

Returns boolean
Inherited from StiComponent.growToHeight

Parameters
- value: boolean
Returns void

hasSelected

get hasSelected(): boolean

Inherited from StiContainer.hasSelected

Returns boolean

height

get height(): number
set height(value: number): void

Inherited from StiComponent.height

Returns number
Inherited from StiComponent.height

Parameters
- value: number
Returns void

highlightState

get highlightState(): StiHighlightState
set highlightState(value: StiHighlightState): void

Inherited from StiComponent.highlightState

Returns StiHighlightState
Inherited from StiComponent.highlightState

Parameters
- value: StiHighlightState
Returns void

hyperlink

get hyperlink(): string
set hyperlink(value: string): void

Inherited from StiComponent.hyperlink

Returns string
Inherited from StiComponent.hyperlink

Parameters
- value: string
Returns void

hyperlinkValue

get hyperlinkValue(): any
set hyperlinkValue(value: any): void

Inherited from StiComponent.hyperlinkValue

Returns any
Inherited from StiComponent.hyperlinkValue

Parameters
- value: any
Returns void

ignoreNamingRule

get ignoreNamingRule(): boolean
set ignoreNamingRule(value: boolean): void

Inherited from StiComponent.ignoreNamingRule

Returns boolean
Inherited from StiComponent.ignoreNamingRule

Parameters
- value: boolean
Returns void

inherited

get inherited(): boolean
set inherited(value: boolean): void

Inherited from StiComponent.inherited

Returns boolean
Inherited from StiComponent.inherited

Parameters
- value: boolean
Returns void

interaction

get interaction(): StiInteraction
set interaction(value: StiInteraction): void

Inherited from StiComponent.interaction

Returns StiInteraction
Inherited from StiComponent.interaction

Parameters
- value: StiInteraction
Returns void

isAutomaticDock

get isAutomaticDock(): boolean

Overrides StiComponent.isAutomaticDock

Returns boolean

isCross

get isCross(): boolean

Inherited from StiComponent.isCross

Returns boolean

isDashboard

get isDashboard(): boolean

Returns boolean

isDesigning

get isDesigning(): boolean

Inherited from StiComponent.isDesigning

Returns boolean

isEnabled

get isEnabled(): boolean

Inherited from StiComponent.isEnabled

Returns boolean

isExporting

get isExporting(): boolean

Inherited from StiComponent.isExporting

Returns boolean

isPage

get isPage(): boolean

Returns boolean

isPrinting

get isPrinting(): boolean

Inherited from StiComponent.isPrinting

Returns boolean

isSelected

get isSelected(): boolean
set isSelected(value: boolean): void

Inherited from StiComponent.isSelected

Returns boolean
Inherited from StiComponent.isSelected

Parameters
- value: boolean
Returns void

largeHeightAutoFactor

get largeHeightAutoFactor(): number
set largeHeightAutoFactor(value: number): void

Returns number
Parameters
- value: number
Returns void

largeHeightFactor

get largeHeightFactor(): number
set largeHeightFactor(value: number): void

Returns number
Parameters
- value: number
Returns void

left

get left(): number
set left(value: number): void

Overrides StiComponent.left

Returns number
Overrides StiComponent.left

Parameters
- value: number
Returns void

linked

get linked(): boolean
set linked(value: boolean): void

Overrides StiComponent.linked

Returns boolean
Overrides StiComponent.linked

Parameters
- value: boolean
Returns void

localizedCategory

get localizedCategory(): string

Inherited from StiBase.localizedCategory

Returns string

localizedName

get localizedName(): string

Inherited from StiBase.localizedName

Returns string

locked

get locked(): boolean
set locked(value: boolean): void

Overrides StiComponent.locked

Returns boolean
Overrides StiComponent.locked

Parameters
- value: boolean
Returns void

maxSize

get maxSize(): SizeD
set maxSize(value: SizeD): void

Inherited from StiComponent.maxSize

Returns SizeD
Inherited from StiComponent.maxSize

Parameters
- value: SizeD
Returns void

minSize

get minSize(): SizeD
set minSize(value: SizeD): void

Inherited from StiComponent.minSize

Returns SizeD
Inherited from StiComponent.minSize

Parameters
- value: SizeD
Returns void

name

get name(): string
set name(value: string): void

Inherited from StiBase.name

Gets or sets a component name.

Returns string
Inherited from StiBase.name

Gets or sets a component name.

Parameters
- value: string
Returns void

numberOfCopies

get numberOfCopies(): number
set numberOfCopies(value: number): void

Returns number
Parameters
- value: number
Returns void

orientation

get orientation(): StiPageOrientation
set orientation(value: StiPageOrientation): void

Returns StiPageOrientation
Parameters
- value: StiPageOrientation
Returns void

pageHeight

get pageHeight(): number
set pageHeight(value: number): void

Returns number
Parameters
- value: number
Returns void

pageInfo

get pageInfo(): StiPageInfo

Returns StiPageInfo

pageWidth

get pageWidth(): number
set pageWidth(value: number): void

Returns number
Parameters
- value: number
Returns void

paperSize

get paperSize(): PaperKind
set paperSize(value: PaperKind): void

Returns PaperKind
Parameters
- value: PaperKind
Returns void

parent

get parent(): StiContainer
set parent(value: StiContainer): void

Overrides StiComponent.parent

Returns StiContainer
Overrides StiComponent.parent

Parameters
- value: StiContainer
Returns void

placeOnToolbox

get placeOnToolbox(): boolean
set placeOnToolbox(value: boolean): void

Inherited from StiComponent.placeOnToolbox

Returns boolean
Inherited from StiComponent.placeOnToolbox

Parameters
- value: boolean
Returns void

pointer

get pointer(): string
set pointer(value: string): void

Inherited from StiComponent.pointer

Returns string
Inherited from StiComponent.pointer

Parameters
- value: string
Returns void

printable

get printable(): boolean
set printable(value: boolean): void

Overrides StiComponent.printable

Returns boolean
Overrides StiComponent.printable

Parameters
- value: boolean
Returns void

priority

get priority(): number

Inherited from StiContainer.priority

Overrides StiComponent.priority

Returns number

properties

get properties(): StiRepositoryItems
set properties(value: StiRepositoryItems): void

Inherited from StiService.properties

Returns StiRepositoryItems
Inherited from StiService.properties

Parameters
- value: StiRepositoryItems
Returns void

renderedCount

get renderedCount(): number
set renderedCount(value: number): void

Inherited from StiComponent.renderedCount

Returns number
Inherited from StiComponent.renderedCount

Parameters
- value: number
Returns void

report

get report(): StiReport
set report(value: StiReport): void

Overrides StiComponent.report

Returns StiReport
Overrides StiComponent.report

Parameters
- value: StiReport
Returns void

restrictions

get restrictions(): StiRestrictions
set restrictions(value: StiRestrictions): void

Inherited from StiComponent.restrictions

Returns StiRestrictions
Inherited from StiComponent.restrictions

Parameters
- value: StiRestrictions
Returns void

right

get right(): number

Overrides StiComponent.right

Returns number

segmentPerHeight

get segmentPerHeight(): number
set segmentPerHeight(value: number): void

Returns number
Parameters
- value: number
Returns void

segmentPerWidth

get segmentPerWidth(): number
set segmentPerWidth(value: number): void

Returns number
Parameters
- value: number
Returns void

selectRectangle

get selectRectangle(): RectangleD
set selectRectangle(value: RectangleD): void

Inherited from StiComponent.selectRectangle

Returns RectangleD
Inherited from StiComponent.selectRectangle

Parameters
- value: RectangleD
Returns void

serviceCategory

get serviceCategory(): string

Inherited from StiService.serviceCategory

Gets a service category.

Returns string

serviceEnabled

get serviceEnabled(): boolean
set serviceEnabled(value: boolean): void

Inherited from StiService.serviceEnabled

Gets or sets the value whether a service is enabled or not.

Returns boolean
Inherited from StiService.serviceEnabled

Gets or sets the value whether a service is enabled or not.

Parameters
- value: boolean
Returns void

serviceInfo

get serviceInfo(): string

Inherited from StiService.serviceInfo

Gets a service description.

Returns string

serviceName

get serviceName(): string

Inherited from StiService.serviceName

Gets a service name.

Returns string

serviceType

get serviceType(): Type

Inherited from StiService.serviceType

Gets a service type.

Returns Type

shift

get shift(): boolean
set shift(value: boolean): void

Inherited from StiComponent.shift

Returns boolean
Inherited from StiComponent.shift

Parameters
- value: boolean
Returns void

shiftMode

get shiftMode(): StiShiftMode
set shiftMode(value: StiShiftMode): void

Overrides StiComponent.shiftMode

Returns StiShiftMode
Overrides StiComponent.shiftMode

Parameters
- value: StiShiftMode
Returns void

skip

get skip(): boolean
set skip(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

states

get states(): StiStatesManager

Inherited from StiComponent.states

Returns StiStatesManager

tagValue

get tagValue(): any
set tagValue(value: any): void

Inherited from StiComponent.tagValue

Returns any
Inherited from StiComponent.tagValue

Parameters
- value: any
Returns void

titleBeforeHeader

get titleBeforeHeader(): boolean
set titleBeforeHeader(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

toolTip

get toolTip(): string
set toolTip(value: string): void

Inherited from StiComponent.toolTip

Returns string
Inherited from StiComponent.toolTip

Parameters
- value: string
Returns void

toolTipValue

get toolTipValue(): any
set toolTipValue(value: any): void

Inherited from StiComponent.toolTipValue

Returns any
Inherited from StiComponent.toolTipValue

Parameters
- value: any
Returns void

toolboxCategory

get toolboxCategory(): StiToolboxCategory

Inherited from StiContainer.toolboxCategory

Returns StiToolboxCategory

toolboxPosition

get toolboxPosition(): number

Inherited from StiContainer.toolboxPosition

Overrides StiComponent.toolboxPosition

Returns number

top

get top(): number
set top(value: number): void

Overrides StiComponent.top

Returns number
Overrides StiComponent.top

Parameters
- value: number
Returns void

unit

get unit(): StiUnit

Returns StiUnit

useParentStyles

get useParentStyles(): boolean
set useParentStyles(value: boolean): void

Inherited from StiComponent.useParentStyles

Returns boolean
Inherited from StiComponent.useParentStyles

Parameters
- value: boolean
Returns void

watermark

get watermark(): StiWatermark
set watermark(value: StiWatermark): void

Returns StiWatermark
Parameters
- value: StiWatermark
Returns void

watermarkStyle

get watermarkStyle(): string
set watermarkStyle(value: string): void

Returns string
Parameters
- value: string
Returns void

width

get width(): number
set width(value: number): void

Inherited from StiComponent.width

Returns number
Inherited from StiComponent.width

Parameters
- value: number
Returns void

zoom

get zoom(): number

Returns number

Methods

alignTo

alignTo(aligning: StiAligning): void

Inherited from StiContainer.alignTo

Parameters
- aligning: StiAligning
Returns void

allowDelete

allowDelete(): boolean

Inherited from StiComponent.allowDelete

Returns boolean

allowPrintOn

allowPrintOn(): boolean

Inherited from StiComponent.allowPrintOn

Returns boolean

applyConditions

applyConditions(sender: StiComponent, conditions: object[], e: EventArgs): void

Inherited from StiComponent.applyConditions

Parameters
- sender: StiComponent
- conditions: object[]
- e: EventArgs
Returns void

as

as<T>(type: object | Interface<T>): T

Inherited from StiService.as

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns T

break

break(dividedComponent: StiComponent, devideFactor: number, REFdivideLine: any): boolean

Implementation of IStiBreakable.break

Inherited from StiContainer.break

Parameters
- dividedComponent: StiComponent
- devideFactor: number
- REFdivideLine: any
Returns boolean

bringToFront

bringToFront(): void

Inherited from StiContainer.bringToFront

Returns void

canContainIn

canContainIn(component: StiComponent): boolean

Inherited from StiComponent.canContainIn

Parameters
- component: StiComponent
Returns boolean

changePosition

changePosition(delta: Rectangle): void

Inherited from StiContainer.changePosition

Parameters
- delta: Rectangle
Returns void

checkForParentComponent

checkForParentComponent(comp: StiComponent): boolean

Inherited from StiComponent.checkForParentComponent

Parameters
- comp: StiComponent
Returns boolean

checkLargeHeight

checkLargeHeight(needFullCalculation?: boolean): void

Inherited from StiContainer.checkLargeHeight

Parameters
- Default value needFullCalculation: boolean = false
Returns void

clearAllStates

clearAllStates(): void

Implementation of IStiStateSaveRestore.clearAllStates

Inherited from StiComponent.clearAllStates

Returns void

clearContents

clearContents(): void

Inherited from StiComponent.clearContents

Returns void

clearPage

clearPage(): void

Returns void

clone

clone(cloneProperties?: boolean, cloneComponents?: boolean): any

Overrides StiContainer.clone

Parameters
- Default value cloneProperties: boolean = true
- Default value cloneComponents: boolean = true
Returns any

componentToPage

componentToPage(value: PointD | RectangleD): any

Inherited from StiComponent.componentToPage

Parameters
- value: PointD | RectangleD
Returns any

Protected construct

construct(report?: StiReport | any): void

Overrides StiContainer.construct

Parameters
- Optional report: StiReport | any
Returns void

containerToPage

containerToPage(value: Point | Rectangle): any

Inherited from StiContainer.containerToPage

Parameters
- value: Point | Rectangle
Returns any

convert

convert(oldUnit: StiUnit, newUnit: StiUnit, isReportSnapshot?: boolean): void

Overrides StiContainer.convert

Parameters
- oldUnit: StiUnit
- newUnit: StiUnit
- Default value isReportSnapshot: boolean = false
Returns void

convertFromHInches

convertFromHInches(unit: StiUnit, value: number): number

Parameters
- unit: StiUnit
- value: number
Returns number

convertFromHInchesRect

convertFromHInchesRect(unit: StiUnit, rect: RectangleD): RectangleD

Parameters
- unit: StiUnit
- rect: RectangleD
Returns RectangleD

convertToHInches

convertToHInches(unit: StiUnit, value: number): number

Parameters
- unit: StiUnit
- value: number
Returns number

correct

correct(onlySelect?: boolean): void

Inherited from StiContainer.correct

Parameters
- Default value onlySelect: boolean = false
Returns void

correct2

correct2(onlySelect: boolean): void

Inherited from StiContainer.correct2

Parameters
- onlySelect: boolean
Returns void

disposeImagesAndClearComponents

disposeImagesAndClearComponents(): void

Dispose all images and clear components list. Used in ReportCacheMode.

Returns void

doBookmark

doBookmark(): boolean

Inherited from StiComponent.doBookmark

Returns boolean

doPointer

doPointer(createNewGuid?: boolean): void

Inherited from StiComponent.doPointer

Parameters
- Default value createNewGuid: boolean = true
Returns void

dockToContainer

dockToContainer(): void

Inherited from StiComponent.dockToContainer

Returns void

dockToContainer2

dockToContainer2(rect: RectangleD): RectangleD

Inherited from StiComponent.dockToContainer2

Parameters
- rect: RectangleD
Returns RectangleD

getActualSize

getActualSize(isFirstPass?: boolean, REFneedSecondPass?: any): SizeD

Inherited from StiContainer.getActualSize

Overrides StiComponent.getActualSize

Parameters
- Default value isFirstPass: boolean = false
- Default value REFneedSecondPass: any = { ref: false }
Returns SizeD

getAllStrings

getAllStrings(): string[]

Implementation of IStiGlobalizationProvider.getAllStrings

Returns array of the property names which can be localized.

Returns string[]

getApp

getApp(): IStiApp

Implementation of IStiReportComponent.getApp

Inherited from StiComponent.getApp

Returns IStiApp

getBottom

getBottom(): number

Inherited from StiComponent.getBottom

Returns number

getCanGrow

getCanGrow(): boolean

Inherited from StiComponent.getCanGrow

Returns boolean

getCanShrink

getCanShrink(): boolean

Inherited from StiComponent.getCanShrink

Returns boolean

getColumnWidth

getColumnWidth(): number

Inherited from StiPanel.getColumnWidth

Returns number

getComponentStyle

getComponentStyle(): string

Inherited from StiComponent.getComponentStyle

Returns string

getComponentStyle2

getComponentStyle2(): StiBaseStyle

Inherited from StiComponent.getComponentStyle2

Returns StiBaseStyle

getComponents

getComponents(): StiComponentsCollection

Inherited from StiContainer.getComponents

Returns StiComponentsCollection

getComponents2

getComponents2(REFcomps: any): void

Inherited from StiContainer.getComponents2

Parameters
- REFcomps: any
Returns void

getComponentsCount

getComponentsCount(): number

Returns number

getComponentsList

getComponentsList(): StiComponent[]

Inherited from StiContainer.getComponentsList

Returns StiComponent[]

getConditions

getConditions(): StiConditionsCollection

Inherited from StiComponent.getConditions

Returns StiConditionsCollection

getContainer

getContainer(): StiContainer

Inherited from StiComponent.getContainer

Returns StiContainer

getContainerInRect

getContainerInRect(rect: Rectangle, component: StiComponent): StiContainer

Inherited from StiContainer.getContainerInRect

Parameters
- rect: Rectangle
- component: StiComponent
Returns StiContainer

getContainerInRect2

getContainerInRect2(rect: Rectangle, component: StiComponent, hash: Hashtable): StiContainer

Inherited from StiContainer.getContainerInRect2

Parameters
- rect: Rectangle
- component: StiComponent
- hash: Hashtable
Returns StiContainer

getDataBand

getDataBand(): StiDataBand

Inherited from StiComponent.getDataBand

Returns StiDataBand

getDisplayRectangle

getDisplayRectangle(): RectangleD

Overrides StiComponent.getDisplayRectangle

Returns RectangleD

getDisplayRectangle2

getDisplayRectangle2(): RectangleD

Inherited from StiComponent.getDisplayRectangle2

Returns RectangleD

getDockRegion

getDockRegion(parent: StiComponent, useColumns?: boolean): RectangleD

Inherited from StiComponent.getDockRegion

Parameters
- parent: StiComponent
- Default value useColumns: boolean = true
Returns RectangleD

getDockStyle

getDockStyle(): StiDockStyle

Inherited from StiComponent.getDockStyle

Returns StiDockStyle

getFonts

getFonts(): Font[]

Implementation of IStiGetFonts.getFonts

Inherited from StiContainer.getFonts

Overrides StiComponent.getFonts

Returns Font[]

getGroupHeaderBand

getGroupHeaderBand(): StiGroupHeaderBand

Inherited from StiComponent.getGroupHeaderBand

Returns StiGroupHeaderBand

getGrowToHeight

getGrowToHeight(): boolean

Inherited from StiComponent.getGrowToHeight

Returns boolean

getHeight

getHeight(): number

Overrides StiComponent.getHeight

Returns number

getIncorrect

getIncorrect(onlySelect?: boolean): StiComponentsCollection

Inherited from StiContainer.getIncorrect

Parameters
- Default value onlySelect: boolean = false
Returns StiComponentsCollection

getIsEnabled

getIsEnabled(): Promise<boolean>

Inherited from StiComponent.getIsEnabled

Returns Promise<boolean>

getKey

getKey(): string

Inherited from StiComponent.getKey

Returns string

getLeft

getLeft(): number

Inherited from StiComponent.getLeft

Returns number

getLinked

getLinked(): boolean

Inherited from StiComponent.getLinked

Returns boolean

getMaxSize

getMaxSize(): SizeD

Inherited from StiComponent.getMaxSize

Returns SizeD

getMinSize

getMinSize(): SizeD

Inherited from StiComponent.getMinSize

Returns SizeD

getName

getName(): string

Implementation of IStiReportComponent.getName

Inherited from StiBase.getName

Returns string

getPaintRectangle

getPaintRectangle(convertToHInches?: boolean, convertByZoom?: boolean, docking?: boolean): RectangleD

Inherited from StiComponent.getPaintRectangle

Parameters
- Default value convertToHInches: boolean = true
- Default value convertByZoom: boolean = true
- Default value docking: boolean = true
Returns RectangleD

getReport

getReport(): IStiReport

Implementation of IStiReportPage.getReport

Inherited from StiComponent.getReport

Returns IStiReport

getRestrictions

getRestrictions(): StiRestrictions

Inherited from StiComponent.getRestrictions

Returns StiRestrictions

getSelectedComponents

getSelectedComponents(): StiComponentsCollection

Inherited from StiContainer.getSelectedComponents

Returns StiComponentsCollection

getSelectedComponents2

getSelectedComponents2(REFcomps: any): void

Inherited from StiContainer.getSelectedComponents2

Parameters
- REFcomps: any
Returns void

getSelectedRectangle

getSelectedRectangle(): Rectangle

Inherited from StiContainer.getSelectedRectangle

Returns Rectangle

getShift

getShift(): boolean

Inherited from StiComponent.getShift

Returns boolean

getStates

getStates(): StiStatesManager

Inherited from StiComponent.getStates

Returns StiStatesManager

getString

getString(propertyName: string): string

Implementation of IStiGlobalizationProvider.getString

Gets localized string from specified property name.

Parameters
- propertyName: string
Returns string

getTop

getTop(): number

Inherited from StiComponent.getTop

Returns number

getUseParentStyles

getUseParentStyles(): boolean

Inherited from StiComponent.getUseParentStyles

Returns boolean

getWidth

getWidth(): number

Overrides StiComponent.getWidth

Returns number

implements

implements(): any[]

Overrides StiPanel.implements

Returns any[]

internalRender

internalRender(): StiComponent

Inherited from StiComponent.internalRender

Returns StiComponent

internalRenderAsync

internalRenderAsync(): Promise<StiComponent>

Inherited from StiComponent.internalRenderAsync

Returns Promise<StiComponent>

invert

invert(): void

Inherited from StiComponent.invert

Returns void

invokeAfterPrint

invokeAfterPrint(sender: any, e: EventArgs): void

Inherited from StiComponent.invokeAfterPrint

Parameters
- sender: any
- e: EventArgs
Returns void

invokeBeforePrint

invokeBeforePrint(sender: StiComponent, e: EventArgs): void

Inherited from StiComponent.invokeBeforePrint

Parameters
- sender: StiComponent
- e: EventArgs
Returns void

invokeBeginRender

invokeBeginRender(): void

Returns void

invokeClick

invokeClick(sender: any, e: EventArgs): void

Inherited from StiComponent.invokeClick

Parameters
- sender: any
- e: EventArgs
Returns void

invokeColumnBeginRender

invokeColumnBeginRender(sender?: any): void

Parameters
- Default value sender: any = this
Returns void

invokeColumnEndRender

invokeColumnEndRender(sender?: any): void

Parameters
- Default value sender: any = this
Returns void

invokeDoubleClick

invokeDoubleClick(sender: any, e: EventArgs): void

Inherited from StiComponent.invokeDoubleClick

Parameters
- sender: any
- e: EventArgs
Returns void

invokeEndRender

invokeEndRender(): void

Returns void

invokeEvents

invokeEvents(): void

Overrides StiComponent.invokeEvents

Returns void

invokeGetBookmark

invokeGetBookmark(sender: any, e: EventArgs): void

Inherited from StiComponent.invokeGetBookmark

Parameters
- sender: any
- e: EventArgs
Returns void

invokeGetDrillDownReport

invokeGetDrillDownReport(sender: any, e: StiGetDrillDownReportEventArgs): void

Inherited from StiComponent.invokeGetDrillDownReport

Parameters
- sender: any
- e: StiGetDrillDownReportEventArgs
Returns void

invokeGetExcelSheet

invokeGetExcelSheet(sender: StiComponent, e: StiGetExcelSheetEventArgs): void

Parameters
- sender: StiComponent
- e: StiGetExcelSheetEventArgs
Returns void

invokeGetHyperlink

invokeGetHyperlink(sender: any, e: StiValueEventArgs): void

Inherited from StiComponent.invokeGetHyperlink

Parameters
- sender: any
- e: StiValueEventArgs
Returns void

invokeGetPointer

invokeGetPointer(sender: any, e: StiValueEventArgs): void

Inherited from StiComponent.invokeGetPointer

Parameters
- sender: any
- e: StiValueEventArgs
Returns void

invokeGetTag

invokeGetTag(sender: any, e: StiValueEventArgs): void

Inherited from StiComponent.invokeGetTag

Parameters
- sender: any
- e: StiValueEventArgs
Returns void

invokeGetToolTip

invokeGetToolTip(sender: any, e: StiValueEventArgs): void

Inherited from StiComponent.invokeGetToolTip

Parameters
- sender: any
- e: StiValueEventArgs
Returns void

invokeMouseEnter

invokeMouseEnter(sender: any, e: EventArgs): void

Inherited from StiComponent.invokeMouseEnter

Parameters
- sender: any
- e: EventArgs
Returns void

invokeMouseLeave

invokeMouseLeave(sender: any, e: EventArgs): void

Inherited from StiComponent.invokeMouseLeave

Parameters
- sender: any
- e: EventArgs
Returns void

invokePainted

invokePainted(sender: StiComponent, e: StiPaintEventArgs): void

Inherited from StiComponent.invokePainted

Parameters
- sender: StiComponent
- e: StiPaintEventArgs
Returns void

invokePainting

invokePainting(sender: StiComponent, e: StiPaintEventArgs): void

Inherited from StiComponent.invokePainting

Parameters
- sender: StiComponent
- e: StiPaintEventArgs
Returns void

invokeRendering

invokeRendering(): void

Returns void

is

is<T>(type: object | Interface<T>): this

Inherited from StiService.is

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns this

is2

is2<T>(type: object | Interface<T>): boolean

Inherited from StiService.is2

Type parameters
- T
Parameters
- type: object | Interface<T>
Returns boolean

isExportAsImage

isExportAsImage(format: StiExportFormat): boolean

Inherited from StiComponent.isExportAsImage

Parameters
- format: StiExportFormat
Returns boolean

Protected isPropertiesInitializedProtected

isPropertiesInitializedProtected(): boolean

Inherited from StiService.isPropertiesInitializedProtected

Internal use only, for LoadDocument optimization.

Returns boolean

isPropertyPresent

isPropertyPresent(key: any): boolean

Inherited from StiService.isPropertyPresent

Parameters
- key: any
Returns boolean

loadFromJsonObject

loadFromJsonObject(jObject: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Inherited from StiService.loadFromJsonObject

Parameters
- jObject: StiJson
Returns void

loadFromXml

loadFromXml(xmlNode: XmlNode): void

Overrides StiContainer.loadFromXml

Parameters
- xmlNode: XmlNode
Returns void

Protected loadRectangleDFromXml

loadRectangleDFromXml(text: string): RectangleD

Inherited from StiComponent.loadRectangleDFromXml

Parameters
- text: string
Returns RectangleD

makeHorizontalSpacingEqual

makeHorizontalSpacingEqual(): void

Inherited from StiContainer.makeHorizontalSpacingEqual

Returns void

makeSameHeight

makeSameHeight(height: number): void

Inherited from StiContainer.makeSameHeight

Parameters
- height: number
Returns void

makeSameSize

makeSameSize(size: SizeD): void

Inherited from StiContainer.makeSameSize

Parameters
- size: SizeD
Returns void

makeSameWidth

makeSameWidth(width: number): void

Inherited from StiContainer.makeSameWidth

Parameters
- width: number
Returns void

makeVerticalSpacingEqual

makeVerticalSpacingEqual(): void

Inherited from StiContainer.makeVerticalSpacingEqual

Returns void

memberwiseClone

memberwiseClone(base?: boolean): StiComponent

Inherited from StiComponent.memberwiseClone

Overrides StiBase.memberwiseClone

Parameters
- Default value base: boolean = true
Returns StiComponent

moveBackward

moveBackward(): void

Inherited from StiContainer.moveBackward

Returns void

moveComponentsToPage

moveComponentsToPage(): void

Inherited from StiContainer.moveComponentsToPage

Returns void

moveForward

moveForward(): void

Inherited from StiContainer.moveForward

Returns void

newCacheGuid

newCacheGuid(): void

Returns void

newGuid

newGuid(): void

Implementation of IStiComponentGuid.newGuid

Inherited from StiComponent.newGuid

Returns void

normalize

normalize(): void

Inherited from StiContainer.normalize

Returns void

offsetLocation

offsetLocation(offsetX: number, offsetY: number): void

Inherited from StiContainer.offsetLocation

Parameters
- offsetX: number
- offsetY: number
Returns void

Protected onAfterPrint

onAfterPrint(e: EventArgs): void

Inherited from StiComponent.onAfterPrint

Parameters
- e: EventArgs
Returns void

Protected onBeforePrint

onBeforePrint(e: EventArgs): void

Inherited from StiComponent.onBeforePrint

Parameters
- e: EventArgs
Returns void

Protected onBeginRender

onBeginRender(): void

Returns void

Protected onColumnBeginRender

onColumnBeginRender(): void

Returns void

Protected onColumnEndRender

onColumnEndRender(): void

Returns void

Protected onEndRender

onEndRender(): void

Returns void

onGetBookmark

onGetBookmark(): void

Inherited from StiComponent.onGetBookmark

Returns void

Protected onGetDrillDownReport

onGetDrillDownReport(e: StiGetDrillDownReportEventArgs): void

Inherited from StiComponent.onGetDrillDownReport

Parameters
- e: StiGetDrillDownReportEventArgs
Returns void

Protected onGetExcelSheet

onGetExcelSheet(e: StiGetExcelSheetEventArgs): void

Parameters
- e: StiGetExcelSheetEventArgs
Returns void

Protected onGetHyperlink

onGetHyperlink(e: StiValueEventArgs): void

Inherited from StiComponent.onGetHyperlink

Parameters
- e: StiValueEventArgs
Returns void

Protected onGetPointer

onGetPointer(e: StiValueEventArgs): void

Inherited from StiComponent.onGetPointer

Parameters
- e: StiValueEventArgs
Returns void

Protected onGetTag

onGetTag(e: StiValueEventArgs): void

Inherited from StiComponent.onGetTag

Parameters
- e: StiValueEventArgs
Returns void

Protected onGetToolTip

onGetToolTip(): void

Inherited from StiComponent.onGetToolTip

Returns void

Protected onPainted

onPainted(e: StiPaintEventArgs): void

Inherited from StiComponent.onPainted

Parameters
- e: StiPaintEventArgs
Returns void

Protected onPainting

onPainting(e: StiPaintEventArgs): void

Inherited from StiComponent.onPainting

Parameters
- e: StiPaintEventArgs
Returns void

Protected onRendering

onRendering(): void

Returns void

onResizeComponent

onResizeComponent(oldSize: SizeD, newSize: SizeD): void

Inherited from StiComponent.onResizeComponent

Parameters
- oldSize: SizeD
- newSize: SizeD
Returns void

pageToComponent

pageToComponent(value: PointD | RectangleD): any

Inherited from StiComponent.pageToComponent

Parameters
- value: PointD | RectangleD
Returns any

pageToContainer

pageToContainer(value: Point | Rectangle): any

Inherited from StiContainer.pageToContainer

Parameters
- value: Point | Rectangle
Returns any

paint

paint(g: Graphics): void

Inherited from StiComponent.paint

Parameters
- g: Graphics
Returns void

parseContainerFromXml

parseContainerFromXml(xmlNode: XmlNode): void

Inherited from StiContainer.parseContainerFromXml

Parameters
- xmlNode: XmlNode
Returns void

parseExpression

parseExpression(text: string, allowReturnNull?: boolean): string

Implementation of IStiReportPage.parseExpression

Parameters
- text: string
- Default value allowReturnNull: boolean = false
Returns string

prepare

prepare(): void

Overrides StiComponent.prepare

Returns void

render

render(): StiComponent

Inherited from StiComponent.render

Returns StiComponent

renderAsync

renderAsync(): Promise<StiComponent>

Inherited from StiComponent.renderAsync

Returns Promise<StiComponent>

reset

reset(): void

Inherited from StiComponent.reset

Returns void

resetSelection

resetSelection(): void

Inherited from StiContainer.resetSelection

Returns void

resizePage

resizePage(factorX: number, factorY: number, allowPageMarginsRescaling?: boolean): void

Parameters
- factorX: number
- factorY: number
- Default value allowPageMarginsRescaling: boolean = true
Returns void

restoreState

restoreState(stateName: string): void

Implementation of IStiStateSaveRestore.restoreState

Inherited from StiComponent.restoreState

Parameters
- stateName: string
Returns void

saveState

saveState(stateName: string): void

Implementation of IStiStateSaveRestore.saveState

Inherited from StiComponent.saveState

Parameters
- stateName: string
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Inherited from StiService.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

select

select(): void

Inherited from StiComponent.select

Returns void

selectAll

selectAll(): void

Inherited from StiContainer.selectAll

Returns void

sendToBack

sendToBack(): void

Inherited from StiContainer.sendToBack

Returns void

setCanGrow

setCanGrow(value: boolean): void

Inherited from StiComponent.setCanGrow

Parameters
- value: boolean
Returns void

setCenterHorizontally

setCenterHorizontally(): void

Inherited from StiContainer.setCenterHorizontally

Returns void

setCenterVertically

setCenterVertically(): void

Inherited from StiContainer.setCenterVertically

Returns void

Protected setClientRectangle

setClientRectangle(value: RectangleD): void

Inherited from StiComponent.setClientRectangle

Parameters
- value: RectangleD
Returns void

setComponentStyle

setComponentStyle(value: string): void

Inherited from StiComponent.setComponentStyle

Parameters
- value: string
Returns void

setConditions

setConditions(value: StiConditionsCollection): void

Inherited from StiComponent.setConditions

Parameters
- value: StiConditionsCollection
Returns void

setDirectDisplayRectangle

setDirectDisplayRectangle(rect: RectangleD): void

Inherited from StiComponent.setDirectDisplayRectangle

Parameters
- rect: RectangleD
Returns void

setDisplayRectangle

setDisplayRectangle(value: RectangleD): void

Inherited from StiComponent.setDisplayRectangle

Parameters
- value: RectangleD
Returns void

setHeight

setHeight(value: number): void

Overrides StiComponent.setHeight

Parameters
- value: number
Returns void

setKey

setKey(key: string): void

Inherited from StiComponent.setKey

Parameters
- key: string
Returns void

setLeft

setLeft(value: number): void

Inherited from StiComponent.setLeft

Parameters
- value: number
Returns void

setLinked

setLinked(value: boolean): void

Inherited from StiComponent.setLinked

Parameters
- value: boolean
Returns void

setMaxSize

setMaxSize(value: SizeD): void

Inherited from StiComponent.setMaxSize

Parameters
- value: SizeD
Returns void

setMinSize

setMinSize(value: SizeD): void

Inherited from StiComponent.setMinSize

Parameters
- value: SizeD
Returns void

setName

setName(value: string): void

Inherited from StiComponent.setName

Overrides StiBase.setName

Parameters
- value: string
Returns void

setPaintRectangle

setPaintRectangle(rect: RectangleD): void

Inherited from StiComponent.setPaintRectangle

Parameters
- rect: RectangleD
Returns void

setParentStylesToChilds

setParentStylesToChilds(style?: StiBaseStyle): void

Inherited from StiContainer.setParentStylesToChilds

Parameters
- Default value style: StiBaseStyle = null
Returns void

setReportVariables

setReportVariables(): void

Inherited from StiComponent.setReportVariables

Returns void

setRestrictions

setRestrictions(value: StiRestrictions): void

Inherited from StiComponent.setRestrictions

Parameters
- value: StiRestrictions
Returns void

setString

setString(propertyName: string, value: string): void

Implementation of IStiGlobalizationProvider.setString

Sets localized string to specified property name.

Parameters
- propertyName: string
- value: string
Returns void

setTop

setTop(value: number): void

Inherited from StiComponent.setTop

Parameters
- value: number
Returns void

setUseParentStyles

setUseParentStyles(value: boolean): void

Inherited from StiComponent.setUseParentStyles

Parameters
- value: boolean
Returns void

setWidth

setWidth(value: number): void

Overrides StiComponent.setWidth

Parameters
- value: number
Returns void

sortByPriority

sortByPriority(): void

Inherited from StiContainer.sortByPriority

Returns void

toString

toString(): string

Overrides StiComponent.toString

Returns string

unPrepare

unPrepare(): void

Inherited from StiComponent.unPrepare

Returns void

Static doOffsetRect

doOffsetRect(component: StiComponent, rect: RectangleD, offsetRect: RectangleD): RectangleD

Inherited from StiComponent.doOffsetRect

Parameters
- component: StiComponent
- rect: RectangleD
- offsetRect: RectangleD
Returns RectangleD

Static isParentSelect

isParentSelect(component: StiComponent): boolean

Inherited from StiComponent.isParentSelect

Parameters
- component: StiComponent
Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional report: StiReport

Default value isSuper: boolean = false

Returns StiPage

Properties

afterPrintEvent

alias

beforePrintEvent

beginRenderEvent

border

clickEvent

collapsedValue

collapsingIndex

collapsingTreePath

columnBeginRenderEvent

columnEndRenderEvent

columnGaps

columnWidth

columns

componentPlacement

cornerRadius

currentBookmark

currentHeightSegment

currentPointer

currentWidthSegment

defaultClientRectangle

doubleClickEvent

drillDownActivated

endRenderEvent

excelSheet

excelSheetValue

expressions

gapAfterLastColumn

getBookmarkEvent

getDrillDownReportEvent

getExcelSheetEvent

getHyperlinkEvent

getPointerEvent

getTagEvent

getToolTipEvent

guid

icon

infographicsDisplayRectangle

isRendered

largeHeight

margins

mirrorMargins

mouseEnterEvent

mouseLeaveEvent

offsetRectangle

onClick

onDoubleClick

onMouseEnter

onMouseLeave

paperSourceOfFirstPage

paperSourceOfOtherPages

parentBookmark

parentComponentIsBand

parentComponentIsCrossBand

parentPointer

pointerValue

printHeadersFootersFromPreviousPage

printOn

printOnPreviousPage

renderingEvent

reportUnit

resetPageNumber

rightToLeft

stopBeforePrint

stretchToPrintArea

unlimitedBreakable