Class MapFishPrintV3Manager

The MapFishPrintV3Manager.

Hierarchy

  • BaseMapFishPrintManager
    • MapFishPrintV3Manager

Constructors

constructor

Properties

_customMapParams _dpi? _dpis _extentFeature? _initiated _layout? _layouts _outputFormat? _outputFormats _printApp? _printApps _printJobReference _printMapSize? _scale? _scales capabilities? credentialsMode customParams? customPrintScales? events extentLayer? headers? layerFilter legendFilter map maskColor method serializers timeout transformOpts? url? APPS_JSON_ENDPOINT CAPABILITIES_JSON_ENDPOINT CUSTOM_PRINT_SERIALIZER_OPTS_KEY EXTENT_LAYER_NAME TRANSFORM_INTERACTION_NAME

Methods

appendCustomMapParams calculatePrintExtent calculateRotation cancelPrint clearCustomMapParams dispatch download filterPrintableLayer filterPrintableLegend getAttributeByName getBasePath getClosestScaleToFitExtentFeature getClosestScaleToFitMap getCustomMapParams getCustomParam getCustomParams getDpi getDpis getExtentLayer getLayout getLayoutByName getLayouts getOutputFormat getOutputFormats getPrintApp getPrintApps getPrintExtentSize getPrintJobReference getPrintMapSize getPrintPayload getScale getScales getStatus init initManager initPrintExtentFeature initPrintExtentLayer initTransformInteraction isInitiated loadAppCapabilities loadPrintApps on onExtentLayerPostRender onExtentLayerPreRender onTransformScaling poll pollUntilDone print resetRotation serializeLayer serializeLegend setCustomMapParams setCustomParam setCustomParams setDpi setLayout setLegendFilter setOutputFormat setPrintApp setPrintApps setPrintMapSize setRotation setScale shutdownManager un updatePrintExtent validateResponse wait

Constructors

constructor

Properties

Protected_customMapParams

_customMapParams: V3CustomMapParams = {}

Protected Optional_dpi

_dpi?: number

The currently selected dpi.

Protected_dpis

_dpis: number[] = []

The supported DPIs by the print service.

Protected Optional_extentFeature

_extentFeature?: Feature<Polygon>

Feature representing the page extent.

Protected_initiated

_initiated: boolean = false

Whether this manger has been initiated or not.

Protected Optional_layout

_layout?: Layout

The currently selected layout.

Protected_layouts

_layouts: Layout[] = []

The supported layouts by the print service.

Protected Optional_outputFormat

_outputFormat?: string

The currently selected output format.

Protected_outputFormats

_outputFormats: string[] = []

The supported output formats by the print service.

Protected Optional_printApp

_printApp?: string

The currently selected print application.

Protected_printApps

_printApps: string[] = []

The supported print applications by the print service.

Protected_printJobReference

_printJobReference: null | string = null

ID of currently started print job. Will be used while polling will be performed.

Protected Optional_printMapSize

_printMapSize?: PrintMapSize

The currently set map size defined with its width and height.

Protected Optional_scale

_scale?: number

The currently selected scale.

Protected_scales

_scales: number[] = []

The supported scales by the print service.

Protected Optionalcapabilities

capabilities?: any

ProtectedcredentialsMode

credentialsMode: RequestCredentials

Protected OptionalcustomParams

customParams?: any

Protected OptionalcustomPrintScales

customPrintScales?: number[]

Protectedevents

events: Record<string, ObservableEvent> = {}

The registered events.

Protected OptionalextentLayer

extentLayer?: VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>

Protected Optionalheaders

headers?: Record<string, string>

ProtectedlayerFilter

layerFilter: (layer: Layer<Source, LayerRenderer<any>>) => boolean

ProtectedlegendFilter

legendFilter: (layer: Layer<Source, LayerRenderer<any>>) => boolean

Protectedmap

map: Map

ProtectedmaskColor

maskColor: string

Protectedmethod

method: "GET" | "POST"

Protectedserializers

serializers: BaseSerializer[] = []

Protectedtimeout

timeout: number

Protected OptionaltransformOpts

transformOpts?: OlInteractionTransformOpts

Protected Optionalurl

url?: string

StaticAPPS_JSON_ENDPOINT

APPS_JSON_ENDPOINT: string = 'apps.json'

The capabilities endpoint of the print service.

StaticCAPABILITIES_JSON_ENDPOINT

