import {MultiPolygon} from 'leaflet-coverage/'

public class | source

MultiPolygon

Mixin Extends:

L.Layer, CoverageMixin, PaletteMixin

Implements:

DataLayer

Renderer for Coverages and Domains conforming to CovJSON domain type MultiPolygon.

See:

https://covjson.org/domain-types/#multipolygon

Example:

var cov = ... // get Coverage data
var layer = new C.MultiPolygon(cov, {
  parameter: 'salinity',
  defaultColor: 'black',
  palette: C.linearPalette(['#FFFFFF', '#000000'])
})

Constructor Summary

Public Constructor
public	constructor(cov: Coverage \| Domain, options: Object) The key of the parameter to display can be given in the 'parameter' options property, it will be ignored if the coverage data object is a Domain object.

Member Summary

Public Members
public get	coverage: Coverage The coverage object associated to this layer.
public get	parameter: Parameter The parameter that is visualized.

Method Summary

Public Methods
public	getBounds(): L.LatLngBounds Returns the geographic bounds of the coverage.
public	getLatLng(): L.LatLng Returns the geographical center position of the coverage based on its bounding box.
public	getValueAt(latlng: L.LatLng): number \| null \| undefined Return the displayed value at a given geographic position.
public	redraw() Redraw the layer.

Public Constructors

public constructor(cov: Coverage | Domain, options: Object) source

The key of the parameter to display can be given in the 'parameter' options property, it will be ignored if the coverage data object is a Domain object.

Params:

Name	Type	Attribute	Description
cov	Coverage \| Domain		The coverage or domain object to visualize.
options	Object	optional	The options object.
options.parameter	string	optional	The key of the parameter to display, not needed for domain objects.
options.palette	Palette	optional	The initial color palette to use, the default depends on the parameter type.
options.paletteExtent	string	optional default: 'full'	The initial palette extent, either 'full' or specific: [-10,10].
options.defaultColor	string	optional default: 'black'	The color to use for missing data or if no parameter is set.

Public Members

public get coverage: Coverage source

The coverage object associated to this layer.

public get parameter: Parameter source

The parameter that is visualized.

Public Methods

public getBounds(): L.LatLngBounds source

Returns the geographic bounds of the coverage.

Return:

L.LatLngBounds

public getLatLng(): L.LatLng source

Returns the geographical center position of the coverage based on its bounding box.

Return:

L.LatLng

public getValueAt(latlng: L.LatLng): number | null | undefined source

Return the displayed value at a given geographic position. If out of bounds, then undefined is returned, otherwise a number or null (for no data).

Params:

Name	Type	Attribute	Description
latlng	L.LatLng

Return:

number | null | undefined

public redraw() source

Redraw the layer.