StiRegionMapDashboardInteraction

Hierarchy

StiDashboardInteraction
- StiRegionMapDashboardInteraction

Implements

Index

Constructors

constructor

Properties

Accessors

isDefaultLayout

Methods

Constructors

constructor

new StiRegionMapDashboardInteraction(onHover?: StiInteractionOnHover, onClick?: StiInteractionOnClick, hyperlinkDestination?: StiInteractionOpenHyperlinkDestination, toolTip?: string, hyperlink?: string, drillDownPageKey?: string, drillDownParameters?: List<StiDashboardDrillDownParameter>, fileName?: string, headerText?: string, footerText?: string, showFullScreenButton?: boolean, showSaveButton?: boolean, showViewDataButton?: boolean): StiRegionMapDashboardInteraction

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>
- Optional fileName: string
- Optional headerText: string
- Optional footerText: string
- Optional showFullScreenButton: boolean
- Optional showSaveButton: boolean
- Optional showViewDataButton: boolean
Returns StiRegionMapDashboardInteraction

Properties

Protected _hash

_hash: StiMeta[]

availableOnClick

availableOnClick: StiAvailableInteractionOnClick = StiAvailableInteractionOnClick.ApplyFilter |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.

fileName

fileName: string = null

footerText

footerText: string = null

headerText

headerText: string = null

hyperlink

hyperlink: string = ""

hyperlinkDestination

hyperlinkDestination: StiInteractionOpenHyperlinkDestination = StiInteractionOpenHyperlinkDestination.NewTab

ident

ident: StiInteractionIdent = StiInteractionIdent.RegionMap

onClick

onClick: StiInteractionOnClick = StiInteractionOnClick.ApplyFilter

onHover

onHover: StiInteractionOnHover = StiInteractionOnHover.ShowToolTip

showFullScreenButton

showFullScreenButton: boolean = true

showSaveButton

showSaveButton: boolean = true

showViewDataButton

showViewDataButton: boolean = true

toolTip

toolTip: string = ""

Accessors

isDefaultLayout

get isDefaultLayout(): boolean

Returns boolean

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[]

Overrides 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

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

shouldSerializeOnClick

shouldSerializeOnClick(): boolean

Inherited from StiDashboardInteraction.shouldSerializeOnClick

Returns boolean

shouldSerializeOnHover

shouldSerializeOnHover(): boolean

Inherited from StiDashboardInteraction.shouldSerializeOnHover

Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional onHover: StiInteractionOnHover

Optional onClick: StiInteractionOnClick

Optional hyperlinkDestination: StiInteractionOpenHyperlinkDestination

Optional toolTip: string

Optional hyperlink: string

Optional drillDownPageKey: string

Optional drillDownParameters: List<StiDashboardDrillDownParameter>

Optional fileName: string

Optional headerText: string

Optional footerText: string

Optional showFullScreenButton: boolean

Optional showSaveButton: boolean

Optional showViewDataButton: boolean

Returns StiRegionMapDashboardInteraction

Properties

Protected _hash

availableOnClick

availableOnDataManipulation

availableOnHover

drillDownPageKey

drillDownParameters

fileName

footerText

headerText

hyperlink

hyperlinkDestination

ident

onClick

onHover

showFullScreenButton

showSaveButton

showViewDataButton

toolTip

Accessors

isDefaultLayout

Returns boolean

Methods

as

Type parameters

T

Parameters

type: object | Interface<T>

Returns T

clone

Parameters

Default value cloneProperties: boolean = true

Default value cloneComponents: boolean = true

Returns any

getDrillDownParameters

Returns List<IStiDashboardDrillDownParameter>

implements

Returns any[]

is

Type parameters

T

Parameters

type: object | Interface<T>

Returns this

is2

Type parameters

T

Parameters

type: object | Interface<T>

Returns boolean

isDefault

Returns boolean

loadFromJsonObject

Parameters

j: StiJson

Returns void