Class StiDashboard

Represents a dashboard panel.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

afterPrintEvent

afterPrintEvent: StiEvent = new StiEvent()

alias

alias: string = ""

backColor

backColor: Color = Color.transparent

Gets or sets a back color.

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

customStyleName

customStyleName: string = ""

dashboardWatermark

dashboardWatermark: StiAdvancedWatermark = new StiAdvancedWatermark()

Gets or sets watermark of the page.

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(10, 10, 10, 10)

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

refreshingEvent

refreshingEvent: StiEvent = new StiEvent()

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

altContentAlignment

altSize

  • get altSize(): SizeD
  • set altSize(value: SizeD): void

  • Stores an alternative size of the dashboard.

    Returns SizeD

  • Stores an alternative size of the dashboard.

    Parameters

    Returns void

anchor

blocked

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

bookmark

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

bookmarkValue

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

bottom

  • get bottom(): number

brush

cacheGuid

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

canBreak

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

canGrow

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

canShrink

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

clientRectangle

componentStyle

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

componentType

components

conditions

containerInfo

contentAlignment

dashboardViewMode

deviceWidth

  • get deviceWidth(): number
  • set deviceWidth(value: number): void

  • Gets or sets the mobile width of the dashboard.

    Returns number

  • Gets or sets the mobile width of the dashboard.

    Parameters

    • value: number

    Returns void

displayRectangle

dockStyle

dockable

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

drillDownParameters

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

enabled

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

gridSize

  • get gridSize(): number

growToHeight

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

hasSelected

  • get hasSelected(): boolean

height

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

  • Gets or sets the total height of the dashboard.

    Returns number

  • Gets or sets the total height of the dashboard.

    Parameters

    • value: number

    Returns void

highlightState

hyperlink

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

hyperlinkValue

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

ignoreNamingRule

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

inherited

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

interaction

isAutomaticDock

  • get isAutomaticDock(): boolean

isCross

  • get isCross(): boolean

isDashboard

  • get isDashboard(): boolean

isDefined

  • get isDefined(): boolean

  • Returns boolean

isDesigning

  • get isDesigning(): boolean

isDesktopSurfaceSelected

  • get isDesktopSurfaceSelected(): boolean

  • Returns boolean

isEnabled

  • get isEnabled(): boolean

isExporting

  • get isExporting(): boolean

isMobileSurfacePresent

  • get isMobileSurfacePresent(): boolean

  • Returns boolean

isMobileSurfaceSelected

  • get isMobileSurfaceSelected(): boolean

  • Returns boolean

isPage

  • get isPage(): boolean

isPrinting

  • get isPrinting(): boolean

isQuerable

  • get isQuerable(): boolean

  • Returns boolean

isSelected

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

