Class PrintManager

An interface class that manages printing functionality (including legend).

Index

Constructors

Properties

customizer encoder legendEncoder

Methods

cancelReport encode encodeLegend getDownloadUrl getExtent requestReport getPrintDatasourceFromSelectedFeatures

Constructors

constructor

new PrintManager(): PrintManager
Returns PrintManager
- Defined in src/components/print/tools/PrintManager.ts:47

Properties

`Protected`customizer

customizer: BaseCustomizer

`Protected`encoder

encoder: MFPEncoder

`Protected`legendEncoder

legendEncoder: MFPLegendEncoder

Methods

cancelReport

cancelReport(printUrl: string, ref: string): Promise<MFPCancelResponse>
Cancels a report.
Parameters
- printUrl: string
- ref: string
Returns Promise<MFPCancelResponse>
A promise that resolves with the cancellation response.
- Defined in src/components/print/tools/PrintManager.ts:65

encode

encode(options: EncodeOptions): null | MFPSpec
Introspect the map and convert each of its layers to MFP v3 format.
Parameters
- options: EncodeOptions
Returns null | MFPSpec
a top level MFP spec
- Defined in src/components/print/tools/PrintManager.ts:86

encodeLegend

encodeLegend(options: EncodeLegendOptions): null | MFPLegendClass
Encodes a print legend based on the given options.
Parameters
- options: EncodeLegendOptions
Returns null | MFPLegendClass
The encoded legend, or null if encoding is empty or fails.
- Defined in src/components/print/tools/PrintManager.ts:115

getDownloadUrl

getDownloadUrl(
    requestReport: string,
    response: MFPReportResponse,
    interval?: number,
    timeout?: number,
): Promise<string>
Retrieves the download URL for a given request report.
Parameters
- requestReport: string
- response: MFPReportResponse
- interval: number = 1000
- timeout: number = 30000
Returns Promise<string>
A promise that resolves to the download URL.
- Defined in src/components/print/tools/PrintManager.ts:73

getExtent

getExtent(pageSize: number[], scale: number, center: number[]): Extent
Calculates the extent of the paper based on the given scale and center coordinates.
Parameters
- pageSize: number[]
- scale: number
- center: number[]
Returns Extent
The extent of the paper.
- Defined in src/components/print/tools/PrintManager.ts:126

requestReport

requestReport(printUrl: string, spec: MFPSpec): Promise<MFPReportResponse>
Requests a print report.
Parameters
- printUrl: string
- spec: MFPSpec
Returns Promise<MFPReportResponse>
A promise that resolves with the response from the report request.
- Defined in src/components/print/tools/PrintManager.ts:57

`Static`getPrintDatasourceFromSelectedFeatures

getPrintDatasourceFromSelectedFeatures(
    selectedFeatures: Feature<Geometry>[],
    extent: number[],
    i18nManager: I18nManager,
): MFPPrintDatasource[]
Formats the data source for printing, based on selected features filtered by the given extent.
Parameters
- selectedFeatures: Feature<Geometry>[]
- extent: number[]
- i18nManager: I18nManager
Returns MFPPrintDatasource[]
Static
- Defined in src/components/print/tools/PrintManager.ts:134