|
1 | 1 | # Style provider |
2 | 2 |
|
3 | | -The `StylelProvider` interface provides a way to customize the appearance of the network-area diagram. |
| 3 | +The `StyleProvider` interface provides a way to customize the appearance of the network-area diagram. |
4 | 4 |
|
5 | 5 | Regarding nodes and bus nodes, the color and the blinking is fully customizable. |
6 | 6 | Regarding edges, the color, the width, the stroke and the blinking is also fully customizable |
7 | 7 |
|
8 | 8 | Currently, there are 2 implementations of the `StyleProvider`: the `NominalStyleProvider` and the `TopologicalStyleProvider` |
9 | 9 |
|
10 | | -## Common features: `AbstractStyleProvider` and `AbstractVoltageStyleProvider` |
| 10 | +## Common features |
| 11 | +The common features are factorized in the abstract classes `AbstractStyleProvider` and `AbstractVoltageStyleProvider`. |
11 | 12 |
|
12 | 13 | ### Overvoltage and undervoltage voltage levels |
13 | | -TODO |
| 14 | +- Bus nodes which are over-voltage (meaning their voltage is above the voltage level high voltage limit) have their corresponding ring marked with class `nad-overvoltage`. |
| 15 | +If default CSS is used, this leads to the corresponding ring stroke blinking in orange. |
| 16 | +- Similarly, for bus nodes which are under-voltage (meaning their voltage is below the voltage level low voltage limit); they have their corresponding ring marked with class `nad-undervoltage`. |
| 17 | +If default CSS is used, this leads to the corresponding ring stroke blinking in blue. |
14 | 18 |
|
15 | 19 | ### Overloaded lines |
16 | | -TODO |
| 20 | +Branches which are overloaded are marked with class `nad-overload`. If default CSS is used, this leads to a branch yellow-blinking. |
17 | 21 |
|
18 | 22 | ### Subnetworks |
19 | | - |
20 | | -If the SvgParameters attribute `highlightSubnetworks` is set to `true`, subnetworks are highlighted in the network-area diagram: |
| 23 | +If the SvgParameters attribute `highlightGraph` is set to `true`, the highlight classes for voltage level nodes and branches are based on the corresponding subnetwork. |
| 24 | +With default CSS used, this leads to subnetworks being highlighted: |
21 | 25 |  |
22 | 26 |
|
| 27 | +## NominalStyleProvider feature |
| 28 | +The voltage level nodes are marked with a class depending on their nominal voltage, leading to one colour for each range of nominal voltages defined by the BaseVoltagesConfig. |
| 29 | + |
| 30 | +## TopologicalStyleProvider feature |
| 31 | +The bus nodes of a voltage level are each marked with a class depending on the nominal voltage and on their bus index. |
| 32 | +This leads to a colour shading for each range of nominal voltages defined by the BaseVoltagesConfig. |
| 33 | +The text node of corresponding voltage level gives a legend for the colour shading, based on the selected given `LabelProvider` - the default being the voltage and angle. |
0 commit comments