StiReportHelper Class

Namespace: Stimulsoft.Viewer

Methods

Method Details

applyCollapsing static

applyCollapsing(report: StiReport, parameters: any): void

Parameters

• report (StiReport)
• parameters (any)

applyDashboardDrillDown static

applyDashboardDrillDown(report: StiReport, drillDownParameters: any, appliedValues: any, action: string): Promise<StiReport>

Parameters

• report (StiReport)
• drillDownParameters (any)
• appliedValues (any)
• action (string)

Returns Promise<StiReport>

applyDrillDown static

applyDrillDown(report: StiReport, renderedReport: StiReport, parameters: any, appliedValues: any, params: any, viewer: StiViewer): Promise<StiReport>

Parameters

• report (StiReport)
• renderedReport (StiReport)
• parameters (any)
• appliedValues (any)
• params (any)
• viewer (StiViewer)

Returns Promise<StiReport>

applySorting static

applySorting(report: StiReport, parameters: any): void

Parameters

• report (StiReport)
• parameters (any)

brushToStr static

brushToStr(brush: StiBrush): string

Parameters

• brush (StiBrush)

Returns string

calculatePositionForEachBand static

calculatePositionForEachBand(requestParams: any, elements: IStiElement[], page: StiPage, bands: { ref: StiRangeBand[] }, totalFixedHeight: { ref: number }, component: StiComponent): void

Parameters

• requestParams (any)
• elements (IStiElement[])
• page (StiPage)
• bands ({ ref: StiRangeBand[] })
• totalFixedHeight ({ ref: number })
• component (StiComponent)

callback

callback(true: any): void

Parameters

• true (any)

callback(false: any): void

Parameters

• false (any)

callback(true: any): void

Parameters

• true (any)

callback(true: any): void

Parameters

• true (any)

checkScriptEvalAccess static

checkScriptEvalAccess(report: StiReport, viewer: StiViewer, callback: (result: boolean)): void

Parameters

• report (StiReport)
• viewer (StiViewer)
• callback ((result: boolean))

getBookmarksContent static

getBookmarksContent(report: StiReport, viewerId: string, pageNumber: number): string

Parameters

• report (StiReport)
• viewerId (string)
• pageNumber (number)

Returns string

getDashboardPageAsync static

getDashboardPageAsync(report: StiReport, pageIndex: number, requestParams: any): StiPromise

Parameters

• report (StiReport)
• pageIndex (number)
• requestParams (any)

Returns StiPromise

getDashboards static

getDashboards(report: StiReport, combineReportPages: boolean): KeyObjectType[]

Parameters

• report (StiReport)
• combineReportPages (boolean)

Returns KeyObjectType[]

getElementAttributesAsync static

getElementAttributesAsync(page: StiPage, element: IStiElement, renderSingleElement: boolean, requestParams: any, elementOldHeights: any, bands: StiRangeBand[], totalFixedHeight: any): Promise

Parameters

• page (StiPage)
• element (IStiElement)
• renderSingleElement (boolean)
• requestParams (any)
• elementOldHeights (any)
• bands (StiRangeBand[])
• totalFixedHeight (any)

Returns Promise

getHtmlColor static

getHtmlColor(color: Color): string

Get the color in HEX format.

Parameters

• color (Color)

Returns string

getNestedPages static

getNestedPages(report: StiReport): StiPage[]

Parameters

• report (StiReport)

Returns StiPage[]

getPagesCount static

getPagesCount(report: StiReport, originalPageNumber: any, combineReportPages: boolean): number

Parameters

• report (StiReport)
• originalPageNumber (any)
• combineReportPages (boolean)

Returns number

getReportCultureParams static

getReportCultureParams(report: StiReport): any

Parameters

• report (StiReport)

Returns any

getReportDisplayModeFromReport static

getReportDisplayModeFromReport(report: StiReport): StiHtmlExportMode

Parameters

• report (StiReport)

Returns StiHtmlExportMode

getReportPreviewSettings static

getReportPreviewSettings(report: StiReport): KeyObjectType

Parameters

• report (StiReport)

Returns KeyObjectType

getSingleElementContent static

getSingleElementContent(report: StiReport, requestParams: any): Promise

Parameters

• report (StiReport)
• requestParams (any)

Returns Promise

getTableOfContentsPointers static

getTableOfContentsPointers(report: StiReport, requestParams: StiRequestParams): any[]

Parameters

• report (StiReport)
• requestParams (StiRequestParams)

Returns any[]

imageToBase64 static

imageToBase64(image: number[]): string

Parameters

• image (number[])

Returns string

isMixedReport static

isMixedReport(report: StiReport): boolean

Parameters

• report (StiReport)

Returns boolean

resolve

resolve(elementAttributes: any): void

Parameters

• elementAttributes (any)

Fields