E

ComponentArrangementStyle

Specifies different styles for arranging components in a ComponentLayout.

Remarks

These styles determine how the layout algorithm arranges individual components within the graph. Depending on the chosen style, components can be organized in rows, columns, circular patterns, or compact rectangular shapes. The selected style influences the overall aspect ratio, spacing, and potential overlap of components.

See Also

API

style

Members

No filters for this type

Constants

Style specifier describing that components will be centered at the same position they resided at before the layout started.
static

Sample Graphs

ShownSetting: No specific arrangement

See Also

API
style
Style specifier describing a component arrangement strategy that places components in multiple rows.

The strategy tries to arrange the components such that the aspect ratio of the final component placement gets as close as possible to the aspect ratio of the preferred layout size, configurable using preferredSize.

In contrast to ROWS, each row may also be divided into further sub-rows, which is especially useful if there are few very large components and many significantly smaller ones.

static

Sample Graphs

ShownSetting: Multiple rows with aspect ratio 2.5

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places components in multiple rows.

The strategy tries to arrange the components such that the aspect ratio of the final component placement gets close to the aspect ratio of the preferred layout size, configurable using preferredSize. But in contrast to MULTI_ROWS, this strategy does not always try to come as close to the preferred view ratio, if a ratio close to the preferred ratio only induces a lot of unused view space. This unused space will be minimized.

In contrast to ROWS, each row may also be divided into further sub-rows, which is especially useful if there are few very large components and many significantly smaller ones.

static

Sample Graphs

ShownSetting: Compact multiple rows with aspect ratio 2.5

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted height.

The resulting height does not exceed the preferred height ( preferredSize).

In contrast to MULTI_ROWS_HEIGHT_CONSTRAINT_COMPACT, the result will be an arrangement which uses as much height as possible, even if that means that all components will be arranged in one single column.

The preferred width and thus the aspect ratio will be ignored.
static

Sample Graphs

ShownSetting: Height constrained to 800

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted height and as compact as possible.

The resulting height does not exceed the preferred height ( preferredSize).

In comparison with MULTI_ROWS_HEIGHT_CONSTRAINT, the result will be compacted, which means that an arrangement with the minimum width such that the height constraint is still fulfilled will be realized.

The preferred width and thus the aspect ratio will be ignored.
static

Sample Graphs

ShownSetting: Height constrained to 800 with compact arrangement

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places the components in multiple nested rows, like MULTI_ROWS, but separates components of different node type.

The strategy for placing components of the same type is equal to that of MULTI_ROWS, but components of different node types are not placed in the same nested row. This means rows are not filled up anymore (even though there would be space), but the components of different types are placed in a new row. Therefore, this strategy produces more rows and is less compact.

The type of a component is derived from the type of its nodes such that if most of the nodes are of the same type, the component is considered to be of this dominant type, too. If there is no dominant type, the component is considered to have no type. Components without a type are separated from the components with a type.

In contrast to MULTI_ROWS without type separation, this strategy may not come as close to the preferred view ratio, because the node types are of higher priority. Furthermore, results may contain more white space and be less compact.

static

See Also

Developer's Guide
API
style, preferredSize, nodeTypes
Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted width.

The resulting width does not exceed the preferred width ( preferredSize).

In contrast to MULTI_ROWS_WIDTH_CONSTRAINT_COMPACT, the result will be an arrangement which uses as much space in width as possible, even if that means that all components will be arranged in a single row.

The preferred height and thus the aspect ratio will be ignored.
static

Sample Graphs

ShownSetting: Width constrained to 1000

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted width and as compact as possible.

The resulting width does not exceed the preferred width ( preferredSize).

In comparison with MULTI_ROWS_HEIGHT_CONSTRAINT the result will be compacted, in order to minimize unused view space induced by components that are large in height.

The preferred height and thus the aspect ratio will be ignored.
static

Sample Graphs

ShownSetting: Width constrained to 1000 with compact arrangement

See Also

API
style, preferredSize
Style specifier describing no special component arrangement at all.
The layout algorithm will keep the components at their location. Then, the components may overlap.
static

See Also

API
style
Style specifier describing a component arrangement strategy that places components in a circular cloud around the biggest component.
Entities of different components will not overlap, however the bounds of the components may overlap.
With graphs that contain large unconnected components, the packed styles can require noticeably more time to calculate than other arrangement styles.
static

Sample Graphs

ShownSetting: Circular arrangement

See Also

API
style
Style specifier describing a component arrangement strategy that places components in a circular compact cloud around the biggest component.

Entities of different components will not overlap, however the bounds of the components may overlap.

In contrast to PACKED_CIRCLE, components might even be placed in empty spaces inside other components.

With graphs that contain large unconnected components, the packed styles can require noticeably more time to calculate than other arrangement styles.
static

Sample Graphs

See Also

API
style
Style specifier describing a component arrangement strategy that places components in a rectangular cloud around the biggest component.

Entities of different components will not overlap, however the bounds of the components may overlap.

In contrast to PACKED_RECTANGLE, components might even be placed in empty spaces inside other components.

The aspect ratio of the rectangle is defined by the preferredSize of the graph.

With graphs that contain large unconnected components, the packed styles can require noticeably more time to calculate than other arrangement styles.
static

Sample Graphs

ShownSetting: Compact rectangular arrangement with aspect ratio 1

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places components in a rectangular cloud around the biggest component.

Entities of different components will not overlap, however the bounds of the components may overlap.

The aspect ratio of the rectangle is defined by the preferredSize of the graph.

With graphs that contain large unconnected components, the packed styles can require noticeably more time to calculate than other arrangement styles.
static

Sample Graphs

ShownSetting: Rectangular arrangement with aspect ratio 1

See Also

API
style, preferredSize
Style specifier describing a component arrangement strategy that places components in multiple rows so that the overall aspect ratio of the whole graph gets as close to the aspect ratio of the preferred layout size as possible.
static

Sample Graphs

ShownSetting: Multiple rows and aspect ratio 1

See Also

Developer's Guide
API
style, preferredSize
Style specifier describing a component arrangement strategy that places components above each other in a single column.
If combined with the fromSketchMode, components will be placed in the same order as they were placed before the layout.
static

Sample Graphs

ShownSetting: All components in one column

See Also

Developer's Guide
API
style
Style specifier describing a component arrangement strategy that places all components next to each other in a single row.
If combined with fromSketchMode, components will be placed in the same order as they were placed before the layout.
static

Sample Graphs

ShownSetting: All components in one row

See Also

Developer's Guide
API
style
Style specifier describing that components will be centered at the same position they resided at before the layout started, unless this would cause overlaps with other components.
If two components overlap after the coreLayout has returned, those components are moved to resolve the overlap.
static

Static Methods

Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: ComponentArrangementStyle
The value to convert to an enum constant.

Return Value

ComponentArrangementStyle
The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
static

Parameters

value: ComponentArrangementStyle
The numeric value of an enum constant.

Return Value

string
The name of the enum constant.

Throws

Exception ({ name: 'Error' })
If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.