Map MapOptions

Description

User defined configuration options for the map.

At a minimum, you probably want to define a StyleDefinition and an HTML element container.

ex.

import { S2Map } from 's2maps-gpu'; // or you can access it via the global `window.S2Map`
import type { MapOptions, StyleDefinition } from 's2maps-gpu';

// build a style guide of sources to fetch and layers to render
const style: StyleDefinition = { ... };
// setup options for the map
const options: MapOptions = {
  container: 'map', // the ID of the HTML element to render the map into
  // reference a canvas instead of a container:
  // canvas: userPulledCanvasElement
  style,
}
// Build the map
const map = new S2Map(options);
Copy

Rendering Options

• contextType: [See GPUType] Forces the use of specific GPU Context:
  • 1: WebGL
  • 2: WebGL2
  • 3: WebGPU
• offscreen: Support OffscreenCanvas
• canvas: Reference a canvas instead of a container
• container: Can be a reference to an ID (string) or an HTMLElement
• style: [See StyleDefinition] Either the style definition or a string URL pointing to the location of the style definition
• canvasMultiplier: Control the number of fragments per pixel. [default: window.devicePixelRatio]
• darkMode: boolean flag. Enable dark mode. [default: false]

Control Options

• interactive: boolean flag. If true, the map will be interactive with user mouse/keyboard/finger inputs; [default: true]
• scrollZoom: boolean flag. If true, allow user to use scroll wheel to zoom. [default: true]
• positionalZoom: boolean flag. If true, cursor position impacts zoom's x & y directions. [default: true]
• controls: boolean flag. If true, enable default controls; [default: true]
• zoomController: boolean flag. Display zoom controller state. [default: true]
• compassController: boolean flag. Display compass controller state. [default: true]
• colorblindController: boolean flag. Display colorblind controller state. [default: true]
• canZoom: boolean flag. Enable zooming functionality. [default: true]
• canMove: boolean flag. Enable panning/moving functionality. [default: true]
• noClamp: boolean flag. Allow latitude and longitude to pass their limits (-90, 90) and (-180, 180) respectively [default: false]

Additional Options

• hash: If true, the map will update the URL Hash with it's current View. [default: false]
• apiKey: string. API key for the map service.
• urlMap: [See UrlMap] An API URL that remaps any source strings that start with "example://" to whatever example is
  • example: { "apiURL": "https://api.opens2.com" }
• attributions: Set additional attributions to be displayed on the map.
  • example: { "OpenS2": "https://opens2.com/data" }
• attributionOff: boolean flag. Disable attribution display. [default: false]
• watermarkOff: boolean flag. Disable watermark display. [default: false]