key

  • get key(): string
  • set key(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

largeHeightAutoFactor

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

largeHeightFactor

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

left

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

linked

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

localizedCategory

  • get localizedCategory(): string

localizedName

  • get localizedName(): string

locked

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

maxSize

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

minSize

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

name

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

  • Gets or sets a component name.

    Returns string

  • Gets or sets a component name.

    Parameters

    • value: string

    Returns void

numberOfCopies

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

orientation

page

pageHeight

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

pageInfo

pageWidth

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

paperSize

parent

placeOnToolbox

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

pointer

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

printable

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

priority

  • get priority(): number

properties

renderedCount

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

report

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

restrictions

right

  • get right(): number

segmentPerHeight

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

segmentPerWidth

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

selectRectangle

serviceCategory

  • get serviceCategory(): string

serviceEnabled

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

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

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

serviceInfo

  • get serviceInfo(): string

serviceName

  • get serviceName(): string

serviceType

  • get serviceType(): Type

shift

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

shiftMode

skip

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

states

style

tag

  • get tag(): string
  • set tag(value: string): void

tagValue

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

titleBeforeHeader

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

toolTip

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

toolTipValue

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

toolboxCategory

toolboxPosition

  • get toolboxPosition(): number

top

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

unit

useParentStyles

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

watermark

watermarkStyle

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

width

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

  • Gets or sets the total width of the dashboard.

    Returns number

  • Gets or sets the total width of the dashboard.

    Parameters

    • value: number

    Returns void

zoom

  • get zoom(): number

Methods

alignTo

allowDelete

  • allowDelete(): boolean

allowPrintOn

  • allowPrintOn(): boolean

applyConditions

as

break

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

bringToFront

  • bringToFront(): void

canContainIn

changePosition

checkForParentComponent

checkLargeHeight

  • checkLargeHeight(needFullCalculation?: boolean): void

clearAllStates

  • clearAllStates(): void

clearContents

  • clearContents(): void

clearPage

  • clearPage(): void

clone

  • clone(): any

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

    Returns any

    A new object that is a copy of this instance.

componentToPage

Protected construct

  • construct(report?: StiReport | any): void

containerToPage

convert

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

convertFromHInches

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

convertFromHInchesRect

convertToHInches

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

correct

  • correct(onlySelect?: boolean): void

  • Parameters

    • Default value onlySelect: boolean = false

    Returns void

correct2

  • correct2(onlySelect: boolean): void

disposeImagesAndClearComponents

  • disposeImagesAndClearComponents(): void

doBookmark

  • doBookmark(): boolean

doPointer

  • doPointer(createNewGuid?: boolean): void

  • Parameters

    • Default value createNewGuid: boolean = true

    Returns void

dockToContainer

  • dockToContainer(): void

dockToContainer2

fetchAllMeters

getActualSize

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

getAllStrings

  • getAllStrings(): string[]

getApp

getBottom

  • getBottom(): number

getCanGrow

  • getCanGrow(): boolean

getCanShrink

  • getCanShrink(): boolean

getColumnWidth

  • getColumnWidth(): number

getComponentStyle

  • getComponentStyle(): string

getComponentStyle2

getComponents

getComponents2

  • getComponents2(REFcomps: any): void

getComponentsCount

  • getComponentsCount(): number

getComponentsList

getConditions

getContainer

getContainerInRect

getContainerInRect2

getDataBand

getDataSources

getDictionary

getDisplayRectangle

getDisplayRectangle2

getDockRegion

getDockStyle

getElements

getFonts

  • getFonts(): Font[]

getGroupHeaderBand

getGrowToHeight

  • getGrowToHeight(): boolean

getHeight

  • getHeight(): number

getIncorrect

getIsEnabled

  • getIsEnabled(): Promise<boolean>

getKey

  • getKey(): string

getLeft

  • getLeft(): number

getLinked

  • getLinked(): boolean

getMaxSize

getMeters

getMinSize

getName

  • getName(): string

getNestedPages

getPaintRectangle

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

  • Parameters

    • Default value convertToHInches: boolean = true
    • Default value convertByZoom: boolean = true
    • Default value docking: boolean = true

    Returns RectangleD

getReport

getRestrictions

getSelectedComponents

getSelectedComponents2

  • getSelectedComponents2(REFcomps: any): void

getSelectedRectangle

getShift

  • getShift(): boolean

getStates

getString

  • getString(propertyName: string): string

getTop

  • getTop(): number

getUnplacedElements

getUseParentStyles

  • getUseParentStyles(): boolean

getUserFilters

getWidth

  • getWidth(): number

implements

  • implements(): any[]

internalRender

internalRenderAsync

invert

  • invert(): void

invokeAfterPrint

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

invokeBeforePrint

invokeBeginRender

  • invokeBeginRender(): void

invokeClick

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

invokeColumnBeginRender

  • invokeColumnBeginRender(sender?: any): void

invokeColumnEndRender

  • invokeColumnEndRender(sender?: any): void

invokeDoubleClick

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

invokeEndRender

  • invokeEndRender(): void

invokeEvents

  • invokeEvents(): void

invokeGetBookmark

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

invokeGetDrillDownReport

invokeGetExcelSheet

invokeGetHyperlink

invokeGetPointer

invokeGetTag

invokeGetToolTip

invokeMouseEnter

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

invokeMouseLeave

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

invokePainted

invokePainting

invokeRefreshing

  • invokeRefreshing(): void

invokeRendering

  • invokeRendering(): void

is

is2

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

isEnabledAsync

  • isEnabledAsync(): Promise<boolean>

  • Returns Promise<boolean>

isExportAsImage

Protected isPropertiesInitializedProtected

  • isPropertiesInitializedProtected(): boolean

isPropertyPresent

  • isPropertyPresent(key: any): boolean

loadFromJsonObject

  • loadFromJsonObject(jObject: StiJson): void

loadFromXml

  • loadFromXml(xmlNode: XmlNode): void

Protected loadRectangleDFromXml

makeHorizontalSpacingEqual

  • makeHorizontalSpacingEqual(): void

makeSameHeight

  • makeSameHeight(height: number): void

makeSameSize

  • makeSameSize(size: SizeD): void

makeSameWidth

  • makeSameWidth(width: number): void

makeVerticalSpacingEqual

  • makeVerticalSpacingEqual(): void

memberwiseClone

meta

moveBackward

  • moveBackward(): void

moveComponentsToPage

  • moveComponentsToPage(): void

moveForward

  • moveForward(): void

newCacheGuid

  • newCacheGuid(): void

newGuid

  • newGuid(): void

normalize

  • normalize(): void

offsetLocation

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

Protected onAfterPrint

Protected onBeforePrint

Protected onBeginRender

  • onBeginRender(): void

Protected onColumnBeginRender

  • onColumnBeginRender(): void

Protected onColumnEndRender

  • onColumnEndRender(): void

Protected onEndRender

  • onEndRender(): void

onGetBookmark

  • onGetBookmark(): void

Protected onGetDrillDownReport

Protected onGetExcelSheet

Protected onGetHyperlink

Protected onGetPointer

Protected onGetTag

Protected onGetToolTip

  • onGetToolTip(): void

Protected onPainted

Protected onPainting

Protected onRefreshing

Protected onRendering

  • onRendering(): void

onResizeComponent

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

pageToComponent

pageToContainer

paint

parseContainerFromXml

  • parseContainerFromXml(xmlNode: XmlNode): void

parseExpression

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

prepare

  • prepare(): void

removeMobileSurface

  • removeMobileSurface(): void

render

renderAsync

reset

  • reset(): void

resetSelection

  • resetSelection(): 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

retrieveUsedDataNames

  • retrieveUsedDataNames(group: string): List<string>

  • Parameters

    • group: string

    Returns List<string>

saveState

  • saveState(stateName: string): void

saveToJsonObject

select

  • select(): void

selectAll

  • selectAll(): void

sendToBack

  • sendToBack(): void

setCanGrow

  • setCanGrow(value: boolean): void

setCenterHorizontally

  • setCenterHorizontally(): void

setCenterVertically

  • setCenterVertically(): void

Protected setClientRectangle

setComponentStyle

  • setComponentStyle(value: string): void

setConditions

setDirectDisplayRectangle

  • setDirectDisplayRectangle(rect: RectangleD): void

setDisplayRectangle

setHeight

  • setHeight(value: number): void

setKey

  • setKey(key: string): void

setLeft

  • setLeft(value: number): void

setLinked

  • setLinked(value: boolean): void

setMaxSize

  • setMaxSize(value: SizeD): void

setMinSize

  • setMinSize(value: SizeD): void

setName

  • setName(value: string): void

setPaintRectangle

setParentStylesToChilds

setReportVariables

  • setReportVariables(): void

setRestrictions

setString

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

setTop

  • setTop(value: number): void

setUseParentStyles

  • setUseParentStyles(value: boolean): void

setWidth

  • setWidth(value: number): void

sortByPriority

  • sortByPriority(): void

switchSurfaceViewMode

toString

  • toString(): string

unPrepare

  • unPrepare(): void

Static doOffsetRect

Static isParentSelect

Generated using TypeDoc