meteoJS/thermodynamicDiagramPluggable . ThermodynamicDiagramPluggable
Source: ThermodynamicDiagramPluggable.
Class to draw a SVG thermodynamic diagram.
import ThermodynamicDiagramPluggable from 'meteojs/thermodynamicDiagramPluggable';
new ThermodynamicDiagramPluggable(options)
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
options |
|
|
Options. |
Properties
count unknown
Count of the items in this collection.
- Inherited from
- module:meteoJS/base/collection.Collection#count
itemIds unknown
List of IDs (ordered list).
- Inherited from
- module:meteoJS/base/collection.Collection#itemIds
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
svgNode external:SVG
SVG object of the complete diagram.
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. |
- Returns
-
module:meteoJS/thermodynamicDiagram/diagramSounding.DiagramSoundingSounding 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. |
- 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. |
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 |
module:meteoJS/thermodynamicDiagram/coordinateSystem.CoordinateSystem |
|
Coordinate system. |
|
formerCoordinateSystem |
module:meteoJS/thermodynamicDiagram/coordinateSystem.CoordinateSystem |
Yes |
Coordinate system. |
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. |
- 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. |