CAPABILITIES_JSON_ENDPOINT: string = 'capabilities.json'

The capabilities endpoint of the print service.

StaticCUSTOM_PRINT_SERIALIZER_OPTS_KEY

CUSTOM_PRINT_SERIALIZER_OPTS_KEY: string = 'customPrintSerializerOpts'

The key in the layer properties to lookup for custom serializer options.

StaticEXTENT_LAYER_NAME

EXTENT_LAYER_NAME: string = 'PrintManager Vector Layer'

The name of the vector layer configured and created by the print manager.

StaticTRANSFORM_INTERACTION_NAME

TRANSFORM_INTERACTION_NAME: string = 'PrintManager Transform Interaction'

The name of the transform interaction configured and created by the print manager.

Methods

appendCustomMapParams

  • appendCustomMapParams(params: Partial<V3CustomMapParams>): void

  • Append (partial) map parameters

    Parameters

    • params: Partial<V3CustomMapParams>

      The parameters to append

    Returns void

ProtectedcalculatePrintExtent

  • calculatePrintExtent(scale?: number): undefined | number[]

  • Calculates the extent based on a scale.

    Parameters

    • Optionalscale: number

      The scale to calculate the extent for. If not given, the current scale of the provider will be used.

    Returns undefined | number[]

    The extent.

ProtectedcalculateRotation

  • calculateRotation(): undefined | number

  • Calculates the current rotation of the print extent feature.

    Returns undefined | number

cancelPrint

clearCustomMapParams

dispatch

  • dispatch(name: string, data: any): void

  • Dispatches the given event with the provided data.

    Parameters

    • name: string

      The name of the event to dispatch.

    • data: any

      The data to apply to the event callback.

    Returns void

Protecteddownload

  • download(url: string): void

  • Opens the given URL in a new browser tab to download the given response (if header are set correctly).

    Parameters

    • url: string

      The url to open.

    Returns void

ProtectedfilterPrintableLayer

  • filterPrintableLayer(layer: Layer<Source, LayerRenderer<any>>): boolean

  • Checks if a given layer should be printed.

    Parameters

    • layer: Layer<Source, LayerRenderer<any>>

      The layer to check.

    Returns boolean

    Whether the layer should be printed or not.

ProtectedfilterPrintableLegend

  • filterPrintableLegend(layer: Layer<Source, LayerRenderer<any>>): boolean

  • Checks if the legend of a given legend should be printed.

    Parameters

    • layer: Layer<Source, LayerRenderer<any>>

      The layer to check.

    Returns boolean

    Whether the legend of the layer should be printed or not.

ProtectedgetAttributeByName

  • getAttributeByName(attributeName: string): any

  • Returns attribute value contained in currently chosen layout by its name.

    Parameters

    • attributeName: string

      The attribute name (key) to be searched.

    Returns any

    Obtained attribute value.

ProtectedgetBasePath

ProtectedgetClosestScaleToFitExtentFeature

  • getClosestScaleToFitExtentFeature(): undefined | number

  • Returns the closest scale to current print feature's extent.

    Returns undefined | number

getClosestScaleToFitMap

  • getClosestScaleToFitMap(): number

  • Returns the closest scale to fit the print feature's extent into the current extent of the map.

    Returns number

getCustomMapParams

getCustomParam

  • getCustomParam(key: string): any

  • Returns an individual custom param.

    Parameters

    • key: string

      The custom param to get.

    Returns any

    The custom param

getCustomParams

getDpi

  • getDpi(): undefined | number

  • Returns the currently selected dpi.

    Returns undefined | number

    The currently selected dpi.

getDpis

getExtentLayer

  • getExtentLayer(): | undefined
    | VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>

  • Returns the extent layer.

    Returns undefined | VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>

    The extent layer.

getLayout

  • getLayout(): undefined | Layout

  • Returns the currently selected layout.

    Returns undefined | Layout

    The currently selected layout.

ProtectedgetLayoutByName

  • getLayoutByName(layoutName: string): undefined | Layout

  • Returns an object containing configuration for layout based on its name

    Parameters

    • layoutName: string

      Layout name.

    Returns undefined | Layout

    Layout configuration object.

getLayouts

  • getLayouts(): Layout[]

  • Returns all supported layouts.

    Returns Layout[]

    The supported layouts.

