Skip to content

Overview

Overview is the overview (minimap) control. It extends Control. It shows a small thumbnail on the map to give an overview of a large map area and indicates the current viewport position, with support for maximize/minimize toggling.

js
import { Overview } from "maptalks";

const overview = new Overview({
  size: [300, 200],
  maximize: false
}).addTo(map);

Constructor

js
new Overview(options)

Parameters:

  • options — Overview control options.

options

NameTypeDescriptionDefault
levelNumberThe zoom level of the overview map4
sizeNumber[]The size of the overview control [width, height][300, 200]
maximizeBooleanWhether to be maximized by defaulttrue
symbolObjectThe symbol of the overview view framenull
containerClassStringThe CSS class of the container'maptalks-overview'

Member Methods

  • maxmize(): Overview — Maximizes the overview control.
  • minimize(): Overview — Minimizes the overview control.
  • getOverviewMap(): Map — Gets the overview map object.

Events

  • load — Fired when the overview map finishes loading.