Class StiTableDashboardInteraction

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StiTableDashboardInteraction(onHover?: StiInteractionOnHover, onClick?: StiInteractionOnClick, hyperlinkDestination?: StiInteractionOpenHyperlinkDestination, toolTip?: string, hyperlink?: string, drillDownPageKey?: string, drillDownParameters?: List<StiDashboardDrillDownParameter>, allowFiltering?: boolean, allowSorting?: boolean, allowUserColumnSelection?: boolean, drillDownFiltered?: boolean, fullRowSelect?: boolean, fileName?: string, headerText?: string, footerText?: string, showFullScreenButton?: boolean, showSaveButton?: boolean, showViewDataButton?: boolean): StiTableDashboardInteraction

  • Parameters

    • Optional onHover: StiInteractionOnHover
    • Optional onClick: StiInteractionOnClick
    • Optional hyperlinkDestination: StiInteractionOpenHyperlinkDestination
    • Optional toolTip: string
    • Optional hyperlink: string
    • Optional drillDownPageKey: string
    • Optional drillDownParameters: List<StiDashboardDrillDownParameter>
    • Optional allowFiltering: boolean
    • Optional allowSorting: boolean
    • Optional allowUserColumnSelection: boolean
    • Optional drillDownFiltered: boolean
    • Optional fullRowSelect: boolean
    • Optional fileName: string
    • Optional headerText: string
    • Optional footerText: string
    • Optional showFullScreenButton: boolean
    • Optional showSaveButton: boolean
    • Optional showViewDataButton: boolean

    Returns StiTableDashboardInteraction

Properties

Protected _hash

_hash: StiMeta[]

allowUserColumnSelection

allowUserColumnSelection: boolean = true

allowUserFiltering

allowUserFiltering: boolean = true

allowUserSorting

allowUserSorting: boolean = true

availableOnClick

availableOnClick: StiAvailableInteractionOnClick = StiAvailableInteractionOnClick.None

availableOnDataManipulation

availableOnDataManipulation: number = StiAvailableInteractionOnDataManipulation.AllowFiltering | StiAvailableInteractionOnDataManipulation.AllowSorting

availableOnHover

availableOnHover: StiAvailableInteractionOnHover = StiAvailableInteractionOnHover.None

drillDownFiltered

drillDownFiltered: boolean = true

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

fullRowSelect

fullRowSelect: boolean = false

headerText

headerText: string = null

hyperlink

hyperlink: string = ""

hyperlinkDestination

hyperlinkDestination: StiInteractionOpenHyperlinkDestination = StiInteractionOpenHyperlinkDestination.NewTab

ident

ident: StiInteractionIdent = StiInteractionIdent.Table

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

clone

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

  • Parameters

    • Default value cloneProperties: boolean = true
    • Default value cloneComponents: boolean = true

    Returns any

getDrillDownParameters

implements

  • implements(): any[]

is

is2

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

isDefault

  • isDefault(): boolean

loadFromJsonObject

  • loadFromJsonObject(j: StiJson): void

loadFromXml

meta

saveToJsonObject

setDrillDownParameters

  • setDrillDownParameters(drillDownParameters: any[]): void

Generated using TypeDoc