import {VerticalProfile} from 'leaflet-coverage/'

public class | source

VerticalProfile

Mixin Extends:

L.Layer, CoverageMixin, CircleMarkerMixin, PaletteMixin

Implements:

Renderer for Coverages conforming to the CovJSON domain type VerticalProfile.

This will simply display a dot on the map and fire a click event when a user clicks on it. The dot either has a defined standard color, or it uses a palette together with a target depth if a parameter is chosen.

See:

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

Example:

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

Constructor Summary

Public Constructor
public	constructor(cov: Coverage \| Domain, options: Object) An optional vertical axis target value can be defined with the 'vertical' property.

Member Summary

Public Members
public get	coverage: Coverage The coverage object associated to this layer.
public get	parameter: Parameter The parameter that is visualized.
public get	vertical: number \| undefined The currently active vertical coordinate, or undefined if no coordinate is set.
public set	vertical: number \| undefined Sets the currently active vertical coordinate to the one closest to the given value.
public get	verticalSlices: Array<number> The vertical slices that make up the coverage.

Method Summary

Public Methods
public	getBounds(): L.LatLngBounds Returns the geographic bounds of the coverage, which is a degenerate box collapsed to a point.
public	getLatLng(): L.LatLng Returns the geographical position of the coverage.
public	getValue(): number \| null \| undefined Return the displayed value (number, or null for no-data), or undefined if not fixed to a z-coordinate or parameter.
public	getValueAt(latlng: L.LatLng, maxDistance: number): number \| null \| undefined Return the displayed value if within the given distance of the reference point.

Public Constructors

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

An optional vertical axis target value can be defined with the 'vertical' property. The closest values on the vertical axis is chosen.

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.vertical	number	optional	The initial vertical slice to display.
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.
options.showNoData	boolean	optional default: false	Whether to draw the point if there is no data.

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 get vertical: number | undefined source

The currently active vertical coordinate, or undefined if no coordinate is set.

public set vertical: number | undefined source

Sets the currently active vertical coordinate to the one closest to the given value.

public get verticalSlices: Array<number> source

The vertical slices that make up the coverage.

Public Methods

public getBounds(): L.LatLngBounds source

Returns the geographic bounds of the coverage, which is a degenerate box collapsed to a point.

Return:

L.LatLngBounds

public getLatLng(): L.LatLng source

Returns the geographical position of the coverage.

Return:

L.LatLng

public getValue(): number | null | undefined source

Return the displayed value (number, or null for no-data), or undefined if not fixed to a z-coordinate or parameter.

Return:

number | null | undefined

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

Return the displayed value if within the given distance of the reference point. If out of bounds, then undefined is returned, otherwise a number or null (for no data).

Params:

Name	Type	Attribute	Description
latlng	L.LatLng
maxDistance	number		Maximum distance in meters between both points.

Return:

number | null | undefined