Export

Scope

The Export plugin offers users to download the currently visible map canvas in a variety of file formats and by a variety of methods.

Configuration

export

| fieldName | type | description | | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | showJpg | boolean | Tools offers current map view as JPG. | | showPdf | boolean | Tools offers current map view as PDF. | | showPng | boolean | Tools offers current map view as PNG. | | download | boolean | Whether file is offered for download. By default, no download will happen, and the using service is supposed to register whether a "screenshot" has been taken and react accordingly. |

Store

To remove user control, add displayComponent: false to the configuration and use the following interactions.

Actions

To programmatically trigger a "screenshot", use this action.

// type is 'Png', 'Jpg', or 'Pdf'
map.$store.dispatch('plugin/export/exportAs', type)

State

This shows how a callback can be used to immediately show a Png screenshot in an image tag. The value of the screenshot variable is a base64-encoded string.

const someImgTag = // ... however you retrieve your tag
  map.subscribe('plugin/export/exportedMap', (screenshot) =>
    someImgTag.setAttribute('src', screenshot)
  )