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
    - - (): void
      - Returns void
  Returns void

onBeginProcessData

onBeginProcessData: function = null

Type declaration

- (args: BeginProcessDataArgs, callback: function): void
- Parameters
  - args: BeginProcessDataArgs
  - callback: function
    - - (result: any): void
      - Parameters
        
        result: any
        
        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, callback: function): void
- Parameters
  - args: EmailReportArgs
  - callback: function
    - - (): void
      - Returns void
  Returns void

onEndExportReport

onEndExportReport: function = null

Type declaration

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

onEndProcessData

onEndProcessData: function = null

Type declaration

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

onInteraction

onInteraction: function = null

Type declaration

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

onOpenReport

onOpenReport: function = null

Type declaration

- (args: OpenReportArgs, callback: function): void
- Parameters
  - args: OpenReportArgs
  - callback: function
    - - (report: StiReport): void
      - Parameters
        
        report: StiReport
        
        Returns void
  Returns void

onOpenedReport

onOpenedReport: function = null

Type declaration

- (args: OpenedReportArgs, callback: function): void
- Parameters
  - args: OpenedReportArgs
  - callback: function
    - - (report: StiReport): void
      - Parameters
        
        report: StiReport
        
        Returns void
  Returns void

onPrepareVariables

onPrepareVariables: function = null

Type declaration

- (args: PrepareVariablesArgs, callback: function): void
- Parameters
  - args: PrepareVariablesArgs
  - callback: function
    - - (result: PrepareVariablesObject[] | PrepareVariablesArgs): void
      - Parameters
        
        result: PrepareVariablesObject[] | PrepareVariablesArgs
        
        Returns void
  Returns void

onPrintReport

onPrintReport: function = null

Type declaration

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

onShowReport

onShowReport: function = null

Type declaration

- (args: ShowReportArgs, callback: function): void
- Parameters
  - args: ShowReportArgs
  - callback: function
    - - (): void
      - Returns void
  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

getReportPageAsync

getReportPageAsync(report: StiReport, service: StiHtmlExportService, pageIndex: number, zoom: number, openLinksWindow: string): any

Parameters
- report: StiReport
- service: StiHtmlExportService
- pageIndex: number
- zoom: number
- openLinksWindow: string
Returns any

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

Returns void

Returns void

onBeginProcessData

Type declaration

Parameters

args: BeginProcessDataArgs

callback: function

Parameters

result: any

Returns void

Returns void

onDesignReport

Type declaration

Parameters

args: DesignReportArgs

Returns void

onEmailReport

Type declaration

Parameters

args: EmailReportArgs

callback: function

Returns void

Returns void

onEndExportReport

Type declaration

Parameters

args: EndExportReportArgs

callback: function

Returns void

Returns void

onEndProcessData

Type declaration

Parameters

args: EndProcessDataArgs

Returns void

onInteraction

Type declaration

Parameters

args: InteractionArgs

callback: function

Returns void

Returns void

onOpenReport

Type declaration

Parameters

args: OpenReportArgs

callback: function

Parameters

report: StiReport

Returns void

Returns void

onOpenedReport

Type declaration

Parameters

args: OpenedReportArgs

callback: function

Parameters

report: StiReport