class static

meteoJS/thermodynamicDiagram.ThermodynamicDiagram

Class to draw a SVG thermodynamic diagram.

import ThermodynamicDiagram from 'meteojs/ThermodynamicDiagram';

Properties

coordinateSystem
count
itemIds

items
options
sortFunction

svgNode

Methods

addSounding(sounding[, options])
append(...items)
appendPlotArea(plotArea)
contains(item)

containsId(id)
exchangeCoordinateSystem(coordinateSystem[, formerCoordinateSystem])
getDiagramPlotArea()
getItemById(id)

remove(...items)
removeById(id)
removePlotArea(plotArea)

new ThermodynamicDiagram(options)

Parameter

Name	Type	Optional	Description
options			Options.

Extends: module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable

Properties

public

coordinateSystem module:meteoJS/thermodynamicDiagram/coordinateSystem.CoordinateSystem

Coordinate system for the different plot areas.

read-only

count unknown

Count of the items in this collection.

Inherited from: module:meteoJS/base/collection.Collection#count

read-only

itemIds unknown

List of IDs (ordered list).

Inherited from: module:meteoJS/base/collection.Collection#itemIds

read-only

items unknown

Items (ordered list).

Inherited from: module:meteoJS/base/collection.Collection#items

options unknown

Inherited from: module:meteoJS/base/collection.Collection#options

sortFunction unknown

Sort function for the items.

Inherited from: module:meteoJS/base/collection.Collection#sortFunction

read-only

svgNode unknown

SVG object of the complete diagram.

Inherited from: module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable#svgNode

Methods

addSounding(sounding[, options]) → module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSounding

Add a sounding to the diagram.

Parameters

Name	Type	Optional	Description
sounding			Sounding object.
options		Yes	Display options.

Inherited from: module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable#addSounding
Returns: Sounding object for the diagram with display options.

append(...items) → module:meteoJS/base/collection.Collection

Append an item to the collection.

Parameter

Name	Type	Optional	Description
items			New items. Value can be repeated.

Name

Type

Optional

Description

items

New items.

Value can be repeated.

Inherited from: module:meteoJS/base/collection.Collection#append
Fires: module:meteoJS/base/collection#add:item; module:meteoJS/base/collection#remove:item; module:meteoJS/base/collection#replace:item
Returns: This.

appendPlotArea(plotArea) → module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable

Appends a PlotArea object to this thermodynamic diagram.

Parameter

Name	Type	Optional	Description
plotArea			PlotArea object.

Inherited from: module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable#appendPlotArea
Returns: This.

contains(item) → boolean

Is item appended to the collection.

Parameter

Name	Type	Optional	Description
item			Item.

Inherited from: module:meteoJS/base/collection.Collection#contains
Returns: If appended.

containsId(id) → boolean

Exists an ID in this collection.

Parameter

Name	Type	Optional	Description
id			ID.

Inherited from: module:meteoJS/base/collection.Collection#containsId
Returns: If exists.

exchangeCoordinateSystem(coordinateSystem[, formerCoordinateSystem])

Exchanges the coordinate system in the PlotArea objects. The optional, second argument defines an already used coordinate system. If this argument is passed, only the coordinate system of the PlotArea's with this coordinate system will exchanged.

Parameters

Name	Type	Optional	Description
coordinateSystem			Coordinate system.
formerCoordinateSystem		Yes	Coordinate system.

Inherited from: module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable#exchangeCoordinateSystem

getDiagramPlotArea() → module:meteoJS/thermodynamicDiagram/tdDiagram.TDDiagram

Returns the object of the thermodynamic diagram plot area.

Deprecated
Returns: module:meteoJS/thermodynamicDiagram/tdDiagram.TDDiagram Diagram object.

getItemById(id) → module:meteoJS/base/unique.Unique

Returns item by ID, Unique-Object with undefined id, if ID doesn't exist.

Parameter

Name	Type	Optional	Description
id			ID.

Inherited from: module:meteoJS/base/collection.Collection#getItemById
Returns: Item.

remove(...items) → module:meteoJS/base/collection.Collection

Removes an item from the collection.

Parameter

Name	Type	Optional	Description
items			Items to remove. Value can be repeated.

Name

Type

Optional

Description

items

Items to remove.

Value can be repeated.

Inherited from: module:meteoJS/base/collection.Collection#remove
Fires: module:meteoJS/base/collection#remove:item
Returns: This.

removeById(id) → module:meteoJS/base/collection.Collection

Removes an item by ID from the collection.

Parameter

Name	Type	Optional	Description
id			ID of the item to delete.

Inherited from: module:meteoJS/base/collection.Collection#removeById
Fires: module:meteoJS/base/collection#remove:item
Returns: This.

removePlotArea(plotArea) → module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable

Removes a PlotArea object from this thermodynamic diagram.

Parameter

Name	Type	Optional	Description
plotArea			PlotArea object.

Inherited from: module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable#removePlotArea
Returns: This.