API Docs

This page provides TypeScript/JavaScript API documentation for protomaps.js.

If you're getting started with web cartography, read the guides and check out the demos first.

Organization

lorem

import {PolygonSymbolizer} from "protomaps";
              ...
              new PolygonSymbolizer( { fill: 'blue' });

This docs site is based on @williamngan's Pts project. See its repository for Apache license and copyright info.

{{ contents.name }}

{{ contents.kind }} extends {{ contents.extends.join(", ") }} implements {{ contents.implements.join(", ") }} in {{contents.source[0][0]}}

Constructor

new {{ contents.name }} ( {{ params(m.signatures) }} )

parameters
{{ p.name }}: {{ p.type }} (default value: {{ p.default }})
returns
An instance of {{ contents.name }}
{{se.tag}}
source
Overrides {{ m.overrides }} Inherited from {{ m.inherits }} in {{m.source[0][0]}}

Internal Properties

{{ m.name }}

Overrides {{ m.overrides }} Inherited from {{ m.inherits }} in {{m.source[0][0]}}

{{ m.name }}

Overrides {{ m.overrides }} Inherited from {{ m.inherits }} in {{m.source[0][0]}}

Accessors

GET SET {{ m.name }} : {{ m.getter.type || m.setter.parameters.type || "" }}

Overrides {{ m.overrides }} Inherited from {{ m.inherits }} in {{m.source[0][0]}}

Methods

STATIC {{ m.name }} ( {{ params(m.signatures) }} )

parameters
{{ p.name }}: {{ p.type }} (default value: {{ p.default }})
returns
{{ s.returns }}
{{se.tag}}
source
Overrides {{ m.overrides }} Inherited from {{ m.inherits }} in {{m.source[0][0]}}

Type Alias

equivalent to