Home Reference Source Repository
import {PointSeries} from 'leaflet-coverage/'
public class | source

PointSeries

Renderer for Coverages conforming to the CovJSON domain type PointSeries.

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 if a parameter is chosen.

See:

Example:

var cov = ... // get Coverage data
var layer = new C.PointSeries(cov, {
  parameter: 'salinity',
  time: new Date('2015-01-01T12:00:00Z'),
  defaultColor: 'black',
  palette: C.linearPalette(['#FFFFFF', '#000000'])
})

Constructor Summary

Public Constructor
public

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

An optional time axis target value can be defined with the 'time' property.

Member Summary

Public Members
public get

The coverage object associated to this layer.

public get

The parameter that is visualized.

public set

Sets the currently active time to the one closest to the given Date object.

public get

The currently active time on the temporal axis as Date object, or undefined if no time is set.

public get

The time slices that make up the coverage.

Method Summary

Public Methods
public

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

public

Returns the geographical position of the coverage.

public

Return the displayed value (number, or null for no-data), or undefined if not fixed to a t-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 time axis target value can be defined with the 'time' property. The closest values on the time axis is chosen.

Params:

NameTypeAttributeDescription
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.time Date
  • optional

The initial time step 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 set time: Date | undefined source

Sets the currently active time to the one closest to the given Date object.

public get time: Date | undefined source

The currently active time on the temporal axis as Date object, or undefined if no time is set.

public get timeSlices: Array<Date> source

The time 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 t-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:

NameTypeAttributeDescription
latlng L.LatLng
maxDistance number

Maximum distance in meters between both points.

Return:

number | null | undefined