Class MFPEncoder

Class representing a Mapfish Print Encoder.

Index

Constructors

Methods

encodeImageLayer encodeLayer encodeLayers encodeLocalFileLayer encodeMap encodeSpecialLayers encodeTileWmtsLayer encodeWmsFromWmtsLayer getAllLayers getFlatLayers setOptions

Constructors

constructor

new MFPEncoder(): MFPEncoder
Returns MFPEncoder

Methods

encodeImageLayer

encodeImageLayer(layerWms: LayerWms): null | MFPImageLayer
Encodes an image layer from a WMS layer object.
Parameters
- layerWms: LayerWms
Returns null | MFPImageLayer
The encoded image layer or null if the layer is not visible.
- Defined in src/components/print/tools/MFPEncoder.ts:155

encodeLayer

encodeLayer(layer: BaseLayer): null | MFPLayer | MFPLayer[]
Encodes a layer object according to it's className and options.
Parameters
- layer: BaseLayer
Returns null | MFPLayer | MFPLayer[]
A promise that resolves to an array of MFP layers, a single MFP layer, or null.
- Defined in src/components/print/tools/MFPEncoder.ts:138

encodeLayers

encodeLayers(baseLayers: BaseLayer[]): MFPLayer[]
Encode layers recursively.
Parameters
- baseLayers: BaseLayer[]
Returns MFPLayer[]
a list of Mapfish print layer specs for the given layers.
- Defined in src/components/print/tools/MFPEncoder.ts:119

encodeLocalFileLayer

encodeLocalFileLayer(layer: LayerLocalFile): null | MFPLayer
Encodes a local file layer.
Parameters
- layer: LayerLocalFile
Returns null | MFPLayer
The encoded local file layer or null if the layer is not visible.
- Defined in src/components/print/tools/MFPEncoder.ts:252

encodeMap

encodeMap(options: EncodeMapOptions): MFPMap
Encodes the map options, notably the map state and the ol map into a top-level MFPMap object.
Parameters
- options: EncodeMapOptions
Returns MFPMap
A Promise that resolves with the encoded map object.
- Defined in src/components/print/tools/MFPEncoder.ts:44

encodeSpecialLayers

encodeSpecialLayers(
mapManager: MapManager,
customizer: BaseCustomizer,
): MFPLayer[]
Encode special layers, meaning not-in-the-layer-tree layers. These layers are from the mapManager.getLayersToPrint method.
Parameters
- mapManager: MapManager
- customizer: BaseCustomizer
Returns MFPLayer[]
An array of encodedlayers.
- Defined in src/components/print/tools/MFPEncoder.ts:99

encodeTileWmtsLayer

encodeTileWmtsLayer(layerWmts: LayerWmts): null | MFPImageLayer | MFPWmtsLayer
Encodes a WMTS layer into a MFPWmtsLayer or MFPImageLayer object.
Parameters
- layerWmts: LayerWmts
Returns null | MFPImageLayer | MFPWmtsLayer
The encoded layer object, or null if the layer is not visible.
- Defined in src/components/print/tools/MFPEncoder.ts:207

encodeWmsFromWmtsLayer

encodeWmsFromWmtsLayer(layerWmts: LayerWmts): null | MFPImageLayer
Encodes a WMS layer from a WMTS layer.
Parameters
- layerWmts: LayerWmts
Returns null | MFPImageLayer
The encoded WMS layer or null if the ogcServer is missing.
- Defined in src/components/print/tools/MFPEncoder.ts:272

getAllLayers

getAllLayers(state: State): BaseLayer[]
Parameters
- state: State
Returns BaseLayer[]
An array of all active layers from the state object in the right order
- Defined in src/components/print/tools/MFPEncoder.ts:70

getFlatLayers

getFlatLayers(baseLayers: BaseLayer[]): BaseLayer[]
Parameters
- baseLayers: BaseLayer[]
Returns BaseLayer[]
The flattened array of base layers.
- Defined in src/components/print/tools/MFPEncoder.ts:82

setOptions

setOptions(options: EncodeMapOptions): void
Sets the options for encoding the map.
Parameters
- options: EncodeMapOptions
Returns void
- Defined in src/components/print/tools/MFPEncoder.ts:36