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

DiagramKit : boolean

Enables DiagramKit. When this parameter is unselected (false), no diagrams will be generated.

This parameter group is enabled only when DiagramKit plugin is active (has been setup).

Related Parameter:
FlexDoc/XML | XSDDoc | Parameter Tree | Details | Component Documentation | Diagram

Show in Diagram

DiagramKit.show

Specify what should be shown in diagrams

Annotations

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:documentation> elements found by the path:

xs:component/xs:annotation/xs:documentation
where <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.

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.

Possible Choices:
"none"
Do not show annotations.
"first sentence"
Show only the first sentence of the annotation text.

The sentence boundary is found using a Java utility class, whose implementation depends on the current locale. For most locales, it's assumed that a sentence ends with a dot ('.').

"full"
Show the full annotations.

Render Line breaks

DiagramKit.show.annotation.renderLineBreaks : boolean

Specify whether to render line break characters ('\n') found within the annotation text.

When this parameter is selected (true), each line break will cause the following text to start from a new line.

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.

Wrapping

DiagramKit.show.annotation.wrap

The parameter group to control how the annotation text is wrapped.

Optimize

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»

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.

Maximal Width

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.

Properties

DiagramKit.show.properties : boolean

Specify whether to show component properties. Nested parameters specify which properties must be displayed and how.

See Also:

DiagramKit | FAQ | Component Properties

Element

DiagramKit.show.properties.element : boolean

Specify whether to show properties of element components.

Rows

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 | FAQ | Component Properties | How to specify properties?

Attribute

DiagramKit.show.properties.attribute : boolean

Specify whether to show properties of attribute components.

Rows

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 | FAQ | Component Properties | How to specify properties?

Values

DiagramKit.show.properties.value

With the parameters in this group, you can adjust some aspects of how properties are displayed.

See Also:
DiagramKit | FAQ | Component Properties | How to control displaying of properties?

List Separator

DiagramKit.show.properties.value.separator

This parameter group specify separators for list values of specific properties.

See Also:
DiagramKit | FAQ | Component Properties | How to control displaying of properties? | Properties with list value

Enumeration

DiagramKit.show.properties.value.separator.enum : String

Specify the list separator for enum property.

Pattern

DiagramKit.show.properties.value.separator.pattern : String

Specify the list separator for pattern property.

Equal Column Widths

DiagramKit.show.properties.value.equalColumnWidths : boolean

Specify whether to equalize the widths of value columns formed by double-property rows.

See Also:
DiagramKit | FAQ | Component Properties | How to control displaying of properties? | Widths of value columns

Substitution Groups

DiagramKit.show.substGroup : enum {"always", "by_root_only", "none"}

Specify whether to show substitution group member chains.

Possible Choices:

"always"
Show the member chain by every depiction of substitution group's head element
"by diagram root only"
Show the member chain only when the substitution group's head element is the diagram's root node
"full"
Do not show the member chains

See Also:

Layout

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.

Nodes

DiagramKit.layout.node

This parameter group allows you to adjust the widths of diagram simple nodes.

See Also:
DiagramKit | FAQ | Diagram Settings | How to stretch/shrink things shown on diagram?

Minimal Width

DiagramKit.layout.node.minWidth : integer

Specify the minimal width (in pixels) of diagram simple nodes.

Maximal Width

DiagramKit.layout.node.maxWidth : integer

Specify the maximal width (in pixels) of diagram simple nodes.

Related Parameter:
This parameter provides the default value for the parameter: «DiagramKit | Show in Diagram | Annotations | Wrapping | Maximal Width»

Styling

DiagramKit.style

With the parameters in this group, you can style the diagrams (i.e. change how something in them looks).

Base Type Panel

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.

Caption Color

DiagramKit.style.baseType.caption.color : Color

Specify the color of the panel caption (it says what that type is).

Background

DiagramKit.style.baseType.bkgr.color : Color

Specify the panel background color.

Border Color

DiagramKit.style.baseType.border.color : Color

Specify the color of the panel border

Annotations

DiagramKit.style.annotation

Specify styling of annotations

Color

DiagramKit.style.annotation.color : Color

Specify color of annotation text