docs: add JSDOc to CellStateStyle properties (#162)
These properties were not documented after the style configuration was changed (move from the string-based to the object-based configuration). In mxGraph, the properties were documented in `mxConstants`. The documentation is created based on `mxGraph`, `typed-mxgraph` and the current `maxGraph` implementation. Some properties remains undocumented because they are not used, some have a wrong type (mainly number instead of boolean). This will be managed in a next commit. Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>development
Thomas Bouffard
GitHub
parent
5a346079b5
commit
097cd90d50
|
|
@ -44,125 +44,743 @@ export type Properties = {
|
|||
export type CellStyle = CellStateStyle & { baseStyleNames?: string[] };
|
||||
|
||||
export type CellStateStyle = {
|
||||
/**
|
||||
* This specifies if {@link arcSize} for rectangles is absolute or relative. The possible values are 1 and 0 (default).
|
||||
* @default 0
|
||||
*/
|
||||
absoluteArcSize?: number;
|
||||
/**
|
||||
* This value defines how the lines of the label are aligned horizontally.
|
||||
* - `left` means that the lines of label text are aligned to the left of the label bounds.
|
||||
* - `right` means that the lines of label text are aligned to the right of the label bounds.
|
||||
* - `center` means that the center of the label text lines are aligned to the center of the label bounds.
|
||||
*
|
||||
* Note that this value does not affect the positioning of the overall label bounds relative
|
||||
* to the vertex. To move the label bounds horizontally, use {@link labelPosition}.
|
||||
* @default 'center'
|
||||
*/
|
||||
align?: AlignValue;
|
||||
/**
|
||||
* This defines if the direction style should be taken into account when computing the fixed point location for connected edges.
|
||||
* See also {@link direction}.
|
||||
*
|
||||
* Set this to `false` to ignore the direction style for fixed connection points.
|
||||
* @default true
|
||||
*/
|
||||
anchorPointDirection?: boolean;
|
||||
/**
|
||||
* For **vertex**, this defines the rounding factor for a {@link rounded} vertex in percent.
|
||||
* The possible values are between `0` and `100`.
|
||||
* If this value is not specified, then `constants.RECTANGLE_ROUNDING_FACTOR * 100` is used.
|
||||
*
|
||||
* Shapes supporting `arcSize`:
|
||||
* - Rectangle
|
||||
* - Rhombus
|
||||
* - Swimlane
|
||||
* - Triangle
|
||||
*
|
||||
* For **edge**, this defines the absolute size of the {@link rounded} corners in pixels.
|
||||
* If this value is not specified, then {@link LINE_ARCSIZE} is used.
|
||||
*
|
||||
* See also {@link absoluteArcSize}.
|
||||
*/
|
||||
arcSize?: number;
|
||||
/**
|
||||
* The possible values are empty or fixed.
|
||||
* If `fixed` is used, the aspect ratio of the cell will be maintained when resizing.
|
||||
* @default 'empty'
|
||||
*/
|
||||
aspect?: string;
|
||||
/**
|
||||
* This specifies if a cell should be resized automatically if its value changed.
|
||||
* See {@link Graph.isAutoSizeCell}. This is normally combined with {@link resizable} to disable manual resizing.
|
||||
* @default false
|
||||
*/
|
||||
autosize?: boolean;
|
||||
backgroundColor?: ColorValue;
|
||||
/**
|
||||
* This specifies if only the background of a cell should be painted when it is highlighted.
|
||||
* The possible values are 0 (false) or 1 (true).
|
||||
* @default 0
|
||||
*/
|
||||
backgroundOutline?: number;
|
||||
/**
|
||||
* This specifies if the control points of an edge can be moved.
|
||||
* See {@link Graph.isCellBendable}.
|
||||
* @default true
|
||||
*/
|
||||
bendable?: boolean;
|
||||
/**
|
||||
* This specifies if a cell can be cloned.
|
||||
* See {@link Graph.isCellCloneable}.
|
||||
* @default true
|
||||
*/
|
||||
cloneable?: boolean;
|
||||
/**
|
||||
* It is only applicable for connector shapes.
|
||||
* @default false
|
||||
*/
|
||||
curved?: boolean;
|
||||
/**
|
||||
* See also {@link dashPattern} and {@link fixDash}.
|
||||
* @default false
|
||||
*/
|
||||
dashed?: boolean;
|
||||
/**
|
||||
* The type of this value is a space-separated list of numbers that specify a custom-defined dash pattern. Only relevant if {@link dashed} is `true`.
|
||||
*
|
||||
* Dash styles are defined by the length of the dash (the drawn part of the stroke) and the length of the space between the dashes.
|
||||
*
|
||||
* The lengths are relative to the line width: a length of `1` is equal to the line width.
|
||||
*
|
||||
* See also {@link dashed} and {@link fixDash}.
|
||||
*/
|
||||
dashPattern?: string;
|
||||
defaultEdge?: CellStateStyle;
|
||||
defaultVertex?: CellStateStyle;
|
||||
/**
|
||||
* This specifies if a cell can be deleted.
|
||||
* See {@link Graph.isCellDeletable}.
|
||||
* @default true
|
||||
*/
|
||||
deletable?: boolean;
|
||||
/**
|
||||
* The direction style is used to specify the direction of certain shapes (eg. Swimlane).
|
||||
* @default 'east'
|
||||
*/
|
||||
direction?: DirectionValue;
|
||||
/**
|
||||
* The possible values for the style provided out-of-the box by maxGraph are defined in {@link EDGESTYLE}.
|
||||
*
|
||||
* See {@link noEdgeStyle}.
|
||||
*/
|
||||
edgeStyle?: string;
|
||||
/**
|
||||
* This specifies if the value of a cell can be edited using the in-place editor.
|
||||
* See {@link Graph.isCellEditable}.
|
||||
* @default true
|
||||
*/
|
||||
editable?: boolean;
|
||||
/**
|
||||
* This defines how the three-segment orthogonal edge style leaves its terminal vertices.
|
||||
* The 'vertical' style leaves the terminal vertices at the top and bottom sides.
|
||||
*
|
||||
* The possible values are 'horizontal' and 'vertical'.
|
||||
* @default 'horizontal'
|
||||
*/
|
||||
elbow?: string;
|
||||
/**
|
||||
* This defines the style of the end arrow marker.
|
||||
* See {@link startArrow}.
|
||||
*/
|
||||
endArrow?: ArrowType;
|
||||
/**
|
||||
* Use `false` to not fill or `true` to fill the end arrow marker.
|
||||
* See {@link startFill}.
|
||||
* @default true
|
||||
*/
|
||||
endFill?: boolean;
|
||||
/**
|
||||
* The value represents the size of the end marker in pixels.
|
||||
* See {@link startSize}.
|
||||
*/
|
||||
endSize?: number;
|
||||
/**
|
||||
* The horizontal offset of the connection point of an edge with its target terminal.
|
||||
*/
|
||||
entryDx?: number;
|
||||
/**
|
||||
* The vertical offset of the connection point of an edge with its target terminal.
|
||||
*/
|
||||
entryDy?: number;
|
||||
/**
|
||||
* Defines if the perimeter should be used to find the exact entry point along the perimeter
|
||||
* of the target.
|
||||
* @default true
|
||||
*/
|
||||
entryPerimeter?: boolean;
|
||||
/**
|
||||
* The connection point in relative horizontal coordinates of an edge with its target terminal.
|
||||
*/
|
||||
entryX?: number;
|
||||
/**
|
||||
* The connection point in relative vertical coordinates of an edge with its target terminal.
|
||||
*/
|
||||
entryY?: number;
|
||||
/**
|
||||
* The horizontal offset of the connection point of an edge with its source terminal.
|
||||
*/
|
||||
exitDx?: number;
|
||||
/**
|
||||
* The vertical offset of the connection point of an edge with its source terminal.
|
||||
*/
|
||||
exitDy?: number;
|
||||
/**
|
||||
* Defines if the perimeter should be used to find the exact entry point along the perimeter
|
||||
* of the source.
|
||||
* @default true
|
||||
*/
|
||||
exitPerimeter?: boolean;
|
||||
/**
|
||||
* The horizontal relative coordinate connection point of an edge with its source terminal.
|
||||
*/
|
||||
exitX?: number;
|
||||
/**
|
||||
* The vertical relative coordinate connection point of an edge with its source terminal.
|
||||
*/
|
||||
exitY?: number;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes, as well as special keywords such
|
||||
* as `swimlane`, `inherit`, `indicated` to use the color code of a related cell or the
|
||||
* indicator shape.
|
||||
*/
|
||||
fillColor?: ColorValue;
|
||||
/**
|
||||
* Possible range is `0-100`.
|
||||
*/
|
||||
fillOpacity?: number;
|
||||
/**
|
||||
* Use `false` for dash patterns that depend on the line width and `true` for dash patterns
|
||||
* that ignore the line width.
|
||||
* See also {@link dashed} and {@link dashPattern}.
|
||||
* @default false
|
||||
*/
|
||||
fixDash?: boolean;
|
||||
/**
|
||||
* Horizontal flip.
|
||||
* @default false
|
||||
*/
|
||||
flipH?: boolean;
|
||||
/**
|
||||
* Vertical flip.
|
||||
* @default false
|
||||
*/
|
||||
flipV?: boolean;
|
||||
/**
|
||||
* This specifies if a cell is foldable using a folding icon.
|
||||
* See {@link Graph.isCellFoldable}.
|
||||
* @default true
|
||||
*/
|
||||
foldable?: boolean;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
*/
|
||||
fontColor?: ColorValue;
|
||||
/**
|
||||
* The possible values are names such as `Arial; Dialog; Verdana; Times New Roman`.
|
||||
*/
|
||||
fontFamily?: string;
|
||||
/**
|
||||
* The size of the font (in px).
|
||||
*/
|
||||
fontSize?: number;
|
||||
/**
|
||||
* Values may be any logical AND (sum) of the {@link FONT}. For instance, FONT.BOLD,
|
||||
* FONT.ITALIC, ...
|
||||
*/
|
||||
fontStyle?: number;
|
||||
/**
|
||||
* Enable the glass gradient effect
|
||||
* @default false
|
||||
*/
|
||||
glass?: boolean;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
*/
|
||||
gradientColor?: ColorValue;
|
||||
/**
|
||||
* Generally, and by default in maxGraph, gradient painting is done from the value of {@link fillColor} to the value of {@link gradientColor}.
|
||||
* If we take the example of 'north', this means that the {@link fillColor} color is at the bottom of paint pattern
|
||||
* and the {@link gradientColor} color is at the top, with a gradient in-between.
|
||||
* @default 'south'
|
||||
*/
|
||||
gradientDirection?: DirectionValue;
|
||||
/**
|
||||
* This value only applies to vertices.
|
||||
* If the {@link shape} is `swimlane`, a value of `false` indicates that the swimlane should
|
||||
* be drawn vertically, `true` indicates that it should be drawn horizontally.
|
||||
* If the shape style does not indicate that this vertex is a 'swimlane', this value only
|
||||
* affects whether the label is drawn horizontally or vertically.
|
||||
* @default true
|
||||
*/
|
||||
horizontal?: boolean;
|
||||
/**
|
||||
* The possible values are any image URL.
|
||||
*
|
||||
* This is the path to the image that is to be displayed within the label of a vertex.
|
||||
* Data URLs should use the following format: `data:image/png,xyz` where xyz is the base64
|
||||
* encoded data (without the "base64"-prefix).
|
||||
*/
|
||||
image?: string;
|
||||
/**
|
||||
* The value defines how any image in the vertex label is horizontally aligned within the
|
||||
* label bounds of a {@link LabelShape}.
|
||||
* @default 'left'
|
||||
*/
|
||||
imageAlign?: AlignValue;
|
||||
/**
|
||||
* The possible values are:
|
||||
* - `false`: do not preserve aspect of the image
|
||||
* - `true`: keep aspect of the image
|
||||
*
|
||||
* This is only used in `ImageShape`.
|
||||
* @default true
|
||||
*/
|
||||
imageAspect?: boolean;
|
||||
/**
|
||||
* The possible values for the image background are all HTML color names or HEX codes.
|
||||
*
|
||||
* This is only used in `ImageShape`.
|
||||
* @default 'none'
|
||||
*/
|
||||
imageBackground?: ColorValue;
|
||||
/**
|
||||
* The possible values for the color of the image border are all HTML color names or HEX codes.
|
||||
*
|
||||
* This is only used in `ImageShape`.
|
||||
* @default 'none'
|
||||
*/
|
||||
imageBorder?: ColorValue;
|
||||
/**
|
||||
* The value is the image height in pixels and must be greater than `0`.
|
||||
* @default constants.DEFAULT_IMAGESIZE
|
||||
*/
|
||||
imageHeight?: number;
|
||||
/**
|
||||
* The value is the image width in pixels and must be greater than `0`.
|
||||
* @default constants.DEFAULT_IMAGESIZE
|
||||
*/
|
||||
imageWidth?: number;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes, as well as the special `swimlane` keyword
|
||||
* to refer to the color of the parent `swimlane` if one exists.
|
||||
*/
|
||||
indicatorColor?: ColorValue;
|
||||
/**
|
||||
* The direction style is used to specify the direction of certain shapes (eg. {@link TriangleShape}).
|
||||
* @default 'east'
|
||||
*/
|
||||
indicatorDirection?: DirectionValue;
|
||||
/**
|
||||
* The possible values start at 0 (in pixels).
|
||||
*/
|
||||
indicatorHeight?: number;
|
||||
/**
|
||||
* Indicator image used within a {@link LabelShape}.
|
||||
* The possible values are all image URLs.
|
||||
*
|
||||
* The {@link indicatorShape} has precedence over the indicatorImage.
|
||||
*/
|
||||
indicatorImage?: string;
|
||||
/**
|
||||
* The indicator shape used within an {@link LabelShape}.
|
||||
* The possible values are all names of registered Shapes with {@link CellRenderer.registerShape}.
|
||||
* This usually includes {@link ShapeValue} values and the names of all new shapes.
|
||||
*
|
||||
* The `indicatorShape` property has precedence over the {@link indicatorImage} property.
|
||||
*/
|
||||
indicatorShape?: string;
|
||||
/**
|
||||
* The color of the indicator stroke in {@link LabelShape}.
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
*/
|
||||
indicatorStrokeColor?: ColorValue;
|
||||
/**
|
||||
* The possible values start at 0 (in pixels).
|
||||
*/
|
||||
indicatorWidth?: number;
|
||||
/**
|
||||
* The jetty size in {@link EdgeStyle.OrthConnector}.
|
||||
* @default 10
|
||||
*/
|
||||
jettySize?: number | 'auto';
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
*/
|
||||
labelBackgroundColor?: ColorValue;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
*/
|
||||
labelBorderColor?: ColorValue;
|
||||
/**
|
||||
* The label padding, i.e. the space between the label border and the label.
|
||||
*/
|
||||
labelPadding?: number;
|
||||
/**
|
||||
* The label alignment defines the position of the label relative to the cell.
|
||||
* - `left` means that the entire label bounds is placed completely just to the left of the vertex.
|
||||
* - `right` means that the label bounds are adjusted to the right.
|
||||
* - `center` means that the label bounds are vertically aligned with the bounds of the vertex.
|
||||
*
|
||||
* Note that this value does not affect the positioning of label within the label bounds.
|
||||
* To move the label bounds horizontally within the label bounds, use {@link align}
|
||||
* @default 'center'
|
||||
*/
|
||||
labelPosition?: AlignValue;
|
||||
/**
|
||||
* The width of the label if the label position is not `center`.
|
||||
*/
|
||||
labelWidth?: number;
|
||||
/**
|
||||
* The possible values are the functions defined in {@link EdgeStyle}.
|
||||
*/
|
||||
loop?: Function;
|
||||
loopStyle?: Function;
|
||||
/**
|
||||
* The margin between the ellipses in {@link DoubleEllipseShape}.
|
||||
*
|
||||
* The possible values are all positive numbers.
|
||||
*/
|
||||
margin?: number;
|
||||
/**
|
||||
* This specifies if a cell can be moved.
|
||||
*
|
||||
* See {@link Graph.isCellMovable}.
|
||||
* @default true
|
||||
*/
|
||||
movable?: boolean;
|
||||
/**
|
||||
* If this is `true`, no edge style is applied for a given edge.
|
||||
* See {@link edgeStyle}.
|
||||
* @default false
|
||||
*/
|
||||
noEdgeStyle?: boolean;
|
||||
/**
|
||||
* If this is `true`, no label is visible for a given cell.
|
||||
* @default false
|
||||
*/
|
||||
noLabel?: boolean;
|
||||
/**
|
||||
* The possible range is `0-100`.
|
||||
*/
|
||||
opacity?: number;
|
||||
/**
|
||||
* Defines if the connection points on either end of the edge should be computed so that
|
||||
* the edge is vertical or horizontal if possible and if the point is not at a fixed location.
|
||||
*
|
||||
* This is used in {@link Graph.isOrthogonal}, which also returns `true` if the {@link edgeStyle}
|
||||
* of the edge is an `elbow` or `entity`.
|
||||
* @default false
|
||||
*/
|
||||
orthogonal?: boolean | null;
|
||||
/**
|
||||
* Use this style to specify if loops should be routed using an orthogonal router. Currently,
|
||||
* this uses {@link EdgeStyle.OrthConnector} but will be replaced with a dedicated
|
||||
* orthogonal loop router in later releases.
|
||||
* @default false
|
||||
*/
|
||||
orthogonalLoop?: boolean;
|
||||
/**
|
||||
* This value specifies how overlapping vertex labels are handled.
|
||||
* - A value of 'visible' will show the complete label.
|
||||
* - A value of 'hidden' will clip the label so that it does not overlap the vertex bounds.
|
||||
* - A value of 'fill' will use the vertex bounds.
|
||||
* - A value of 'width' will use the vertex width for the label.
|
||||
*
|
||||
* See {@link Graph.isLabelClipped}.
|
||||
*
|
||||
* Note that the vertical alignment is ignored for overflow filling and for horizontal
|
||||
* alignment.
|
||||
*
|
||||
* @default 'visible'
|
||||
*/
|
||||
overflow?: OverflowValue;
|
||||
/**
|
||||
* This defines the perimeter around a particular shape.
|
||||
*
|
||||
* For `Function` types, the possible values are the functions defined in {@link Perimeter}.
|
||||
*
|
||||
* Alternatively, use a string or a value from {@link PERIMETER} to access perimeter styles
|
||||
* registered in {@link StyleRegistry}.
|
||||
*/
|
||||
perimeter?: Function | string | null;
|
||||
/**
|
||||
* This is the distance between the connection point and the perimeter in pixels.
|
||||
* - When used in a vertex style, this applies to all incoming edges to floating ports
|
||||
* (edges that terminate on the perimeter of the vertex).
|
||||
* - When used in an edge style, this spacing applies to the source and target separately,
|
||||
* if they terminate in floating ports (on the perimeter of the vertex).
|
||||
*/
|
||||
perimeterSpacing?: number;
|
||||
/**
|
||||
* Specifies if pointer events should be fired on transparent backgrounds.
|
||||
* This style is currently only supported by {@link RectangleShape}, {@link SwimlaneShape}
|
||||
* and {@link StencilShape}.
|
||||
*
|
||||
* This style is usually set to `false` in groups where the transparent part should allow any
|
||||
* underlying cells to be clickable.
|
||||
* @default true
|
||||
*/
|
||||
pointerEvents?: boolean;
|
||||
/**
|
||||
* Defines the direction(s) in which edges are allowed to connect to cells.
|
||||
*/
|
||||
portConstraint?: DIRECTION;
|
||||
/**
|
||||
* Define if the directions of the port constraints are rotated with the vertex rotation.
|
||||
* - `false` makes the port constraints remain absolute, relative to the graph.
|
||||
* - `true` makes the constraints rotate with the vertex.
|
||||
* @default false
|
||||
*/
|
||||
portConstraintRotation?: DIRECTION;
|
||||
/**
|
||||
* This specifies if a cell can be resized.
|
||||
*
|
||||
* See {@link Graph.isCellResizable}.
|
||||
* @default true
|
||||
*/
|
||||
resizable?: boolean;
|
||||
/**
|
||||
* This specifies if the height of a cell is resized if the parent is resized.
|
||||
* - If `true`, then the height will be resized even if the cell geometry is relative.
|
||||
* - If `false`, then the height will not be resized.
|
||||
* @default false
|
||||
*/
|
||||
resizeHeight?: boolean;
|
||||
/**
|
||||
* This specifies if the width of a cell is resized if the parent is resized.
|
||||
* - If `true`, then the width will be resized even if the cell geometry is relative.
|
||||
* - If `false`, then the width will not be resized.
|
||||
* @default false
|
||||
*/
|
||||
resizeWidth?: boolean;
|
||||
/**
|
||||
* This specifies if a cell can be rotated.
|
||||
* @default true
|
||||
*/
|
||||
rotatable?: boolean;
|
||||
/**
|
||||
* The possible range is 0-360.
|
||||
* @default 0
|
||||
*/
|
||||
rotation?: number;
|
||||
/**
|
||||
* For edges, this determines whether the joins between edges segments are smoothed to a rounded finish.
|
||||
*
|
||||
* For vertices that have the rectangle shape, this determines whether the rectangle is rounded.
|
||||
*
|
||||
* See also {@link absoluteArcSize} and {@link arcSize} for the 'rounded' settings.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
rounded?: boolean;
|
||||
/**
|
||||
* This is the relative offset from the center used to connect the edges.
|
||||
*
|
||||
* The possible values are between -0.5 and 0.5.
|
||||
* @default 0
|
||||
*/
|
||||
routingCenterX?: number;
|
||||
/**
|
||||
* This is the relative offset from the center used to connect the edges.
|
||||
*
|
||||
* The possible values are between -0.5 and 0.5.
|
||||
* @default 0
|
||||
*/
|
||||
routingCenterY?: number;
|
||||
/**
|
||||
* The type of this value is float and the value represents the size of the horizontal
|
||||
* segment of the entity relation style.
|
||||
* @default constants.ENTITY_SEGMENT
|
||||
*/
|
||||
segment?: number;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
* This style is only used for `swimlane` shapes.
|
||||
*/
|
||||
separatorColor?: ColorValue;
|
||||
/**
|
||||
* Add a shadow when painting the shape.
|
||||
* @default false
|
||||
*/
|
||||
shadow?: boolean;
|
||||
/**
|
||||
* The possible values are all names of the shapes registered with {@link CellRenderer.registerShape}.
|
||||
* This usually includes {@link ShapeValue} values and the names of all new shapes.
|
||||
*/
|
||||
shape?: ShapeValue;
|
||||
/**
|
||||
* The size of the source jetty in {@link EdgeStyle.OrthConnector}.
|
||||
*
|
||||
* This value takes precedence over {@link jettySize}.
|
||||
* @default {@link jettySize}
|
||||
*/
|
||||
sourceJettySize?: number | 'auto';
|
||||
/**
|
||||
* This is the distance between the source connection point of an edge and the perimeter
|
||||
* of the source vertex in pixels.
|
||||
*
|
||||
* This style only applies to edges.
|
||||
* @default 0
|
||||
*/
|
||||
sourcePerimeterSpacing?: number;
|
||||
/**
|
||||
* Defines the ID of the cell that should be used to compute the perimeter point of
|
||||
* the source for an edge.
|
||||
*
|
||||
* This allows for graphically connecting to a cell while keeping the actual terminal of
|
||||
* the edge.
|
||||
*/
|
||||
sourcePort?: string;
|
||||
/**
|
||||
* Defines the direction(s) in which edges are allowed to connect to sources.
|
||||
*/
|
||||
sourcePortConstraint?: DIRECTION;
|
||||
/**
|
||||
* The value represents the spacing, in pixels, added to each side of a label in a vertex.
|
||||
*
|
||||
* This style only applies to vertices.
|
||||
* @default 0
|
||||
*/
|
||||
spacing?: number;
|
||||
/**
|
||||
* The value represents the spacing, in pixels, added to the bottom side of a label in a
|
||||
* vertex. It is added to the {@link CellStateStyle.spacing} value.
|
||||
*
|
||||
* This style only applies to vertices.
|
||||
* @default 0
|
||||
*/
|
||||
spacingBottom?: number;
|
||||
/**
|
||||
* The value represents the spacing, in pixels, added to the left side of a label in a
|
||||
* vertex. It is added to the {@link CellStateStyle.spacing} value.
|
||||
*
|
||||
* This style only applies to vertices.
|
||||
* @default 0
|
||||
*/
|
||||
spacingLeft?: number;
|
||||
/**
|
||||
* The value represents the spacing, in pixels, added to the right side of a label in a
|
||||
* vertex. It is added to the {@link CellStateStyle.spacing} value.
|
||||
*
|
||||
* This style only applies to vertices.
|
||||
* @default 0
|
||||
*/
|
||||
spacingRight?: number;
|
||||
/**
|
||||
* The value represents the spacing, in pixels, added to the top side of a label in a
|
||||
* vertex. It is added to the {@link CellStateStyle.spacing} value.
|
||||
*
|
||||
* This style only applies to vertices.
|
||||
* @default 0
|
||||
*/
|
||||
spacingTop?: number;
|
||||
/**
|
||||
* This defines the style of the start arrow marker.
|
||||
* See {@link endArrow}.
|
||||
*/
|
||||
startArrow?: ArrowType;
|
||||
/**
|
||||
* Use `false` to not fill or `true` to fill the start arrow marker.
|
||||
* See {@link endFill}.
|
||||
* @default true
|
||||
*/
|
||||
startFill?: boolean;
|
||||
/**
|
||||
* The value represents the size of the start marker, in pixels, or the size of the title region
|
||||
* of a `swimlane` depending on the shape it is used for.
|
||||
* See {@link endSize}.
|
||||
*/
|
||||
startSize?: number;
|
||||
/**
|
||||
* The possible values are all HTML color names or HEX codes, as well as special keywords such
|
||||
* as `swimlane`, `inherit`, `indicated` to use the color code of a related cell or the
|
||||
* indicator shape or `none` for no color.
|
||||
*/
|
||||
strokeColor?: ColorValue;
|
||||
/**
|
||||
* The possible range is `0-100`.
|
||||
*/
|
||||
strokeOpacity?: number;
|
||||
/**
|
||||
* The possible range is any non-negative value greater than or equal to 1.
|
||||
* The value defines the stroke width in pixels.
|
||||
*
|
||||
* Note: To hide a stroke, use `none` as value of `strokeColor`.
|
||||
*/
|
||||
strokeWidth?: number;
|
||||
/**
|
||||
* The fill color of the `swimlane` background.
|
||||
* The possible values are all HTML color names or HEX codes.
|
||||
* @default no backgroune
|
||||
*/
|
||||
swimlaneFillColor?: ColorValue;
|
||||
/**
|
||||
* This style specifies whether the line between the title region of a `swimlane` should
|
||||
* be visible. Use `false` for hidden or `true` for visible.
|
||||
* @default true
|
||||
*/
|
||||
swimlaneLine?: boolean;
|
||||
/**
|
||||
* The size of the target jetty in {@link EdgeStyle.OrthConnector}.
|
||||
*
|
||||
* This value takes precedence over {@link jettySize}.
|
||||
* @default {@link jettySize}
|
||||
*/
|
||||
targetJettySize?: number | 'auto';
|
||||
/**
|
||||
* This is the distance between the target connection point of an edge and the perimeter
|
||||
* of the target vertex in pixels.
|
||||
*
|
||||
* This style only applies to edges.
|
||||
* @default 0
|
||||
*/
|
||||
targetPerimeterSpacing?: number;
|
||||
/**
|
||||
* Defines the ID of the cell that should be used to compute the perimeter point of
|
||||
* the target for an edge.
|
||||
*
|
||||
* This allows for graphically connecting to a cell while keeping the actual terminal of
|
||||
* the edge.
|
||||
*/
|
||||
targetPort?: string;
|
||||
/**
|
||||
* Defines the direction(s) in which edges are allowed to connect to sources.
|
||||
*/
|
||||
targetPortConstraint?: DIRECTION;
|
||||
/**
|
||||
* @default constants.DEFAULT_TEXT_DIRECTION
|
||||
*/
|
||||
textDirection?: TextDirectionValue;
|
||||
/**
|
||||
* The possible range is `0-100`.
|
||||
*/
|
||||
textOpacity?: number;
|
||||
/**
|
||||
* This value defines how the lines of the label are vertically aligned.
|
||||
* - `top` means that the topmost line of the label text is aligned with the top of the label bounds.
|
||||
* - `bottom` means that the bottom-most line of the label text is aligned with the bottom of the
|
||||
* label bounds.
|
||||
* - `middle` means that there is equal spacing between the topmost line of the text label and the top
|
||||
* of the label bounds and between the bottom-most line of the text label and the bottom of the
|
||||
* label bounds.
|
||||
*
|
||||
* Note that this value doesn't affect the positioning of the overall label bounds relative to
|
||||
* the vertex. To move the label bounds vertically, use {@link verticalLabelPosition}.
|
||||
*
|
||||
* @default 'middle'
|
||||
*/
|
||||
verticalAlign?: VAlignValue;
|
||||
/**
|
||||
* The label alignment defines the position of the label relative to the cell.
|
||||
* - 'top' means that the entire label bounds are placed completely just on the top of the vertex.
|
||||
* - 'bottom' means that the label bounds are adjusted on the bottom of the vertex.
|
||||
* - 'middle' means that the label bounds are horizontally aligned with the bounds of the vertex.
|
||||
*
|
||||
* Note that this value doesn't affect the positioning of label within the label bounds.
|
||||
* To move the label vertically within the label bounds, use {@link verticalAlign}.
|
||||
* @default 'middle'
|
||||
*/
|
||||
verticalLabelPosition?: VAlignValue;
|
||||
/**
|
||||
* This value specifies how white-space inside an HTML vertex label should be handled.
|
||||
* - A 'nowrap' value means that the text will never wrap to the next line until a line break
|
||||
* is encountered.
|
||||
* - A 'wrap' value means that the text will wrap if necessary.
|
||||
*
|
||||
* This style is only used for HTML labels.
|
||||
* @default 'nowrap'
|
||||
*/
|
||||
whiteSpace?: WhiteSpaceValue;
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -399,20 +399,21 @@ export const DEFAULT_MARKERSIZE = 6;
|
|||
export const DEFAULT_IMAGESIZE = 24;
|
||||
|
||||
/**
|
||||
* Defines the length of the horizontal segment of an Entity Relation.
|
||||
* This can be overridden using <'segment'> style.
|
||||
* Default is 30.
|
||||
* Defines the length of the horizontal segment of an `Entity Relation`.
|
||||
* This can be overridden using {@link CellStateStyle.segment} style.
|
||||
*/
|
||||
export const ENTITY_SEGMENT = 30;
|
||||
|
||||
/**
|
||||
* Defines the rounding factor for rounded rectangles in percent between
|
||||
* 0 and 1. Values should be smaller than 0.5. Default is 0.15.
|
||||
* Defines the default rounding factor for the rounded vertices in percent between
|
||||
* `0` and `1`. Values should be smaller than `0.5`.
|
||||
* See {@link CellStateStyle.arcSize}.
|
||||
*/
|
||||
export const RECTANGLE_ROUNDING_FACTOR = 0.15;
|
||||
|
||||
/**
|
||||
* Defines the size of the arcs for rounded edges. Default is 20.
|
||||
* Defines the default size in pixels of the arcs for the rounded edges.
|
||||
* See {@link CellStateStyle.arcSize}.
|
||||
*/
|
||||
export const LINE_ARCSIZE = 20;
|
||||
|
||||
|
|
@ -467,7 +468,7 @@ export const NONE = 'none';
|
|||
*
|
||||
* - FONT_UNDERLINE: Constant for underlined fonts. Default is 4.
|
||||
*
|
||||
* - FONT_STRIKETHROUGH: Constant for strikthrough fonts. Default is 8.
|
||||
* - FONT_STRIKETHROUGH: Constant for strikethrough fonts. Default is 8.
|
||||
*/
|
||||
export const enum FONT {
|
||||
BOLD = 1,
|
||||
|
|
|
|||
Loading…
Reference in New Issue