Search

GeoJsonLayer

The GeoJSON layer uses the GeoJSON data format to draw geometric objects over the map. See the GeoJSON Layer docs for details.

GeoJsonLayer

new GeoJsonLayer(def)

Creates a new instance of the layer.

Parameters

def
optional
object

The layer definition object.

data

optional
GeoJsonLayerData

Initial data to load into this layer. Data can be changed after instantiation via layer.data().

id

optional
string

A unique identifier for this layer. If omitted one will be generated automatically.

options

optional
GeoJsonLayerOptions

Initial options to set on this layer. Options can be changed after instantiation via layer.options() or layer.resetOptions().

visible

optional
boolean

Initial visibility of this layer. Visibility can be changed after instantiation via layer.visible().

Returns GeoJsonLayer

id

readonly
string

A unique id of the layer.

data(data)

Gets or sets the current data for this layer.

Parameters

data
optional
GeoJsonLayerData

The layer data to be displayed.

Returns GeoJsonLayerData

A reference to the data object it was most recently passed.

getBounds(ids)

Gets the bounds of the items in the layer with the specified ids, or all items if no ids are specified. Returns null if there are no items to compute bounds for.

Parameters

ids
optional
string[]

The ids of the items to get the bounds for.

Returns LngLatBounds

options(options)

Gets or sets the layer options while preserving any previously set options.

Parameters

options
optional
GeoJsonLayerOptions

The layer options to be set.

Returns object

An object containing all layer options and their current values.

overrideStyle(ids, style)

Overrides the style of the specified GeoJSON features.

Parameters

ids
string | string[]

The ids of the GeoJSON features whose style should be overridden.

style
GeoJsonFeatureStyle

The style properties to apply to the specified items.

Returns StyleReset

A reset function that removes the style override.

resetOptions(options)

Sets the provided layer options while resetting any other previously set options to default values.

Parameters

options
optional
GeoJsonLayerOptions

The layer options to be set.

Returns void

visible(state)

Gets or sets the layer visibility.

Parameters

state
optional
boolean

Whether the layer is visible.

Returns boolean

GeoJsonFeatureStyle

Specifies the styling for GeoJSON features. These styles can be overridden with overrideStyle.

const geoJsonData = {
  type: 'Feature',
  id: 'EiffelTower_linestring',
  properties: {
    color: 'rgba(0,0,255,0.7)',    // custom color
    width: 10,                     // custom line width
  },
  geometry: {
    type: 'LineString',
    coordinates: [
      [2.2955, 48.8594],
      [2.2935, 48.8594],
    ],
  },
};

border

optional
object

Defines the border styling for Polygon, MultiPolygon, Point and MultiPoint features.

color

optional
string default: '#404040'

The color of the border.

width

optional
number default: 0

The width of the border. Set the units in units.

color

optional
string default: '#808080'

The fill color for the GeoJSON feature.

radius

optional
number default: 1

The radius for Point and MultiPoint features. Set the units in units.

width

optional
number default: 2

The width for LineString and MultiLineString features. Set the units in units.

GeoJsonLayerData

GeoJsonLayerData GeoJSON | Feature[]

The data describing the geometric object in GeoJSON format. Accepts a single GeoJSON object or an array of GeoJSON feature objects.

const geoJsonData = {
  type: 'Feature',
  id: 'EiffelTower_polygon',
  properties: {
    color: 'rgba(0,255,0,0.3)',
  },
  geometry: {
    type: 'Polygon',       // the polygon is a rectangle around the Eiffel Tower
    coordinates: [
      [
        [2.2935, 48.8574], // bottom-left
        [2.2955, 48.8574], // bottom-right
        [2.2955, 48.8594], // top-right
        [2.2935, 48.8594], // top-left
      ],
    ],
  },
};

GeoJsonLayerOptions

The options to set on this layer.

 const geoJsonOptions = {
   filled: false,
   units: 'pixels'
 };

// ...

mapweave.addLayer(
  new GeoJsonLayer({
    data: geoJsonData,
    options: geoJsonOptions
  }),
);

filled

optional
boolean default: true

Set to true to fill the Polygon, MultiPolygon, Point and MultiPoint features with the color set in color.

units

optional
"meters" | "pixels" default: 'pixels'

Sets the units used for border.width, width and radius.

Terms of use

These terms do not alter or supersede any existing agreements between you (or your employer) and us.

By accessing or using any Content you agree to be bound by these Terms of Use. Please review these terms carefully before using the website.

The contents of this website, including but not limited to any text, code samples, API references, schemas, interactive tools, and other materials (collectively, the 'Content'), are made available for informational and internal evaluation purposes only. All intellectual property rights in the Content are reserved. No licence is granted to use the Content for any commercial purpose, or to copy, distribute, modify, reverse-engineer, or incorporate any part of the Content into any product or service, without our prior written consent.

This Content is provided “as is” and “as available,” without any representations, warranties, or guarantees of any kind, whether express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, non-infringement, or accuracy. To the fullest extent permitted by applicable law, we expressly exclude and disclaim all implied warranties, conditions, and other terms that might otherwise be implied.

We disclaim all liability for any loss or damage, whether direct, indirect, incidental, consequential, or otherwise, arising from any reliance placed on the Content or from your use of it, to the fullest extent permitted by applicable law. By continuing to access or use the Content, you acknowledge and agree to these terms.