Migration guide v5.2.0

NAD

Invisible fields metadata

Starting from this release, users manipulating the network-area diagram metadata needs to take into account

• the "invisible" field for node metadata
• the "invisible1" and "invisible2" fields for edge metadata

Middle EdgeInfo

Starting from this release, information can be displayed on the middle of the edge in the same way as on each end, that is, not only a label, but an arrow with information on both sides of the arrow, possibly of different type. To this end,

• EdgeInfo now takes two infoType: infoTypeA and infoTypeB, corresponding to the type of each label, which have been renamed from internalLabel (resp. externalLabel) to labelA (resp. labelB),
• the method List<String> getEdgeInfoStyleClasses(EdgeInfo info) of the StyleProvider API has been replaced by List<String> getEdgeInfoStyleClasses(String infoType), as the type (and therefore styling) might be different for each side of the arrow,
• the arrow takes the style of side B (from infoTypeB) if non-null, of side A (from infoTypeA) otherwise,
• the method String getBranchLabel(String branchId) of the LabelProvider API has been replaced by Optional<EdgeInfo> getBranchEdgeInfo(String branchId, String branchType). If you were returning a label in your LabelProvider implementation, replace it with an EdgeInfo with a null direction, and only one of the two labels non-null (labelA or labelB),
• the SvgParameters fields edgeNameDisplayed, idDisplayed, substationDescriptionDisplayed, busLegend, voltageLevelDetails, edgeInfoDisplayed have been removed and replaced by parameters for the DefaultLabelProvider only:
  • edgeNameDisplayed and edgeInfoDisplayed have been replaced by DefaultLabelProvider.EdgeInfoEnum enums in a DefaultLabelProvider.EdgeInfoParameters record: infoSideInternal/infoSideExternal for the type of information to display on each end of the edges, infoMiddleSide1/infoMiddleSide2 for the type of information do display on each side of the middle arrow,
  • idDisplayed, substationDescriptionDisplayed, busLegend, voltageLevelDetails have been moved into a LabelProviderParameters class, which may be given to DefaultLabelProvider constructor.

I you were manipulating the SVG itself, you now need to take into account the fact that the middle edge information (which may correspond to the previous edge label if any) is drawn with the other EdgeInfo.

New "ThreeWtPstEdge" edge type

Starting from this release, the users manipulating the network-area diagram metadata should expect to receive the type "ThreeWtPstEdge" for edges, while "PstEdge" is only for phase-shift (two-winding) transformers.

EdgeRouting simplified for parallel edges

Starting from this release, the middle edge of a group of parallel edges contains 3 points like other parallel edges, instead of 2 points previously. Therefore, there should be no specific code for that edge if manipulating its content in the network-area diagram SVG.