Class StiElement

Describes the base class for all dashboards elements.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

afterPrintEvent

afterPrintEvent: StiEvent = new StiEvent()

alias

alias: string = ""

altClientRectangle

altClientRectangle: RectangleD = RectangleD.empty

altParentKey

altParentKey: string

altTitleVisible

altTitleVisible: boolean = true

beforePrintEvent

beforePrintEvent: StiEvent = new StiEvent()

border2

border2: StiSimpleBorder = new StiSimpleBorder()

Gets or sets border of the element.

clickEvent

clickEvent: StiEvent = new StiEvent()

componentPlacement

componentPlacement: string = ""

currentBookmark

currentBookmark: StiBookmark

currentPointer

currentPointer: StiBookmark

defaultClientRectangle

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

Gets or sets the default client area of a component.

doubleClickEvent

doubleClickEvent: StiEvent = new StiEvent()

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.

getBookmarkEvent

getBookmarkEvent: StiEvent = new StiEvent()

getDrillDownReportEvent

getDrillDownReportEvent: 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

infographicsDisplayRectangle

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

isRendered

isRendered: boolean = false

margin

margin: StiMargin = StiMargin.create(3)

Gets or sets element margin.

mouseEnterEvent

mouseEnterEvent: StiEvent = new StiEvent()

mouseLeaveEvent

mouseLeaveEvent: StiEvent = new StiEvent()

onClick

onClick: Function

onDoubleClick

onDoubleClick: Function

onMouseEnter

onMouseEnter: Function

onMouseLeave

onMouseLeave: Function

padding

padding: StiPadding = StiPadding.create(5)

Gets or sets element padding.

parentBookmark

parentBookmark: StiBookmark

parentPointer

parentPointer: StiBookmark

pointerValue

pointerValue: any = null

printOn

printOn: StiPrintOnType = StiPrintOnType.AllPages

toolboxCategory

toolboxCategory: StiToolboxCategory = StiToolboxCategory.Dashboards

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

backColor

  • get backColor(): Color
  • set backColor(value: Color): void

  • Returns Color

  • Parameters

    Returns void

bookmark

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

bookmarkValue

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

bottom

  • get bottom(): number

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

conditions

dashboard

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

growToHeight

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

height

  • get height(): number
  • set height(value: number): 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

isDefined

  • get isDefined(): boolean

  • Returns boolean

isDesigning

  • get isDesigning(): boolean

isEnabled

  • get isEnabled(): boolean

isExporting

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

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

page

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

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

states

tag

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

tagValue

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

toolTip

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

toolTipValue

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

toolboxPosition

  • get toolboxPosition(): number

top

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

useParentStyles

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

width

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

zoom

  • get zoom(): number

  • Returns number

Methods

allowDelete

  • allowDelete(): boolean

allowPrintOn

  • allowPrintOn(): boolean

applyConditions

as

canContainIn

  • May this container be located in the specified component.

    Parameters

    Returns boolean

    true, if this container may is located in the specified component.

checkForParentComponent

clearAllStates

  • clearAllStates(): void

clearContents

  • clearContents(): void

clone

  • clone(cloneProperties: boolean): any

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

    Parameters

    • cloneProperties: boolean

    Returns any

    A new object that is a copy of this instance.

componentToPage

Protected construct

convert

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

doBookmark

  • doBookmark(): boolean

doPointer

  • doPointer(createNewGuid?: boolean): void

  • Parameters

    • Default value createNewGuid: boolean = true

    Returns void

dockToContainer

  • dockToContainer(): void

dockToContainer2

fetchAllMeters

getActualSize

getApp

getBottom

  • getBottom(): number

getCanGrow

  • getCanGrow(): boolean

getCanShrink

  • getCanShrink(): boolean

getComponentStyle

  • getComponentStyle(): string

getComponentStyle2

getConditions

getContainer

getDataBand

getDataSources

getDictionary

getDisplayRectangle

getDisplayRectangle2

getDockRegion

getDockStyle

getFonts

  • getFonts(): Font[]

getGroupHeaderBand

getGrowToHeight

  • getGrowToHeight(): boolean

getHeight

  • getHeight(): number

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

getShift

  • getShift(): boolean

getStates

getTop

  • getTop(): number

getUseParentStyles

  • getUseParentStyles(): boolean

getWidth

  • getWidth(): number

implements

  • implements(): any[]

internalRender

internalRenderAsync

invert

  • invert(): void

invokeAfterPrint

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

invokeBeforePrint

invokeClick

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

invokeDoubleClick

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

invokeEvents

  • invokeEvents(): void

invokeGetBookmark

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

invokeGetDrillDownReport

invokeGetHyperlink

invokeGetPointer

invokeGetTag

invokeGetToolTip

invokeMouseEnter

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

invokeMouseLeave

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

invokePainted

invokePainting

is

is2

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

isEnabledAsync

  • isEnabledAsync(): Promise<boolean>

isExportAsImage

Protected isPropertiesInitializedProtected

  • isPropertiesInitializedProtected(): boolean

isPropertyPresent

  • isPropertyPresent(key: any): boolean

loadFromJsonObject

  • loadFromJsonObject(jObject: StiJson): void

loadFromXml

  • loadFromXml(xmlNode: XmlNode): void

Protected loadRectangleDFromXml

memberwiseClone

meta

newGuid

  • newGuid(): void

Protected onAfterPrint

Protected onBeforePrint

onGetBookmark

  • onGetBookmark(): void

Protected onGetDrillDownReport

Protected onGetHyperlink

Protected onGetPointer

Protected onGetTag

Protected onGetToolTip

  • onGetToolTip(): void

Protected onPainted

Protected onPainting

onResizeComponent

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

pageToComponent

paint

prepare

  • prepare(): void

render

renderAsync

reset

  • reset(): void

restoreState

  • restoreState(stateName: string): void

retrieveUsedDataNames

  • retrieveUsedDataNames(): List<string>

  • Returns List<string>

retrieveUsedDataNames2

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

  • Parameters

    • group: string

    Returns List<string>

saveState

  • saveState(stateName: string): void

saveToJsonObject

select

  • select(): void

setCanGrow

  • setCanGrow(value: boolean): 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

setReportVariables

  • setReportVariables(): void

setRestrictions

setTop

  • setTop(value: number): void

setUseParentStyles

  • setUseParentStyles(value: boolean): void

setWidth

  • setWidth(value: number): void

toString

  • toString(): string

unPrepare

  • unPrepare(): void

Static doOffsetRect

Static isParentSelect

Generated using TypeDoc