getOutputFormat

  • getOutputFormat(): undefined | string

  • Returns the currently selected output format.

    Returns undefined | string

    The currently selected output format.

getOutputFormats

  • getOutputFormats(): string[]

  • Returns all supported output formats.

    Returns string[]

    The supported output formats.

getPrintApp

  • getPrintApp(): undefined | string

  • Returns the currently selected print application.

    Returns undefined | string

    The currently selected print application.

getPrintApps

ProtectedgetPrintExtentSize

  • getPrintExtentSize(printMapSize: PrintMapSize, printScale: number): PrintMapSize

  • Computes size of print extent in pixel depending on dimensions of print map and print scale.

    Parameters

    • printMapSize: PrintMapSize

      Print map size containing its width and height.

    • printScale: number

      Print scale.

    Returns PrintMapSize

    Print extent size.

getPrintJobReference

getPrintMapSize

  • getPrintMapSize(): undefined | PrintMapSize

  • Returns print map size for chosen layout.

    Returns undefined | PrintMapSize

    The map size.

ProtectedgetPrintPayload

  • getPrintPayload(): { attributes: any; layout: undefined | string }

  • Collects the payload that is required for the print call to the print servlet.

    Returns { attributes: any; layout: undefined | string }

    The print payload.

getScale

  • getScale(): undefined | number

  • Returns the currently selected scale.

    Returns undefined | number

    The currently selected scale.

getScales

ProtectedgetStatus

init

ProtectedinitManager

ProtectedinitPrintExtentFeature

  • initPrintExtentFeature(): undefined | Feature<Polygon>

  • Initializes the print extent feature.

    Returns undefined | Feature<Polygon>

    The extent feature.

ProtectedinitPrintExtentLayer

ProtectedinitTransformInteraction

  • initTransformInteraction(): void

  • Initializes the transform interaction.

    Returns void

isInitiated

  • isInitiated(): boolean

  • Whether this manager has been initiated or not.

    Returns boolean

    Whether this manager has been initiated or not.

ProtectedloadAppCapabilities

  • loadAppCapabilities(printApp: string): Promise<any>

  • Loads the print capabilities from the provided remote source.

    Parameters

    • printApp: string

    Returns Promise<any>

ProtectedloadPrintApps

  • loadPrintApps(): Promise<string[]>

  • Returns all available print applications.

    Returns Promise<string[]>

    Promise containing available print apps.

on

  • on(name: string, callback: (data: any) => void): void

  • Registers an event.

    Parameters

    • name: string

      The name of the event to register.

    • callback: (data: any) => void

      The callback function to register.

    Returns void

ProtectedonExtentLayerPostRender

  • onExtentLayerPostRender(olEvt: RenderEvent): void

  • Called on the extentLayer's postrender event.

    Parameters

    • olEvt: RenderEvent

      The ol render event.

    Returns void

ProtectedonExtentLayerPreRender

  • onExtentLayerPreRender(olEvt: RenderEvent): void

  • Called on the extentLayer's prerender event.

    Parameters

    • olEvt: RenderEvent

      The ol render event.

    Returns void

ProtectedonTransformScaling

  • onTransformScaling(): void

  • Called on translate interaction's scaling event.

    Returns void

Protectedpoll

  • poll<T = any>(
        fn: () => Promise<T>,
        fnCondition: (res?: T) => boolean,
        interval?: number,
        timeout?: number,
    ): Promise<T>

  • Type Parameters

    • T = any

    Parameters

    • fn: () => Promise<T>
    • fnCondition: (res?: T) => boolean
    • interval: number = 1000
    • timeout: number = 30000

    Returns Promise<T>

ProtectedpollUntilDone

  • pollUntilDone(url: string, interval: number, timeout: number): Promise<any>

  • Parameters

    • url: string
    • interval: number
    • timeout: number

    Returns Promise<any>

print

resetRotation

ProtectedserializeLayer

  • serializeLayer(layer: Layer<Source, LayerRenderer<any>>): any

  • Serializes/encodes the given layer.

    Parameters

    • layer: Layer<Source, LayerRenderer<any>>

      The layer to serialize/encode.

    Returns any

    The serialized/encoded layer.

ProtectedserializeLegend

  • serializeLegend(
        layer: Layer<Source, LayerRenderer<any>>,
    ): undefined | { icons: any[]; name: any }

  • Serializes/encodes the legend payload for the given layer.

    Parameters

    • layer: Layer<Source, LayerRenderer<any>>

      The layer to serialize/encode the legend for.

    Returns undefined | { icons: any[]; name: any }

    The serialized/encoded legend.

