Class StiTextDashboardInteraction

Hierarchy

StiDashboardInteraction
- StiTextDashboardInteraction

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StiTextDashboardInteraction(onHover?: StiInteractionOnHover, onClick?: StiInteractionOnClick, hyperlinkDestination?: StiInteractionOpenHyperlinkDestination, toolTip?: string, hyperlink?: string, drillDownPageKey?: string, drillDownParameters?: List<StiDashboardDrillDownParameter>): StiTextDashboardInteraction

Overrides StiDashboardInteraction.constructor

Parameters
- Optional onHover: StiInteractionOnHover
- Optional onClick: StiInteractionOnClick
- Optional hyperlinkDestination: StiInteractionOpenHyperlinkDestination
- Optional toolTip: string
- Optional hyperlink: string
- Optional drillDownPageKey: string
- Optional drillDownParameters: List<StiDashboardDrillDownParameter>
Returns StiTextDashboardInteraction

Properties

Protected _hash

_hash: StiMeta[]

availableOnClick

availableOnClick: number = StiAvailableInteractionOnClick.OpenHyperlink | StiAvailableInteractionOnClick.ShowDashboard

availableOnDataManipulation

availableOnDataManipulation: StiAvailableInteractionOnDataManipulation = StiAvailableInteractionOnDataManipulation.None

availableOnHover

availableOnHover: StiAvailableInteractionOnHover = StiAvailableInteractionOnHover.All

drillDownPageKey

drillDownPageKey: string = ""

Describes a key of the dashboard page which should be opened.

drillDownParameters

drillDownParameters: List<StiDashboardDrillDownParameter> = new List<StiDashboardDrillDownParameter>()

Describes a list of drillDownParameters.

hyperlink

hyperlink: string = ""

hyperlinkDestination

hyperlinkDestination: StiInteractionOpenHyperlinkDestination = StiInteractionOpenHyperlinkDestination.NewTab

ident

ident: StiInteractionIdent = StiInteractionIdent.Text

onClick

onClick: StiInteractionOnClick = StiInteractionOnClick.OpenHyperlink

onHover

onHover: StiInteractionOnHover = StiInteractionOnHover.ShowToolTip

toolTip

toolTip: string = ""

Methods

as

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

Inherited from StiDashboardInteraction.as

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

clone

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

Inherited from StiDashboardInteraction.clone

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

getDrillDownParameters

getDrillDownParameters(): List<IStiDashboardDrillDownParameter>

Inherited from StiDashboardInteraction.getDrillDownParameters

Returns List<IStiDashboardDrillDownParameter>

implements

implements(): any[]

Inherited from StiDashboardInteraction.implements

Returns any[]

is

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

Inherited from StiDashboardInteraction.is

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

is2

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

Inherited from StiDashboardInteraction.is2

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

isDefault

isDefault(): boolean

Overrides StiDashboardInteraction.isDefault

Returns boolean

loadFromJsonObject

loadFromJsonObject(j: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Inherited from StiDashboardInteraction.loadFromJsonObject

Parameters
- j: StiJson
Returns void

loadFromXml

loadFromXml(xn: XmlNode): void

Inherited from StiDashboardInteraction.loadFromXml

Parameters
- xn: XmlNode
Returns void

meta

meta(): StiMeta[]

Inherited from StiDashboardInteraction.meta

Returns StiMeta[]

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Inherited from StiDashboardInteraction.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

setDrillDownParameters

setDrillDownParameters(drillDownParameters: any[]): void

Inherited from StiDashboardInteraction.setDrillDownParameters

Parameters
- drillDownParameters: any[]
Returns void

Generated using TypeDoc