StiViewer | main

Hierarchy

StiViewer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StiViewer(options?: StiViewerOptions, viewerId?: string, renderAfterCreate?: boolean): StiViewer

Parameters
- Optional options: StiViewerOptions
- Optional viewerId: string
- Optional renderAfterCreate: boolean
Returns StiViewer

Properties

currentReportGuid

currentReportGuid: string

drillDownReportCache

drillDownReportCache: any

jsObject

jsObject: StiJsViewer

onBeginExportReport

onBeginExportReport: function = null

Type declaration

- (args: BeginExportReportArgs, callback: function): void
- Parameters
  - args: BeginExportReportArgs
  - callback: function
    - - (args: BeginExportReportArgs): void
      - Parameters
        
        args: BeginExportReportArgs
        
        Returns void
  Returns void

onBeginProcessData

onBeginProcessData: function = null

Type declaration

- (args: BeginProcessDataArgs, callback: function): void
- Parameters
  - args: BeginProcessDataArgs
  - callback: function
    - - (args: BeginProcessDataArgs): void
      - Parameters
        
        args: BeginProcessDataArgs
        
        Returns void
  Returns void

onDesignReport

onDesignReport: function = null

Type declaration

- (args: DesignReportArgs): void
- Parameters
  - args: DesignReportArgs
  Returns void

onEmailReport

onEmailReport: function = null

Type declaration

- (args: EmailReportArgs): void
- Parameters
  - args: EmailReportArgs
  Returns void

onEndExportReport

onEndExportReport: function = null

Type declaration

- (args: EndExportReportArgs): void
- Parameters
  - args: EndExportReportArgs
  Returns void

onEndProcessData

onEndProcessData: function = null

Type declaration

- (args: EndProcessDataArgs): void
- Parameters
  - args: EndProcessDataArgs
  Returns void

onGetReport

onGetReport: function = null

Type declaration

- (args: GetReportArgs): void
- Parameters
  - args: GetReportArgs
  Returns void

onGetSubReport

onGetSubReport: Function = null

onInteraction

onInteraction: function = null

Type declaration

- (args: InteractionArgs, callback: function): void
- Parameters
  - args: InteractionArgs
  - callback: function
    - - (args: InteractionArgs): void | Promise<void>
      - Parameters
        
        args: InteractionArgs
        
        Returns void | Promise<void>
  Returns void

onLoadDocument

onLoadDocument: function = null

Type declaration

- (args: LoadDocumentArgs, callback: function): void
- Parameters
  - args: LoadDocumentArgs
  - callback: function
    - - (): void | Promise<void>
      - Returns void | Promise<void>
  Returns void

onPrepareVariables

onPrepareVariables: function = null

Type declaration

- (args: PrepareVariablesArgs, callback: PrepareVariablesContinuationCallback): void
- Parameters
  - args: PrepareVariablesArgs
  - callback: PrepareVariablesContinuationCallback
  Returns void

onPrintReport

onPrintReport: function = null

Type declaration

- (args: PrintReportEventArgs): void
- Parameters
  - args: PrintReportEventArgs
  Returns void

onShowReport

onShowReport: function = null

Type declaration

- (args: ShowReportArgs): void
- Parameters
  - args: ShowReportArgs
  Returns void

options

options: StiViewerOptions

viewerId

viewerId: string

Accessors

report

get report(): StiReport
set report(value: StiReport): void

Returns StiReport
Parameters
- value: StiReport
Returns void

reportTemplate

get reportTemplate(): StiReport

Returns StiReport

visible

get visible(): boolean
set visible(value: boolean): void

Returns boolean
Parameters
- value: boolean
Returns void

Methods

applyTheme

applyTheme(theme: StiViewerTheme): void

Parameters
- theme: StiViewerTheme
Returns void

dispatch

dispatch(removeEvent?: boolean): void

Parameters
- Default value removeEvent: boolean = true
Returns void

hideProcessIndicator

hideProcessIndicator(): void

Returns void

invokeComponentsEvents

invokeComponentsEvents(params: any): void

Parameters
- params: any
Returns void

refreshViewer

refreshViewer(): void

Returns void

renderHtml

renderHtml(element?: string | HTMLElement): void

Parameters
- Optional element: string | HTMLElement
Returns void

setTheme

setTheme(theme: StiViewerTheme): void

Parameters
- theme: StiViewerTheme
Returns void

showProcessIndicator

showProcessIndicator(): void

Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: StiViewerOptions

Optional viewerId: string

Optional renderAfterCreate: boolean

Returns StiViewer

Properties

currentReportGuid

drillDownReportCache

jsObject

onBeginExportReport

Type declaration

Parameters

args: BeginExportReportArgs

callback: function

Parameters

args: BeginExportReportArgs

Returns void

Returns void

onBeginProcessData

Type declaration

Parameters

args: BeginProcessDataArgs

callback: function

Parameters

args: BeginProcessDataArgs

Returns void

Returns void

onDesignReport

Type declaration

Parameters

args: DesignReportArgs

Returns void

onEmailReport

Type declaration

Parameters

args: EmailReportArgs

Returns void

onEndExportReport

Type declaration

Parameters

args: EndExportReportArgs

Returns void

onEndProcessData

Type declaration

Parameters

args: EndProcessDataArgs

Returns void

onGetReport

Type declaration

Parameters

args: GetReportArgs

Returns void

onGetSubReport

onInteraction

Type declaration

Parameters

args: InteractionArgs

callback: function

Parameters

args: InteractionArgs

Returns void | Promise<void>

Returns void

onLoadDocument

Type declaration

Parameters

args: LoadDocumentArgs

callback: function

Returns void | Promise<void>

Returns void

onPrepareVariables

Type declaration

Parameters