Class StiDashboardInteraction

Hierarchy

StiDashboardInteraction

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected _hash

_hash: StiMeta[]

availableOnClick

availableOnClick: StiAvailableInteractionOnClick = StiAvailableInteractionOnClick.All

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

onClick

onClick: StiInteractionOnClick = StiInteractionOnClick.ApplyFilter

onHover

onHover: StiInteractionOnHover = StiInteractionOnHover.ShowToolTip

toolTip

toolTip: string = ""

Methods

as

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

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

clone

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

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

getDrillDownParameters

getDrillDownParameters(): List<IStiDashboardDrillDownParameter>

Returns List<IStiDashboardDrillDownParameter>

implements

implements(): any[]

Returns any[]

is

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

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

is2

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

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

isDefault

isDefault(): boolean

Returns boolean

loadFromJsonObject

loadFromJsonObject(j: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Parameters
- j: StiJson
Returns void

loadFromXml

loadFromXml(xn: XmlNode): void

Parameters
- xn: XmlNode
Returns void

meta

meta(): StiMeta[]

Returns StiMeta[]

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

setDrillDownParameters

setDrillDownParameters(drillDownParameters: any[]): void

Parameters
- drillDownParameters: any[]
Returns void

shouldSerializeOnClick

shouldSerializeOnClick(): boolean

Returns boolean

shouldSerializeOnHover

shouldSerializeOnHover(): boolean

Returns boolean

Generated using TypeDoc