FlexDoc/XML - DiagramKit - Parameters
«DiagramKit» parameter group
The parameter group to control DiagramKit. It is equally present in both XSDDoc and WSDLDoc template sets.See also: FlexDoc/XML | DiagramKit | FAQ | Diagram Settings
Parameter | Name / Type / Description |
---|---|
DiagramKit : boolean
Enables DiagramKit.
When this parameter is unselected ( This parameter group is enabled only when DiagramKit plugin is active (has been setup). Related Parameter: |
|
DiagramKit.show
Specify what should be shown in diagrams |
|
DiagramKit.show.annotation : enum {"none", "first_sentence", "full"}
Specify whether to show annotations of XML schema components.
The annotation text is obtained from the
<xs:component> is an XML element defining the XML schema component.
The annotation is typically displayed under the depiction of the component (diagram node).
However, when the component is represented as a panel containing other components, its annotation may be displayed at the top of that panel.
Possible Choices:
The annotation text is wrapped inside a rectangle, whose minimal width is determined by the width of the component node. The actual wrapping width is variable, which is controlled by the nested «Annotations | Wrapping» parameter group. The whitespace contained in the annotation text is collapsed. That is, the successive whitespace characters are reduced to single one, the starting and trailing whitespace is trimmed.
|
|
DiagramKit.show.annotation.renderLineBreaks : boolean
Specify whether to render line break characters ('\n') found within the annotation text.
When this parameter is selected ( Note that successive line breaks will be reduced to single one, and those starting or trailing the text will be trimmed. When this parameter is unselected (false ), all line breaks will be treated just like another whitespace.
|
|
DiagramKit.show.annotation.wrap
The parameter group to control how the annotation text is wrapped. |
|
DiagramKit.show.annotation.wrap.optimize : boolean
Specify whether the annotation text will be wrapped so as to maximally utilize the empty space arisen in the diagram because of its layout, thereby minimizing the bloating of the diagram by annotations themselves. This allows you to make the whole diagram more compact. The optimization is focused on minimizing the annotation wrapping (i.e. maximizing the wrapping widths) without the increase of the widths and horizontal positions of diagram nodes (which should be determined primary by their content, not annotations), thereby leaving the width of the whole diagram unchanged, yet minimizing its height. In some cases, that may be critical to make particularly large diagrams still managable for a human reader. When this parameter is unselected (false ), the wrapping of annotations will be determined only by the widths of their respective component nodes
as well as the setting of the parameter: «Annotations | Wrapping | Minimal Width»
|
|
DiagramKit.show.annotation.wrap.minWidth : integer
Specify the guaranteed minimal width (in pixels) of the rectangle, in which the annotation text is wrapped. In diagram, annotations are typically displayed under the nodes depicting the respective components. So, the width into which the annotation is wrapped is never smaller than the width of its component node. However, some component nodes may be too small (narrow) to serve as a base for the annotation wrapping. The minimal width of the component node is determined by the parameter: «DiagramKit | Layout | Nodes | Minimal Width» This parameter allows you to specify the minimal wrapping width, which will be applied in any case. No annotation column will be narrower than this width.Note that the value of this parameter will affect the total width of the diagram. If you want the generated diagrams to fit into relatively narrow frame (for instance, to print them on sheets of paper), you may need to reduce the value of this parameter. |
|
DiagramKit.show.annotation.wrap.maxWidth : integer
Specify the annotation maximal wrapping width. This parameter is used only when the wrapping optimization is selected (see «Annotations | Wrapping | Optimize» parameter). In that case, some annotation may become so wide that, although the diagram will be maximally compact, such annotations may get inconvenient to read (or spread too away from what they are supposed to comment). The setting specified with this parameter limits the spreading of annotations too wide. The default value of this parameter is copied from «DiagramKit | Layout | Nodes | Maximal Width» parameter. That is the maximal width of a simple diagram node. In most cases, that works just fine. However, if you need to display in your diagrams lots of long annotations, you may want to try larger values. Note that unlike the parameter «Annotations | Wrapping | Minimal Width», setting of this parameter will not automatically lead to the increase of wrapping widths of all annotations in the diagrams. It may actually change nothing at all. |
|
DiagramKit.show.properties : boolean
Specify whether to show component properties. Nested parameters specify which properties must be displayed and how. See Also: |
|
DiagramKit.show.properties.element : boolean
Specify whether to show properties of element components. |
|
DiagramKit.show.properties.element.rows : list of strings {separators: ';', newline}
This parameter defines which properties should be displayed for element components. The default value of this parameter specifies the displaying of all properties available for element components. To specify only properties you need, you may edit the default text (e.g. remove from it those lines you don't need). See Also: |
|
DiagramKit.show.properties.attribute : boolean
Specify whether to show properties of attribute components. |
|
DiagramKit.show.properties.attribute.rows : list of strings {separators: ';', newline}
This parameter defines which properties should be displayed for attribute components. The default value of this parameter specifies the displaying of all properties available for attribute components. To specify only properties you need, you may edit the default text (e.g. remove from it those lines you don't need). See Also: |
|
DiagramKit.show.properties.value
With the parameters in this group, you can adjust some aspects of how properties are displayed. See Also: |
|
DiagramKit.show.properties.value.separator
This parameter group specify separators for list values of specific properties. See Also: |
|
DiagramKit.show.properties.value.separator.enum : String
Specify the list separator for |
|
DiagramKit.show.properties.value.separator.pattern : String
Specify the list separator for |
|
DiagramKit.show.properties.value.equalColumnWidths : boolean
Specify whether to equalize the widths of value columns formed by double-property rows. See Also: |
|
DiagramKit.show.substGroup : enum {"always", "by_root_only", "none"}
Specify whether to show substitution group member chains. Possible Choices:
See Also:
|
|
DiagramKit.layout
This group unites parameters that control some aspects of how diagrams are laid out in general, purely from the geometric point of view and regardless of what exactly is shown on them. In the future, more settings can be added here. |
|
DiagramKit.layout.node
This parameter group allows you to adjust the widths of diagram simple nodes. See Also: |
|
DiagramKit.layout.node.minWidth : integer
Specify the minimal width (in pixels) of diagram simple nodes. |
|
DiagramKit.layout.node.maxWidth : integer
Specify the maximal width (in pixels) of diagram simple nodes. Related Parameter:
|
|
DiagramKit.style
With the parameters in this group, you can style the diagrams (i.e. change how something in them looks). |
|
DiagramKit.style.baseType
Specify styling of base-type panel.
In case of element component diagram, base-type panel highlights information about the element's type.
In case of complex type diagram, base-type panel highlights information about the type's base type. |
|
DiagramKit.style.baseType.caption.color : Color
Specify the color of the panel caption (it says what that type is). |
|
DiagramKit.style.baseType.bkgr.color : Color
Specify the panel background color. |
|
DiagramKit.style.baseType.border.color : Color
Specify the color of the panel border |
|
DiagramKit.style.annotation
Specify styling of annotations |
|
DiagramKit.style.annotation.color : Color
Specify color of annotation text |
|
DiagramKit.render
With these parameters, you can adjust a few things how diagrams are rendered into images. It may be important only in case of a non-Windows operating system. |
|
DiagramKit.render.fontSmoothing : enum {"LCD", "GRAY"}
Specify the preferred mechanism used to smooth the edges of fonts for image text. Possible Choices: "LCD"
|
|
DiagramKit.render.useEmbeddedFonts : boolean
Specify whether to use the fonts embedded in DiagramKit. To have the generated diagrams always look the same on every system/environment where you run FlexDoc/XML, DiagramKit comes with its own fonts that are used by default. If something is wrong with that, you can unselect this parameter. Then, only fonts installed on your system and matched automatically by JavaFx will be used to display various labels and text in the generated diagrams. |