Class StiBmpExportService

A class for the export in the SVGZ image format.

Hierarchy

StiImageExportService
- StiBmpExportService

Implements

IStiExportService

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StiBmpExportService(): StiBmpExportService

Inherited from StiBmpExportService.constructor

Returns StiBmpExportService

Properties

compressToArchive

compressToArchive: boolean = false

currentPassNumber

currentPassNumber: number = 0

exportServiceId

exportServiceId: string = ""

imageSettings

imageSettings: StiImageExportSettings

isStopped

isStopped: boolean = false

maximumPassNumber

maximumPassNumber: number = 0

multipleFiles

multipleFiles: boolean = false

Gets a value indicating a number of files in exported document as a result of export of one page of the rendered report.

renderedPagesCount

renderedPagesCount: number = 0

report

report: StiReport

Accessors

defaultExtension

get defaultExtension(): string

Inherited from StiBmpExportService.defaultExtension

Gets or sets a default extension of export.

Returns string

exportFormat

get exportFormat(): StiExportFormat

Inherited from StiBmpExportService.exportFormat

Overrides StiExportService.exportFormat

Returns StiExportFormat

groupCategory

get groupCategory(): string

Inherited from StiBmpExportService.groupCategory

Gets a group of the export in the context menu.

Returns string

imageFormat

get imageFormat(): ImageFormat

Inherited from StiBmpExportService.imageFormat

Returns ImageFormat

Methods

exportTo

exportTo(report: StiReport, stream: MemoryStream, settings: StiExportSettings): void

Implementation of IStiExportService.exportTo

Inherited from StiBmpExportService.exportTo

Overrides StiExportService.exportTo

Exports a document to the stream without dialog of the saving file.

Parameters
- report: StiReport
  
  A report which is to be exported.
- stream: MemoryStream
  
  A stream in which report will be exported.
- settings: StiExportSettings
  
  A settings for the report exporting.
Returns void

exportTo2

exportTo2(report: StiReport, stream: MemoryStream, settings: StiExportSettings): Promise<void>

Implementation of IStiExportService.exportTo2

Inherited from StiBmpExportService.exportTo2

Overrides StiExportService.exportTo2

Parameters
- report: StiReport
- stream: MemoryStream
- settings: StiExportSettings
Returns Promise<void>

exportToAsync

exportToAsync(onExport: Function, report: StiReport, stream: MemoryStream, settings: StiExportSettings): void

Implementation of IStiExportService.exportToAsync

Inherited from StiBmpExportService.exportToAsync

Overrides StiExportService.exportToAsync

Parameters
- onExport: Function
- report: StiReport
- stream: MemoryStream
- settings: StiExportSettings
Returns void

getExtensionFromSettings

getExtensionFromSettings(): string

Inherited from StiBmpExportService.getExtensionFromSettings

Returns string

invokeExporting

invokeExporting(page: StiPage, pages: StiPagesCollection, currentPass: number, maximumPass: number): void

Implementation of IStiExportService.invokeExporting

Inherited from StiExportService.invokeExporting

Parameters
- page: StiPage
- pages: StiPagesCollection
- currentPass: number
- maximumPass: number
Returns void

invokeExporting2

invokeExporting2(value: number, maximum: number, currentPass: number, maximumPass: number): void

Implementation of IStiExportService.invokeExporting2

Inherited from StiExportService.invokeExporting2

Parameters
- value: number
- maximum: number
- currentPass: number
- maximumPass: number
Returns void

Static Protected getOrderFileName

getOrderFileName(baseName: string, index: number, totalPagesCount: number, extension: string): string

Inherited from StiExportService.getOrderFileName

Parameters
- baseName: string
- index: number
- totalPagesCount: number
- extension: string
Returns string

Generated using TypeDoc