class static

plotDataArea.PlotDataArea

Source: thermodynamicDiagram/PlotDataArea.js:206

Abstract class to define an area on the SVG with sounding data.

import PlotDataArea from 'meteojs/thermodynamicDiagram/PlotDataArea';

Properties

coordinateSystem
dataGroupIds
getCoordinatesByLevelData
height
maxExtentLength

minDataPointsDistance
minExtentLength
style
svgNode
visible

width
x
y

Methods

_drawBackground(svgNode)
_initHoverLabels(options)
addSounding(sounding)
addTo(svgNode)
drawBackground(svgNode)

drawSounding(sounding, group)
drawSoundings()
getExtendedEvent(e, p)
init()
onChangeSoundingVisibility(sounding, group)

onCoordinateSystemChange()
removeSounding(sounding)
setDisplayOfSounding(sounding, group)

new PlotDataArea(options)

Parameter

Name	Type	Optional	Description
options			Options.

Extends: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea
Fires: module:meteoJS/thermodynamicDiagram/plotDataArea#add:sounding; module:meteoJS/thermodynamicDiagram/plotDataArea#remove:sounding; module:meteoJS/thermodynamicDiagram/plotDataArea#prebuild:sounding; module:meteoJS/thermodynamicDiagram/plotDataArea#postbuild:sounding

Properties

public

coordinateSystem unknown

Coordinate system.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#coordinateSystem

read-only

dataGroupIds Array of string

Groups of different data to plot onto the plot area.

read-only

getCoordinatesByLevelData module:meteoJS/thermodynamicDiagram/plotDataArea~getCoordinatesByLevelData

Returns x and y coordinated of some sounding data.

public

height unknown

Height of the area.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#height

read-only

maxExtentLength unknown

Maximal extent length (either width or height).

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#maxExtentLength

minDataPointsDistance number

Minimum distance between data points in pixels.

read-only

minExtentLength unknown

Minimal extent length (either width or height).

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#minExtentLength

public

style unknown

Overflow-style of the area.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#style

public read-only

svgNode unknown

SVG container node.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#svgNode

public

visible unknown

Visibility of the area.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#visible

public

width unknown

Width of the area.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#width

public

x unknown

X of the top-left edge.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#x

public

y unknown

Y of the top-left edge.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#y

Methods

protected

_drawBackground(svgNode)

Method to inherit from child classes to draw the background of the plot area.

This method is only called, when this.coordinateSystem isn't undefined.

Parameter

Name	Type	Optional	Description
svgNode			SVG group, SVG.G.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#_drawBackground

_initHoverLabels(options)

Initialize hover labels options.

Parameter

Name	Type	Optional	Description
options	module:meteoJS/thermodynamicDiagram/plotDataArea~hoverLabelsOptions		Hover labels options.

addSounding(sounding)

Adds a sounding to draw into the area.

Parameter

Name	Type	Optional	Description
sounding	module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSounding		Sounding object.

addTo(svgNode)

Sets the plot area as a child of the argument.

Parameter

Name	Type	Optional	Description
svgNode			SVG node.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#addTo

protected

drawBackground(svgNode)

Draw background into SVG group.

This method is only called, when this.coordinateSystem isn't undefined.

Parameter

Name	Type	Optional	Description
svgNode			SVG group, SVG.G.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#drawBackground

protected

drawSounding(sounding, group)

Draw the sounding into the SVG group.

Parameters

Name	Type	Optional	Description
sounding	module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSounding		Sounding object.
group	external:SVG		SVG group, SVG.G.

protected

drawSoundings()

Draws all soundings.

protected

getExtendedEvent(e, p)

Extend an event with some properties.

Parameters

Name	Type	Optional	Description
e			Event.
p			Point.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#getExtendedEvent

protected

init()

Init the area.

Inherited from: module:meteoJS/thermodynamicDiagram/plotArea.PlotArea#init

protected

onChangeSoundingVisibility(sounding, group)

Called, when a sounding changes its visibilty.

Parameters

Name	Type	Optional	Description
sounding	module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSounding		Sounding object.
group	external:SVG		SVG group, SVG.G.

onCoordinateSystemChange()

Called, when the coordinateSystem object changes.

removeSounding(sounding)

Removes a sounding from the area.

Parameter

Name	Type	Optional	Description
sounding	module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSounding		Sounding object.

protected

setDisplayOfSounding(sounding, group)

Sets 'display' property of a SVG group of a sounding, depending of the sounding's visibility.

Parameters

Name	Type	Optional	Description
sounding	module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSounding		Sounding object.
group	external:SVG		SVG group, SVG.G.