This is a base module for energy storage visualizer simple modules.
See also: EnergyStorageCanvasVisualizer, EnergyStorageOsgVisualizer, IEnergyStorageVisualizer, VisualizerBase
The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.
The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.
Name | Type | Description |
---|---|---|
VisualizerBase | simple module |
This is a base module for visualizer simple modules. It simply provides the visualization target module for derived modules. |
Name | Type | Description |
---|---|---|
EnergyStorageCanvasVisualizer | simple module |
This module visualizes energyStorages on a 2D canvas. |
EnergyStorageOsgVisualizer | simple module |
This module visualizes energyStorages on a 3D osg scene. |
Name | Type | Default value | Description |
---|---|---|---|
visualizerTargetModule | string | " |
module path relative to the visualizer where the visualization should appear in the user interface, root module by default |
tags | string | "" |
tag added to each visualization for disambiguation in the runtime environment |
networkNodeVisualizerModule | string | "^.networkNodeVisualizer" |
module path to the network node visualizer module, refers to a sibling submodule by default |
displayEnergyStorages | bool | false | |
energyStorageFilter | string | "**" |
which energy storages are considered, matches all energy storages by default |
color | string | "green" | |
width | double | 8 | |
height | double | 24 | |
spacing | double | 2 | |
displacementHint | string | "right" |
annotation displacement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. |
displacementPriority | double | 0 |
determines the order of annotation positioning |
Name | Value | Description |
---|---|---|
class | EnergyStorageVisualizerBase | |
display | i=block/app_s |
// // This is a base module for energy storage visualizer simple modules. // // @see ~EnergyStorageCanvasVisualizer, ~EnergyStorageOsgVisualizer, ~IEnergyStorageVisualizer, ~VisualizerBase // simple EnergyStorageVisualizerBase extends VisualizerBase { parameters: string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default bool displayEnergyStorages = default(false); string energyStorageFilter = default("**"); // which energy storages are considered, matches all energy storages by default string color = default("green"); double width = default(8); double height = default(24); double spacing = default(2); string displacementHint = default("right"); // annotation displacement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. double displacementPriority = default(0); // determines the order of annotation positioning @class(EnergyStorageVisualizerBase); }