setCustomMapParams

  • setCustomMapParams(params: V3CustomMapParams): void

  • Set custom map parmeters

    Parameters

    • params: V3CustomMapParams

      The parameters to set

    Returns void

setCustomParam

  • setCustomParam(key: string, value: any): void

  • Sets an individual custom param.

    Parameters

    • key: string

      The key of the param.

    • value: any

      The value of the param.

    Returns void

setCustomParams

  • setCustomParams(params: any): void

  • Sets the custom params.

    Parameters

    • params: any

      The params to set.

    Returns void

setDpi

  • setDpi(value: number): void

  • Sets the dpi to use.

    Parameters

    • value: number

      The value of the dpi to use.

    Returns void

setLayout

  • setLayout(name: string): void

  • Sets the layout to use. Updates the print extent accordingly.

    Parameters

    • name: string

      The name of the layout to use.

    Returns void

setLegendFilter

  • setLegendFilter(
        filterFn: (layer: Layer<Source, LayerRenderer<any>>) => boolean,
    ): void

  • Setter for legend filter

    Parameters

    • filterFn: (layer: Layer<Source, LayerRenderer<any>>) => boolean

      The new legend filter function

    Returns void

setOutputFormat

  • setOutputFormat(name: string): void

  • Sets the output format to use.

    Parameters

    • name: string

      The name of the output format to use.

    Returns void

setPrintApp

  • setPrintApp(printAppName: string): Promise<void>

  • Sets the print application to use. For each print app the appropriate capabilities will be load and the manager will be initialized afterwards.

    Parameters

    • printAppName: string

      The name of the application to use.

    Returns Promise<void>

setPrintApps

  • setPrintApps(printApps: string[]): void

  • Sets the supported print applications.

    Parameters

    • printApps: string[]

      The supported print applications to set.

    Returns void

setPrintMapSize

  • setPrintMapSize(printMapSize: PrintMapSize): void

  • Sets the map size to use while printing.

    Parameters

    • printMapSize: PrintMapSize

      The object containing width and height of printed map.

    Returns void

setRotation

  • setRotation(rotation: number): void

  • Rotates the print extent by the amount of the given rotation.

    Parameters

    • rotation: number

      The amount to rotate.

    Returns void

setScale

  • setScale(value: number): void

  • Sets the scale to use. Updates the print extent accordingly.

    Parameters

    • value: number

      The value of the scale to use.

    Returns void

shutdownManager

un

  • un(name: string, callback: (data: any) => void): void

  • Unregisters an event.

    Parameters

    • name: string

      The name of the event to unregister.

    • callback: (data: any) => void

      The callback function to unregister.

    Returns void

updatePrintExtent

  • updatePrintExtent(): void

  • Updates the geometry of the print extent feature to match the current scale.

    Returns void

ProtectedvalidateResponse

  • validateResponse(response: Response): void

  • Validates the given HTTP fetch response.

    Parameters

    • response: Response

      The response to validate.

    Returns void

Protectedwait

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
appendCustomMapParamscalculatePrintExtentcalculateRotationcancelPrintclearCustomMapParamsdispatchdownloadfilterPrintableLayerfilterPrintableLegendgetAttributeByNamegetBasePathgetClosestScaleToFitExtentFeaturegetClosestScaleToFitMapgetCustomMapParamsgetCustomParamgetCustomParamsgetDpigetDpisgetExtentLayergetLayoutgetLayoutByNamegetLayoutsgetOutputFormatgetOutputFormatsgetPrintAppgetPrintAppsgetPrintExtentSizegetPrintJobReferencegetPrintMapSizegetPrintPayloadgetScalegetScalesgetStatusinitinitManagerinitPrintExtentFeatureinitPrintExtentLayerinitTransformInteractionisInitiatedloadAppCapabilitiesloadPrintAppsononExtentLayerPostRenderonExtentLayerPreRenderonTransformScalingpollpollUntilDoneprintresetRotationserializeLayerserializeLegendsetCustomMapParamssetCustomParamsetCustomParamssetDpisetLayoutsetLegendFiltersetOutputFormatsetPrintAppsetPrintAppssetPrintMapSizesetRotationsetScaleshutdownManagerunupdatePrintExtentvalidateResponsewait