Skip to content

ExportImage

Take a screenshot of the current map part and generate a pictureBase64String.

illustrate

Example

The captured targets when taking screenshots only include:

  • map base map
  • Layers (excluding MarkerLayer)

Note: Since the current map base map corresponds toCanvasThe buffer is enabled by default, so the basemap portion of the map cannot be captured by default.

Therefore, if the developer needs the complete screenshot capability, the following parameters should be passed when initializing the map instance to turn it off.Canvasbuffer.

new GaodeMapV2({
  WebGLParams: {
    preserveDrawingBuffer: true,
  },
});

new Mapbox({
  preserveDrawingBuffer: true,
});

use

import { Scene, ExportImage } from '@antv/l7';

const scene = new Scene({
  id: 'map',
  map: new GaodeMapV2({
    // Close the map buffer, otherwise the map part cannot be captured when taking screenshots
    WebGLParams: {
      preserveDrawingBuffer: true,
    },
  }),
});

scene.on('loaded', () => {
  const zoom = new ExportImage({
    onExport: (base64: string) => {
      // download(base64)
    },
  });
  scene.addControl(zoom);
});

Configuration

name illustrate type
imageType Screenshot image format 'png'|'jpeg'
onExport After the screenshot is successfully taken, it is used to receive the pictureBase64String callback function (base64: string) => void
名称 说明 类型
btnIcon 按钮图标 HTMLElement | SVGElement
btnText 按钮内容文本 string
title 按钮的 title 属性 string
vertical 在 btnIcon 有值的情况下,按钮内的图标和文案是否纵向排列 boolean
名称 说明 类型
position 控件被添加到地图中的位置以及排列方式,详情可见 控件插槽 Position
className 自定义样式名 string
style 自定义样式 string

Position

export type Position =
  | 'topleft' // ↖ 左上角,纵向排列
  | 'lefttop' // ↖ 左上角,横向排列
  | 'topright' // ↗ 右上角,纵向排列
  | 'righttop' // ↗ 右上角,横向排列
  | 'bottomleft' // ↙ 左下角,纵向排列
  | 'leftbottom' // ↙ 左下角,横向排列
  | 'bottomright' // ↘ 右下角,纵向排列
  | 'rightbottom' // ↘ 右下角,横向排列
  | 'topcenter' // ↑ 上方中央,横向排列
  | 'bottomcenter' // ↓ 下方中间,横向排列
  | 'leftcenter' // ← 左边中间,纵向排列
  | 'rightcenter' // → 右边中间,纵向排列
  | Element; // 传入 DOM 作为当前控件的容器

method

name illustrate type
getImage Get the Base64 string of the screenshot () => Promise<string>
name illustrate type
setOptions Update configuration, parameters need to refer to the corresponding componentConfiguration (newOption: Partial<Option>) => void
getOptions Get currentConfiguration () => Option
show display component () => void
hide Hidden component () => void
getContainer Get the information corresponding to the current controlDOMcontainer () => HTMLElement

event

Name Description Type
add Event when component is added (this) => void
remove Event when component is removed (this) => void
show Events when the component is displayed (this) => void
hide Event when component is hidden (this) => void
© Copyright 2026 Ant Group Co., Ltd..备案号:京ICP备15032932号-38
Site search
Documentation and examplesType to start searching

Search documentation, APIs, and examples

↑↓Select↵OpenEscClose