Home Reference Source Repository

Typedef

Static Public Summary
public

A coverage data layer.

public

The afterAdd event, signalling that the data layer is initialized and was added to the map.

public

The axisChange event, signalling that an axis coordinate has changed.

public

The dataLoad event, signalling that data loading has finished (also in case of errors).

public

The dataLoading event, signalling that data loading has started.

public

The error event, signalling that data loading has failed.

public

The change event, signalling that a different dropdown element has been selected.

public

MultiPolygon#click: L.MouseEvent

The click event, signalling that a polygon has been clicked.

public

The change event, signalling that a different vertical coordinate value has been selected.

public

The paletteChange event, signalling that the palette has changed.

public

The paletteExtentChange event, signalling that the palette extent has changed.

public

Point#click: L.MouseEvent

The click event, signalling that the point has been clicked.

public

A coverage point-like data layer.

public

The change event, signalling that a different time entry has been selected.

public

The change event, signalling that a different vertical coordinate value has been selected.

Static Public

public DataLayer: L.Layer source

A coverage data layer.

The options object of the constructor supports at a minimum the parameter property which is the key of the coverage parameter to visualize. All currently implemented classes also support the palette and paletteExtent properties. All classes except Grid support the defaultColor property to specify the no-data color.

Properties:

NameTypeAttributeDescription
coverage Coverage
parameter Parameter
getBounds() function(): L.LatLngBounds

public DataLayer#afterAdd: L.Event source

The afterAdd event, signalling that the data layer is initialized and was added to the map. Only after this event was fired, other elements like legends or axis controls may be added. The event ensures that the necessary coverage data has been loaded.

public DataLayer#axisChange: L.Event source

The axisChange event, signalling that an axis coordinate has changed.

Properties:

NameTypeAttributeDescription
axis string

The axis that changed. Corresponds to a property of the same name in the data layer. For example, 'time' or 'vertical'.

public DataLayer#dataLoad: L.Event source

The dataLoad event, signalling that data loading has finished (also in case of errors).

public DataLayer#dataLoading: L.Event source

The dataLoading event, signalling that data loading has started.

public DataLayer#error: L.Event source

The error event, signalling that data loading has failed.

public Dropdown#change: L.Event source

The change event, signalling that a different dropdown element has been selected.

Properties:

NameTypeAttributeDescription
value string

The value of the selected item.

public MultiPolygon#click: L.MouseEvent source

The click event, signalling that a polygon has been clicked.

Properties:

NameTypeAttributeDescription
index number

The axis index of the polygon that was clicked.

latlng L.LatLng

The geographical point where the click event occured.

public Palette: Object source

The change event, signalling that a different vertical coordinate value has been selected.

Properties:

NameTypeAttributeDescription
steps number

The number of colors in the palette.

red Array<number>

Array of integers in [0,255] of length steps.

green Array<number>

Array of integers in [0,255] of length steps.

blue Array<number>

Array of integers in [0,255] of length steps.

public PaletteMixin#paletteChange: L.Event source

The paletteChange event, signalling that the palette has changed.

public PaletteMixin#paletteExtentChange: L.Event source

The paletteExtentChange event, signalling that the palette extent has changed.

public Point#click: L.MouseEvent source

The click event, signalling that the point has been clicked.

Properties:

NameTypeAttributeDescription
coverage Coverage
latlng L.LatLng

The geographical point where the click event occured.

public PointDataLayer: DataLayer source

A coverage point-like data layer.

Properties:

NameTypeAttributeDescription
getValue() function

Return the displayed value (number, or null for no-data), or undefined if no parameter is set.

_getColor(val) function

Returns a CSS color string or an {r: number, g: number, b: number} array for the given data value.

getLatLng() function

Returns the geographical position of the coverage.

showNoData boolean

Whether to draw the point if there is no data.

public TimeAxis#change: L.Event source

The change event, signalling that a different time entry has been selected.

Properties:

NameTypeAttributeDescription
time Date

The time that has been selected.

public VerticalAxis#change: L.Event source

The change event, signalling that a different vertical coordinate value has been selected.

Properties:

NameTypeAttributeDescription
vertical number

The vertical coordinate value that has been selected.