@ts-graphviz/common 2.1.0 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/lib/common.d.ts +4010 -5
- package/package.json +3 -3
- package/lib/attribute.d.ts +0 -2749
- package/lib/functional.d.ts +0 -9
- package/lib/functional.test.d.ts +0 -1
- package/lib/models-context.d.ts +0 -19
- package/lib/models.d.ts +0 -620
- package/lib/types.d.ts +0 -494
package/lib/common.d.ts
CHANGED
|
@@ -1,5 +1,4010 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
export
|
|
5
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
*/
|
|
4
|
+
export declare type $keywords<T extends string> = {
|
|
5
|
+
[key in T]: key;
|
|
6
|
+
};
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* @hidden
|
|
10
|
+
*/
|
|
11
|
+
export declare interface $keywordsValidation extends $keywords<`${string} ${string}` | `${string}\n${string}` | `${string}\t${string}`> {
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* A double with an optional prefix `'+'`.
|
|
16
|
+
*
|
|
17
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/addDouble/ addDouble}
|
|
18
|
+
* @group Attribute Types
|
|
19
|
+
*/
|
|
20
|
+
export declare type AddDouble = `+${Double}`;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* A point with an optional prefix `'+'`.
|
|
24
|
+
*
|
|
25
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/addPoint/ addPoint}
|
|
26
|
+
* @group Attribute Types
|
|
27
|
+
*/
|
|
28
|
+
export declare type AddPoint = `+${Point}`;
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* The examples above show a set of commonly used arrow shapes.
|
|
32
|
+
*
|
|
33
|
+
* There is a grammar of arrow shapes which can be used to describe a collection of 3,111,696 arrow
|
|
34
|
+
* combinations of the 42 variations of the primitive set of 11 arrows.
|
|
35
|
+
*
|
|
36
|
+
* @see {@link https://graphviz.org/docs/attr-types/arrowType/ arrowType}
|
|
37
|
+
* @group Attribute Types
|
|
38
|
+
*/
|
|
39
|
+
export declare type ArrowType = ArrowType.aname | `${ArrowType.aname}${ArrowType.aname}`;
|
|
40
|
+
|
|
41
|
+
/** @hidden */
|
|
42
|
+
export declare namespace ArrowType {
|
|
43
|
+
export type shape = keyof $shape;
|
|
44
|
+
export interface $shape extends $keywords<'box' | 'crow' | 'curve' | 'icurve' | 'diamond' | 'dot' | 'inv' | 'none' | 'normal' | 'tee' | 'vee'> {
|
|
45
|
+
}
|
|
46
|
+
export type side = 'l' | 'r';
|
|
47
|
+
export type modifiers = side | 'o' | `o${side}`;
|
|
48
|
+
export type aname = shape | `${modifiers}${shape}`;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* ASTType is an enumeration of the different types of nodes that can be found in an AST(Abstract Syntax Tree ).
|
|
53
|
+
* @group Models
|
|
54
|
+
*/
|
|
55
|
+
export declare type ASTType = 'Literal' | 'Dot' | 'Graph' | 'Attribute' | 'Comment' | 'AttributeList' | 'NodeRef' | 'NodeRefGroup' | 'Edge' | 'Node' | 'Subgraph';
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* This type represents an Attribute, which is a key-value mapping of an {@link AttributeKey} to a value.
|
|
59
|
+
*
|
|
60
|
+
* @param T The {@link AttributeKey} to be mapped to a value.
|
|
61
|
+
* @group Attribute
|
|
62
|
+
*/
|
|
63
|
+
export declare type Attribute<T extends AttributeKey> = Attribute.types[T];
|
|
64
|
+
|
|
65
|
+
export declare namespace Attribute {
|
|
66
|
+
export type keys = Omit<$keys, keyof $exclude | symbol | number>;
|
|
67
|
+
export type types = Omit<$types, keyof $exclude | symbol | number>;
|
|
68
|
+
/** @hidden */
|
|
69
|
+
export interface $keys extends $keywords<AttributeKey> {
|
|
70
|
+
}
|
|
71
|
+
export interface $exclude extends $keywordsValidation {
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @group Attribute
|
|
75
|
+
*/
|
|
76
|
+
export interface $keys {
|
|
77
|
+
/**
|
|
78
|
+
* Factor damping force motions.
|
|
79
|
+
* On each iteration, a nodes movement is limited to this factor of its potential motion.
|
|
80
|
+
* By being less than 1.0, the system tends to ``cool'', thereby preventing cycling.
|
|
81
|
+
*
|
|
82
|
+
* @see {@link https://graphviz.org/docs/attrs/Damping/ Node, Edge and Graph Attributes#Damping}
|
|
83
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
84
|
+
* @graphvizDefault 0.99
|
|
85
|
+
* @graphvizMinimum 0
|
|
86
|
+
* @graphvizNotes neato only
|
|
87
|
+
* @graphvizUsedBy G
|
|
88
|
+
* @category Attribute
|
|
89
|
+
*/
|
|
90
|
+
Damping: 'Damping';
|
|
91
|
+
/**
|
|
92
|
+
* Spring constant used in virtual physical model.
|
|
93
|
+
* It roughly corresponds to an ideal edge length (in inches), in that increasing K tends to increase the distance between nodes.
|
|
94
|
+
* Note that the edge attribute {@link len} can be used to override this value for adjacent nodes.
|
|
95
|
+
*
|
|
96
|
+
* @see {@link https://graphviz.org/docs/attrs/K/ Node, Edge and Graph Attributes#K}
|
|
97
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
98
|
+
* @graphvizDefault 0.3
|
|
99
|
+
* @graphvizMinimum 0
|
|
100
|
+
* @graphvizNotes sfdp, fdp only
|
|
101
|
+
* @graphvizUsedBy GC
|
|
102
|
+
* @category Attribute
|
|
103
|
+
*/
|
|
104
|
+
K: 'K';
|
|
105
|
+
/**
|
|
106
|
+
* Hyperlinks incorporated into device-dependent output.
|
|
107
|
+
* At present, used in ps2, cmap, i*map and svg formats.
|
|
108
|
+
* For all these formats, URLs can be attached to nodes, edges and clusters.
|
|
109
|
+
* URL attributes can also be attached to the root graph in ps2, cmap and i*map formats.
|
|
110
|
+
* This serves as the base URL for relative URLs in the former, and as the default image map file in the latter.
|
|
111
|
+
*
|
|
112
|
+
* For svg, cmapx and imap output, the active area for a node is its visible image.
|
|
113
|
+
* For example, an unfilled node with no drawn boundary will only be active on its label.
|
|
114
|
+
* For other output, the active area is its bounding box.
|
|
115
|
+
* The active area for a cluster is its bounding box.
|
|
116
|
+
* For edges, the active areas are small circles where the edge contacts its head and tail nodes.
|
|
117
|
+
* In addition, for svg, cmapx and imap, the active area includes a thin polygon approximating the edge.
|
|
118
|
+
* The circles may overlap the related node, and the edge URL dominates.
|
|
119
|
+
* If the edge has a label, this will also be active. Finally, if the edge has a head or tail label, this will also be active.
|
|
120
|
+
*
|
|
121
|
+
* Note that, for edges, the attributes {@link headURL}, {@link tailURL}, {@link labelURL} and {@link edgeURL} allow control of various parts of an edge.
|
|
122
|
+
* Also note that, if active areas of two edges overlap, it is unspecified which area dominates.
|
|
123
|
+
*
|
|
124
|
+
* @see {@link https://graphviz.org/docs/attrs/URL/ Node, Edge and Graph Attributes#URL}
|
|
125
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
126
|
+
* @graphvizDefault <none>
|
|
127
|
+
* @graphvizNotes svg, postscript, map only
|
|
128
|
+
* @graphvizUsedBy ENGC
|
|
129
|
+
* @category Attribute
|
|
130
|
+
*/
|
|
131
|
+
URL: 'URL';
|
|
132
|
+
/**
|
|
133
|
+
* A string in the {@link https://graphviz.org/_pages/doc/info/output.html#d:xdot xdot format} specifying an arbitrary background.
|
|
134
|
+
* During rendering, the canvas is first filled as described in the {@link bgcolor} attribute.
|
|
135
|
+
* Then, if _background is defined, the graphics operations described in the string are performed on the canvas.
|
|
136
|
+
*
|
|
137
|
+
* @see {@link https://graphviz.org/docs/attrs/_background/ Node, Edge and Graph Attributes#_background}
|
|
138
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
139
|
+
* @graphvizDefault <none>
|
|
140
|
+
* @graphvizUsedBy G
|
|
141
|
+
* @category Attribute
|
|
142
|
+
*/
|
|
143
|
+
_background: '_background';
|
|
144
|
+
/**
|
|
145
|
+
* Indicates the preferred area for a node or empty cluster when laid out by patchwork.
|
|
146
|
+
*
|
|
147
|
+
* @see {@link https://graphviz.org/docs/attrs/area/ Node, Edge and Graph Attributes#area}
|
|
148
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
149
|
+
* @graphvizDefault 1
|
|
150
|
+
* @graphvizMinimum >0
|
|
151
|
+
* @graphvizNotes patchwork only
|
|
152
|
+
* @graphvizUsedBy NC
|
|
153
|
+
* @category Attribute
|
|
154
|
+
*/
|
|
155
|
+
area: 'area';
|
|
156
|
+
/**
|
|
157
|
+
* Style of arrowhead on the head node of an edge.
|
|
158
|
+
* This will only appear if the {@link dir} attribute is "forward" or "both".
|
|
159
|
+
*
|
|
160
|
+
* See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
161
|
+
*
|
|
162
|
+
* @see {@link https://graphviz.org/docs/attrs/arrowhead/ Node, Edge and Graph Attributes#arrowhead}
|
|
163
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/arrowType/ arrowType}
|
|
164
|
+
* @graphvizDefault normal
|
|
165
|
+
* @graphvizUsedBy E
|
|
166
|
+
* @category Attribute
|
|
167
|
+
*/
|
|
168
|
+
arrowhead: 'arrowhead';
|
|
169
|
+
/**
|
|
170
|
+
* Multiplicative scale factor for arrowheads.
|
|
171
|
+
*
|
|
172
|
+
* @see {@link https://graphviz.org/docs/attrs/arrowsize/ Node, Edge and Graph Attributes#arrowsize}
|
|
173
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
174
|
+
* @graphvizDefault 1
|
|
175
|
+
* @graphvizMinimum 0
|
|
176
|
+
* @graphvizUsedBy E
|
|
177
|
+
* @category Attribute
|
|
178
|
+
*/
|
|
179
|
+
arrowsize: 'arrowsize';
|
|
180
|
+
/**
|
|
181
|
+
* Style of arrowhead on the tail node of an edge.
|
|
182
|
+
* This will only appear if the {@link dir} attribute is "back" or "both".
|
|
183
|
+
*
|
|
184
|
+
* See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
185
|
+
*
|
|
186
|
+
* @see {@link https://graphviz.org/docs/attrs/arrowtail/ Node, Edge and Graph Attributes#arrowtail}
|
|
187
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/arrowType/ arrowType}
|
|
188
|
+
* @graphvizDefault normal
|
|
189
|
+
* @graphvizUsedBy E
|
|
190
|
+
* @category Attribute
|
|
191
|
+
*/
|
|
192
|
+
arrowtail: 'arrowtail';
|
|
193
|
+
/**
|
|
194
|
+
* Bounding box of drawing in points.
|
|
195
|
+
*
|
|
196
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/rect/ rect}
|
|
197
|
+
* @graphvizNotes write only
|
|
198
|
+
* @graphvizUsedBy G
|
|
199
|
+
* @category Attribute
|
|
200
|
+
*/
|
|
201
|
+
bb: 'bb';
|
|
202
|
+
/**
|
|
203
|
+
* When attached to the root graph, this color is used as the background for entire canvas.
|
|
204
|
+
* When a cluster attribute, it is used as the initial background for the cluster.
|
|
205
|
+
* If a cluster has a filled {@link style}, the cluster's {@link fillcolor} will overlay the background color.
|
|
206
|
+
*
|
|
207
|
+
* @see {@link https://graphviz.org/docs/attrs/bgcolor/ Node, Edge and Graph Attributes#bgcolor}
|
|
208
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/color/ color}/{@link https://graphviz.org/docs/attr-types/color/List colorList}
|
|
209
|
+
* @graphvizDefault <none>
|
|
210
|
+
* @graphvizUsedBy GC
|
|
211
|
+
* @category Attribute
|
|
212
|
+
*/
|
|
213
|
+
bgcolor: 'bgcolor';
|
|
214
|
+
/**
|
|
215
|
+
* If true, the drawing is centered in the output canvas.
|
|
216
|
+
*
|
|
217
|
+
* @see {@link https://graphviz.org/docs/attrs/center/ Node, Edge and Graph Attributes#center}
|
|
218
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
219
|
+
* @graphvizDefault FALSE
|
|
220
|
+
* @graphvizUsedBy G
|
|
221
|
+
* @category Attribute
|
|
222
|
+
*/
|
|
223
|
+
center: 'center';
|
|
224
|
+
/**
|
|
225
|
+
* Specifies the character encoding used when interpreting string input as a text label.
|
|
226
|
+
* The default value is "UTF-8". The other legal value is "iso-8859-1" or, equivalently, "Latin1".
|
|
227
|
+
* The charset attribute is case-insensitive.
|
|
228
|
+
* Note that if the character encoding used in the input does not match the charset value, the resulting output may be very strange.
|
|
229
|
+
*
|
|
230
|
+
* @see {@link https://graphviz.org/docs/attrs/charset/ Node, Edge and Graph Attributes#charset}
|
|
231
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
232
|
+
* @graphvizDefault "UTF-8"
|
|
233
|
+
* @graphvizUsedBy G
|
|
234
|
+
*
|
|
235
|
+
* @category Attribute
|
|
236
|
+
*/
|
|
237
|
+
charset: 'charset';
|
|
238
|
+
/**
|
|
239
|
+
* Classnames to attach to the node, edge, graph, or cluster's SVG element.
|
|
240
|
+
* Combine with stylesheet for styling SVG output using CSS classnames.
|
|
241
|
+
*
|
|
242
|
+
* @see {@link https://graphviz.org/docs/attrs/class/ class}
|
|
243
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
244
|
+
* @graphvizDefault ""
|
|
245
|
+
* @graphvizUsedBy ENCG
|
|
246
|
+
*/
|
|
247
|
+
class: 'class';
|
|
248
|
+
/**
|
|
249
|
+
* Mode used for handling clusters.
|
|
250
|
+
* If clusterrank is "local", a subgraph whose name begins with "cluster" is given special treatment.
|
|
251
|
+
* The subgraph is laid out separately, and then integrated as a unit into its parent graph, with a bounding rectangle drawn about it.
|
|
252
|
+
* If the cluster has a label parameter, this label is displayed within the rectangle.
|
|
253
|
+
* Note also that there can be clusters within clusters.
|
|
254
|
+
* At present, the modes "global" and "none" appear to be identical, both turning off the special cluster processing.
|
|
255
|
+
*
|
|
256
|
+
* @see {@link https://graphviz.org/docs/attrs/clusterrank/ Node, Edge and Graph Attributes#clusterrank}
|
|
257
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:clusterMode clusterMode}
|
|
258
|
+
* @graphvizDefault local
|
|
259
|
+
* @graphvizNotes dot only
|
|
260
|
+
* @graphvizUsedBy G
|
|
261
|
+
* @category Attribute
|
|
262
|
+
*/
|
|
263
|
+
clusterrank: 'clusterrank';
|
|
264
|
+
/**
|
|
265
|
+
* Basic drawing color for graphics, not text.
|
|
266
|
+
* For the latter, use the fontcolor attribute.
|
|
267
|
+
*
|
|
268
|
+
* For edges, the value can either be a single color or a colorList.
|
|
269
|
+
* In the latter case, if colorList has no fractions, the edge is drawn using parallel splines or lines, one for each color in the list, in the order given.
|
|
270
|
+
* The head arrow, if any, is drawn using the first color in the list, and the tail arrow, if any, the second color.
|
|
271
|
+
* This supports the common case of drawing opposing edges, but using parallel splines instead of separately routed multiedges.
|
|
272
|
+
* If any fraction is used, the colors are drawn in series, with each color being given roughly its specified fraction of the edge.
|
|
273
|
+
* For example, the graph
|
|
274
|
+
*
|
|
275
|
+
* ```dot
|
|
276
|
+
* digraph G {
|
|
277
|
+
* a -> b [dir=both color="red:blue"]
|
|
278
|
+
* c -> d [dir=none color="green:red;0.25:blue"]
|
|
279
|
+
* }
|
|
280
|
+
* ```
|
|
281
|
+
*
|
|
282
|
+
* yields
|
|
283
|
+
*
|
|
284
|
+
* 
|
|
285
|
+
*
|
|
286
|
+
* @see {@link https://graphviz.org/docs/attrs/color/ Node, Edge and Graph Attributes#color}
|
|
287
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/color/ color}/{@link https://graphviz.org/docs/attr-types/color/List colorList}
|
|
288
|
+
* @graphvizDefault black
|
|
289
|
+
* @graphvizUsedBy ENC
|
|
290
|
+
* @category Attribute
|
|
291
|
+
*/
|
|
292
|
+
color: 'color';
|
|
293
|
+
/**
|
|
294
|
+
* This attribute specifies a color scheme namespace.
|
|
295
|
+
* If defined, it specifies the context for interpreting color names.
|
|
296
|
+
* In particular, if a color value has form "xxx" or "//xxx", then the color xxx will be evaluated according to the current color scheme.
|
|
297
|
+
* If no color scheme is set, the standard X11 naming is used.
|
|
298
|
+
* For example, if colorscheme=bugn9, then color=7 is interpreted as "/bugn9/7".
|
|
299
|
+
*
|
|
300
|
+
* @see {@link https://graphviz.org/docs/attrs/colorscheme/ Node, Edge and Graph Attributes#colorscheme}
|
|
301
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
302
|
+
* @graphvizDefault ""
|
|
303
|
+
* @graphvizUsedBy ENCG
|
|
304
|
+
* @category Attribute
|
|
305
|
+
*/
|
|
306
|
+
colorscheme: 'colorscheme';
|
|
307
|
+
/**
|
|
308
|
+
* Comments are inserted into output.
|
|
309
|
+
* Device-dependent
|
|
310
|
+
*
|
|
311
|
+
* @see {@link https://graphviz.org/docs/attrs/comment/ Node, Edge and Graph Attributes#comment}
|
|
312
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
313
|
+
* @graphvizDefault ""
|
|
314
|
+
* @graphvizUsedBy ENG
|
|
315
|
+
* @category Attribute
|
|
316
|
+
*/
|
|
317
|
+
comment: 'comment';
|
|
318
|
+
/**
|
|
319
|
+
* If true, allow edges between clusters. (See {@link lhead} and {@link ltail} below.)
|
|
320
|
+
*
|
|
321
|
+
* @see {@link https://graphviz.org/docs/attrs/compound/ Node, Edge and Graph Attributes#compound}
|
|
322
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
323
|
+
* @graphvizDefault FALSE
|
|
324
|
+
* @graphvizNotes dot only
|
|
325
|
+
* @graphvizUsedBy G
|
|
326
|
+
* @category Attribute
|
|
327
|
+
*/
|
|
328
|
+
compound: 'compound';
|
|
329
|
+
/**
|
|
330
|
+
* If true, use edge concentrators.
|
|
331
|
+
* This merges multiedges into a single edge and causes partially parallel edges to share part of their paths.
|
|
332
|
+
* The latter feature is not yet available outside of dot.
|
|
333
|
+
*
|
|
334
|
+
* @see {@link https://graphviz.org/docs/attrs/concentrate/ Node, Edge and Graph Attributes#concentrate}
|
|
335
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
336
|
+
* @graphvizDefault FALSE
|
|
337
|
+
* @graphvizUsedBy G
|
|
338
|
+
* @category Attribute
|
|
339
|
+
*/
|
|
340
|
+
concentrate: 'concentrate';
|
|
341
|
+
/**
|
|
342
|
+
* If false, the edge is not used in ranking the nodes.
|
|
343
|
+
* For example, in the graph
|
|
344
|
+
*
|
|
345
|
+
* ```graphviz
|
|
346
|
+
* digraph G {
|
|
347
|
+
* a -> c;
|
|
348
|
+
* a -> b;
|
|
349
|
+
* b -> c [constraint=false];
|
|
350
|
+
* }
|
|
351
|
+
* ```
|
|
352
|
+
*
|
|
353
|
+
* the edge `b -> c` does not add a constraint during rank assignment, so the only constraints are that a be above b and c, yielding the graph:
|
|
354
|
+
*
|
|
355
|
+
* 
|
|
356
|
+
*
|
|
357
|
+
* @see {@link https://graphviz.org/docs/attrs/constraint/ Node, Edge and Graph Attributes#constraint}
|
|
358
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
359
|
+
* @graphvizDefault TRUE
|
|
360
|
+
* @graphvizNotes dot only
|
|
361
|
+
* @graphvizUsedBy E
|
|
362
|
+
* @category Attribute
|
|
363
|
+
*/
|
|
364
|
+
constraint: 'constraint';
|
|
365
|
+
/**
|
|
366
|
+
* If true, attach edge label to edge by a 2-segment polyline, underlining the label, then going to the closest point of spline.
|
|
367
|
+
*
|
|
368
|
+
* @see {@link https://graphviz.org/docs/attrs/decorate/ Node, Edge and Graph Attributes#decorate}
|
|
369
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
370
|
+
* @graphvizDefault FALSE
|
|
371
|
+
* @graphvizUsedBy E
|
|
372
|
+
* @category Attribute
|
|
373
|
+
*/
|
|
374
|
+
decorate: 'decorate';
|
|
375
|
+
/**
|
|
376
|
+
* This specifies the distance between nodes in separate connected components.
|
|
377
|
+
* If set too small, connected components may overlap. Only applicable if {@link pack}=false.
|
|
378
|
+
*
|
|
379
|
+
* @see {@link https://graphviz.org/docs/attrs/defaultdist/ Node, Edge and Graph Attributes#defaultdist}
|
|
380
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
381
|
+
* @graphvizDefault 1+(avg. len)*sqrt(|V|)
|
|
382
|
+
* @graphvizMinimum epsilon
|
|
383
|
+
* @graphvizNotes neato only
|
|
384
|
+
* @graphvizUsedBy G
|
|
385
|
+
* @category Attribute
|
|
386
|
+
*/
|
|
387
|
+
defaultdist: 'defaultdist';
|
|
388
|
+
/**
|
|
389
|
+
* Set the number of dimensions used for the layout.
|
|
390
|
+
* The maximum value allowed is 10.
|
|
391
|
+
*
|
|
392
|
+
* @see {@link https://graphviz.org/docs/attrs/dim/ Node, Edge and Graph Attributes#dim}
|
|
393
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
394
|
+
* @graphvizDefault 2
|
|
395
|
+
* @graphvizMinimum 2
|
|
396
|
+
* @graphvizNotes sfdp, fdp, neato only
|
|
397
|
+
* @graphvizUsedBy G
|
|
398
|
+
* @category Attribute
|
|
399
|
+
*/
|
|
400
|
+
dim: 'dim';
|
|
401
|
+
/**
|
|
402
|
+
* Set the number of dimensions used for rendering.
|
|
403
|
+
* The maximum value allowed is 10.
|
|
404
|
+
* If both dimen and dim are set, the latter specifies the dimension used for layout, and the former for rendering.
|
|
405
|
+
* If only dimen is set, this is used for both layout and rendering dimensions.
|
|
406
|
+
*
|
|
407
|
+
* Note that, at present, all aspects of rendering are 2D.
|
|
408
|
+
* This includes the shape and size of nodes, overlap removal, and edge routing.
|
|
409
|
+
* Thus, for dimen > 2, the only valid information is the pos attribute of the nodes.
|
|
410
|
+
* All other coordinates will be 2D and, at best, will reflect a projection of a higher-dimensional point onto the plane.
|
|
411
|
+
*
|
|
412
|
+
* @see {@link https://graphviz.org/docs/attrs/dimen/ Node, Edge and Graph Attributes#dimen}
|
|
413
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
414
|
+
* @graphvizDefault 2
|
|
415
|
+
* @graphvizMinimum 2
|
|
416
|
+
* @graphvizNotes sfdp, fdp, neato only
|
|
417
|
+
* @graphvizUsedBy G
|
|
418
|
+
* @category Attribute
|
|
419
|
+
*/
|
|
420
|
+
dimen: 'dimen';
|
|
421
|
+
/**
|
|
422
|
+
* Set edge type for drawing arrowheads.
|
|
423
|
+
* This indicates which ends of the edge should be decorated with an arrowhead.
|
|
424
|
+
* The actual style of the arrowhead can be specified using the {@link arrowhead} and {@link arrowtail} attributes.
|
|
425
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
426
|
+
*
|
|
427
|
+
* @see {@link https://graphviz.org/docs/attrs/dir/ Node, Edge and Graph Attributes#dir}
|
|
428
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/dirType/ dirType}
|
|
429
|
+
* @graphvizDefault "forward(directed) none(undirected)"
|
|
430
|
+
* @graphvizUsedBy E
|
|
431
|
+
* @category Attribute
|
|
432
|
+
*/
|
|
433
|
+
dir: 'dir';
|
|
434
|
+
/**
|
|
435
|
+
* Only valid when {@link mode}="ipsep".
|
|
436
|
+
* If true, constraints are generated for each edge in the largest (heuristic) directed acyclic subgraph such that the edge must point downwards.
|
|
437
|
+
* If "hier", generates level constraints similar to those used with {@link mode}="hier".
|
|
438
|
+
* The main difference is that, in the latter case, only these constraints are involved, so a faster solver can be used.
|
|
439
|
+
*
|
|
440
|
+
* @see {@link https://graphviz.org/docs/attrs/diredgeconstraints/ Node, Edge and Graph Attributes#diredgeconstraints}
|
|
441
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}/{@link https://graphviz.org/docs/attr-types/bool bool}
|
|
442
|
+
* @graphvizDefault FALSE
|
|
443
|
+
* @graphvizNotes neato only
|
|
444
|
+
* @graphvizUsedBy G
|
|
445
|
+
* @category Attribute
|
|
446
|
+
*/
|
|
447
|
+
diredgeconstraints: 'diredgeconstraints';
|
|
448
|
+
/**
|
|
449
|
+
* Distortion factor for {@link shape}=polygon.
|
|
450
|
+
* Positive values cause top part to be larger than bottom; negative values do the opposite.
|
|
451
|
+
*
|
|
452
|
+
* @see {@link https://graphviz.org/docs/attrs/distortion/ Node, Edge and Graph Attributes#distortion}
|
|
453
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
454
|
+
* @graphvizDefault -100
|
|
455
|
+
* @graphvizUsedBy N
|
|
456
|
+
* @category Attribute
|
|
457
|
+
*/
|
|
458
|
+
distortion: 'distortion';
|
|
459
|
+
/**
|
|
460
|
+
* This specifies the expected number of pixels per inch on a display device.
|
|
461
|
+
* For bitmap output, this guarantees that text rendering will be done more accurately, both in size and in placement.
|
|
462
|
+
* For SVG output, it is used to guarantee that the dimensions in the output correspond to the correct number of points or inches.
|
|
463
|
+
*
|
|
464
|
+
* @see {@link https://graphviz.org/docs/attrs/dpi/ Node, Edge and Graph Attributes#dpi}
|
|
465
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
466
|
+
* @graphvizDefault "96.0 0.0"
|
|
467
|
+
* @graphvizNotes svg, bitmap output only
|
|
468
|
+
* @graphvizUsedBy G
|
|
469
|
+
* @category Attribute
|
|
470
|
+
*/
|
|
471
|
+
dpi: 'dpi';
|
|
472
|
+
/**
|
|
473
|
+
* If **edgeURL** is defined, this is the link used for the non-label parts of an edge.
|
|
474
|
+
* This value overrides any {@link URL} defined for the edge.
|
|
475
|
+
* Also, this value is used near the head or tail node unless overridden by a {@link headURL} or {@link tailURL} value, respectively.
|
|
476
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
477
|
+
*
|
|
478
|
+
* @see {@link https://graphviz.org/docs/attrs/edgeURL/ Node, Edge and Graph Attributes#edgeURL}
|
|
479
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
480
|
+
* @graphvizDefault ""
|
|
481
|
+
* @graphvizNotes svg, map only
|
|
482
|
+
* @graphvizUsedBy E
|
|
483
|
+
* @category Attribute
|
|
484
|
+
*/
|
|
485
|
+
edgeURL: 'edgeURL';
|
|
486
|
+
/**
|
|
487
|
+
* Synonym for {@link edgeURL}.
|
|
488
|
+
*
|
|
489
|
+
* @see {@link https://graphviz.org/docs/attrs/edgehref/ Node, Edge and Graph Attributes#edgehref}
|
|
490
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
491
|
+
* @graphvizDefault ""
|
|
492
|
+
* @graphvizNotes svg, map only
|
|
493
|
+
* @graphvizUsedBy E
|
|
494
|
+
* @category Attribute
|
|
495
|
+
*/
|
|
496
|
+
edgehref: 'edgehref';
|
|
497
|
+
/**
|
|
498
|
+
* If the edge has a {@link URL} or {@link edgeURL} attribute, this attribute determines which window of the browser is used for the URL attached to the non-label part of the edge.
|
|
499
|
+
* Setting it to "_graphviz" will open a new window if it doesn't already exist, or reuse it if it does.
|
|
500
|
+
* If undefined, the value of the {@link target} is used.
|
|
501
|
+
*
|
|
502
|
+
* @see {@link https://graphviz.org/docs/attrs/edgetarget/ Node, Edge and Graph Attributes#edgetarget}
|
|
503
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
504
|
+
* @graphvizDefault <none>
|
|
505
|
+
* @graphvizNotes svg, map only
|
|
506
|
+
* @graphvizUsedBy E
|
|
507
|
+
* @category Attribute
|
|
508
|
+
*/
|
|
509
|
+
edgetarget: 'edgetarget';
|
|
510
|
+
/**
|
|
511
|
+
* Tooltip annotation attached to the non-label part of an edge.
|
|
512
|
+
* This is used only if the edge has a {@link URL} or {@link edgeURL} attribute.
|
|
513
|
+
*
|
|
514
|
+
* @see {@link https://graphviz.org/docs/attrs/edgetooltip/ Node, Edge and Graph Attributes#edgetooltip}
|
|
515
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
516
|
+
* @graphvizDefault ""
|
|
517
|
+
* @graphvizNotes svg, cmap only
|
|
518
|
+
* @graphvizUsedBy E
|
|
519
|
+
* @category Attribute
|
|
520
|
+
*/
|
|
521
|
+
edgetooltip: 'edgetooltip';
|
|
522
|
+
/**
|
|
523
|
+
* Terminating condition. If the length squared of all energy gradients are < **epsilon**, the algorithm stops.
|
|
524
|
+
*
|
|
525
|
+
* @see {@link https://graphviz.org/docs/attrs/epsilon/ Node, Edge and Graph Attributes#epsilon}
|
|
526
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
527
|
+
* @graphvizDefault .0001 * # nodes(mode == KK) .0001(mode == major)
|
|
528
|
+
* @graphvizNotes neato only
|
|
529
|
+
* @graphvizUsedBy G
|
|
530
|
+
* @category Attribute
|
|
531
|
+
*/
|
|
532
|
+
epsilon: 'epsilon';
|
|
533
|
+
/**
|
|
534
|
+
* Margin used around polygons for purposes of spline edge routing.
|
|
535
|
+
* The interpretation is the same as given for {@link sep}.
|
|
536
|
+
* This should normally be strictly less than {@link sep}.
|
|
537
|
+
*
|
|
538
|
+
* @see {@link https://graphviz.org/docs/attrs/esep/ Node, Edge and Graph Attributes#esep}
|
|
539
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/addDouble/ addDouble}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:addPoint addPoint}
|
|
540
|
+
* @graphvizDefault 3
|
|
541
|
+
* @graphvizNotes not dot
|
|
542
|
+
* @graphvizUsedBy G
|
|
543
|
+
* @category Attribute
|
|
544
|
+
*/
|
|
545
|
+
esep: 'esep';
|
|
546
|
+
/**
|
|
547
|
+
* Color used to fill the background of a node or cluster assuming {@link style}=filled, or a filled arrowhead.
|
|
548
|
+
* If fillcolor is not defined, {@link color} is used. (For clusters, if color is not defined, {@link bgcolor} is used.)
|
|
549
|
+
* If this is not defined, the default is used, except for {@link shape}=point or when the output format is MIF, which use black by default.
|
|
550
|
+
*
|
|
551
|
+
* If the value is a {@link colorList}, a gradient fill is used.
|
|
552
|
+
* By default, this is a linear fill; setting style=radial will cause a radial fill.
|
|
553
|
+
* At present, only two colors are used. If the second color (after a colon) is missing, the default color is used for it.
|
|
554
|
+
* See also the {@link gradientangle} attribute for setting the gradient angle.
|
|
555
|
+
*
|
|
556
|
+
* Note that a cluster inherits the root graph's attributes if defined.
|
|
557
|
+
* Thus, if the root graph has defined a **fillcolor**, this will override a **color** or **bgcolor** attribute set for the cluster.
|
|
558
|
+
*
|
|
559
|
+
* @see {@link https://graphviz.org/docs/attrs/fillcolor/ Node, Edge and Graph Attributes#fillcolor}
|
|
560
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/color/ color}/{@link https://graphviz.org/docs/attr-types/color/List colorList}
|
|
561
|
+
* @graphvizDefault "lightgrey(nodes) black(clusters)"
|
|
562
|
+
* @graphvizUsedBy NEC
|
|
563
|
+
* @category Attribute
|
|
564
|
+
*/
|
|
565
|
+
fillcolor: 'fillcolor';
|
|
566
|
+
/**
|
|
567
|
+
* If `false`, the size of a node is determined by smallest width and height needed to contain its label and image,
|
|
568
|
+
* if any, with a {@link margin} specified by the margin attribute.
|
|
569
|
+
* The width and height must also be at least as large as the sizes specified by the {@link width} and {@link height} attributes,
|
|
570
|
+
* which specify the minimum values for these parameters.
|
|
571
|
+
*
|
|
572
|
+
* If `true`, the node size is specified by the values of the {@link width} and {@link height} attributes only and is not expanded to contain the text label.
|
|
573
|
+
* There will be a warning if the label (with margin) cannot fit within these limits.
|
|
574
|
+
*
|
|
575
|
+
* If the {@link fixedsize} attribute is set to shape, the {@link width} and {@link height} attributes also determine the size of the node shape,
|
|
576
|
+
* but the label can be much larger. Both the label and shape sizes are used when avoiding node overlap,
|
|
577
|
+
* but all edges to the node ignore the label and only contact the node shape. No warning is given if the label is too large.
|
|
578
|
+
*
|
|
579
|
+
* @see {@link https://graphviz.org/docs/attrs/fixedsize/ Node, Edge and Graph Attributes#fixedsize}
|
|
580
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}/string
|
|
581
|
+
* @graphvizDefault FALSE
|
|
582
|
+
* @graphvizUsedBy N
|
|
583
|
+
* @category Attribute
|
|
584
|
+
*/
|
|
585
|
+
fixedsize: 'fixedsize';
|
|
586
|
+
/**
|
|
587
|
+
* Color used for text.
|
|
588
|
+
*
|
|
589
|
+
* @see {@link https://graphviz.org/docs/attrs/fontcolor/ Node, Edge and Graph Attributes#fontcolor}
|
|
590
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/color/ color}
|
|
591
|
+
* @graphvizDefault black
|
|
592
|
+
* @graphvizUsedBy ENGC
|
|
593
|
+
* @category Attribute
|
|
594
|
+
*/
|
|
595
|
+
fontcolor: 'fontcolor';
|
|
596
|
+
/**
|
|
597
|
+
* Font used for text.
|
|
598
|
+
* This very much depends on the output format and, for non-bitmap output such as PostScript or SVG,
|
|
599
|
+
* the availability of the font when the graph is displayed or printed.
|
|
600
|
+
* As such, it is best to rely on font faces that are generally available,
|
|
601
|
+
* such as Times-Roman, Helvetica or Courier.
|
|
602
|
+
*
|
|
603
|
+
* How font names are resolved also depends on the underlying library that handles font name resolution.
|
|
604
|
+
* If Graphviz was built using the fontconfig library, the latter library will be used to search for the font.
|
|
605
|
+
* See the commands **fc-list**, **fc-match** and the other fontconfig commands for how names are resolved and which fonts are available.
|
|
606
|
+
* Other systems may provide their own font package, such as Quartz for OS X.
|
|
607
|
+
*
|
|
608
|
+
* Note that various font attributes, such as weight and slant, can be built into the font name.
|
|
609
|
+
* Unfortunately, the syntax varies depending on which font system is dominant. Thus, using fontname="times bold italic" will produce a bold, slanted Times font using Pango, the usual main font library.
|
|
610
|
+
* Alternatively, fontname="times:italic" will produce a slanted Times font from fontconfig, while fontname="times-bold" will resolve to a bold Times using Quartz.
|
|
611
|
+
* You will need to ascertain which package is used by your Graphviz system and refer to the relevant documentation.
|
|
612
|
+
*
|
|
613
|
+
* If Graphviz is not built with a high-level font library, fontname will be considered the name of a Type 1 or True Type font file.
|
|
614
|
+
* If you specify fontname=schlbk, the tool will look for a file named schlbk.ttf or schlbk.pfa or schlbk.pfb in one of the directories specified by the {@link fontpath} attribute.
|
|
615
|
+
* The lookup does support various aliases for the common fonts.
|
|
616
|
+
*
|
|
617
|
+
* @see {@link https://graphviz.org/docs/attrs/fontname/ Node, Edge and Graph Attributes#fontname}
|
|
618
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
619
|
+
* @graphvizDefault "Times-Roman"
|
|
620
|
+
* @graphvizUsedBy ENGC
|
|
621
|
+
* @category Attribute
|
|
622
|
+
*/
|
|
623
|
+
fontname: 'fontname';
|
|
624
|
+
/**
|
|
625
|
+
* Allows user control of how basic fontnames are represented in SVG output.
|
|
626
|
+
* If fontnames is undefined or "svg", the output will try to use known SVG fontnames.
|
|
627
|
+
* For example, the default font "Times-Roman" will be mapped to the basic SVG font "serif".
|
|
628
|
+
* This can be overridden by setting fontnames to "ps" or "gd". In the former case, known PostScript font names such as "Times-Roman" will be used in the output.
|
|
629
|
+
* In the latter case, the fontconfig font conventions are used. Thus, "Times-Roman" would be treated as "Nimbus Roman No9 L".
|
|
630
|
+
* These last two options are useful with SVG viewers that support these richer fontname spaces.
|
|
631
|
+
*
|
|
632
|
+
* @see {@link https://graphviz.org/docs/attrs/fontnames/ Node, Edge and Graph Attributes#fontnames}
|
|
633
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
634
|
+
* @graphvizDefault ""
|
|
635
|
+
* @graphvizNotes svg only
|
|
636
|
+
* @graphvizUsedBy G
|
|
637
|
+
* @category Attribute
|
|
638
|
+
*/
|
|
639
|
+
fontnames: 'fontnames';
|
|
640
|
+
/**
|
|
641
|
+
* Directory list used by libgd to search for bitmap fonts if Graphviz was not built with the fontconfig library.
|
|
642
|
+
* If **fontpath** is not set, the environment variable DOTFONTPATH is checked.
|
|
643
|
+
* If that is not set, GDFONTPATH is checked.
|
|
644
|
+
* If not set, libgd uses its compiled-in font path.
|
|
645
|
+
* Note that fontpath is an attribute of the root graph.
|
|
646
|
+
*
|
|
647
|
+
* @see {@link https://graphviz.org/docs/attrs/fontpath/ Node, Edge and Graph Attributes#fontpath}
|
|
648
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
649
|
+
* @graphvizDefault system-dependent
|
|
650
|
+
* @graphvizUsedBy G
|
|
651
|
+
* @category Attribute
|
|
652
|
+
*/
|
|
653
|
+
fontpath: 'fontpath';
|
|
654
|
+
/**
|
|
655
|
+
* Font size, {@link https://graphviz.org/doc/info/attrs.html in points}, used for text.
|
|
656
|
+
*
|
|
657
|
+
* @see {@link https://graphviz.org/docs/attrs/fontsize/ Node, Edge and Graph Attributes#fontsize}
|
|
658
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
659
|
+
* @graphvizDefault 14
|
|
660
|
+
* @graphvizMinimum 1
|
|
661
|
+
* @graphvizUsedBy ENGC
|
|
662
|
+
* @category Attribute
|
|
663
|
+
*/
|
|
664
|
+
fontsize: 'fontsize';
|
|
665
|
+
/**
|
|
666
|
+
* If true, all {@link xlabel} attributes are placed,
|
|
667
|
+
* even if there is some overlap with nodes or other labels.
|
|
668
|
+
*
|
|
669
|
+
* @see {@link https://graphviz.org/docs/attrs/forcelabels/ Node, Edge and Graph Attributes#forcelabels}
|
|
670
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
671
|
+
* @graphvizDefault TRUE
|
|
672
|
+
* @graphvizUsedBy G
|
|
673
|
+
* @category Attribute
|
|
674
|
+
*/
|
|
675
|
+
forcelabels: 'forcelabels';
|
|
676
|
+
/**
|
|
677
|
+
* If a gradient fill is being used, this determines the angle of the fill.
|
|
678
|
+
* For linear fills, the colors transform along a line specified by the angle and the center of the object.
|
|
679
|
+
* For radial fills, a value of zero causes the colors to transform radially from the center; for non-zero values,
|
|
680
|
+
* the colors transform from a point near the object's periphery as specified by the value.
|
|
681
|
+
*
|
|
682
|
+
* If unset, the default angle is 0.
|
|
683
|
+
*
|
|
684
|
+
* @see {@link https://graphviz.org/docs/attrs/gradientangle/ Node, Edge and Graph Attributes#gradientangle}
|
|
685
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
686
|
+
* @graphvizDefault ""
|
|
687
|
+
* @graphvizUsedBy NCG
|
|
688
|
+
* @category Attribute
|
|
689
|
+
*/
|
|
690
|
+
gradientangle: 'gradientangle';
|
|
691
|
+
/**
|
|
692
|
+
* If the end points of an edge belong to the same group, i.e.,
|
|
693
|
+
* have the same group attribute, parameters are set to avoid crossings and keep the edges straight.
|
|
694
|
+
*
|
|
695
|
+
* @see {@link https://graphviz.org/docs/attrs/group/ Node, Edge and Graph Attributes#group}
|
|
696
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
697
|
+
* @graphvizDefault ""
|
|
698
|
+
* @graphvizNotes dot only
|
|
699
|
+
* @graphvizUsedBy N
|
|
700
|
+
* @category Attribute
|
|
701
|
+
*/
|
|
702
|
+
group: 'group';
|
|
703
|
+
/**
|
|
704
|
+
* If **headURL** is defined, it is output as part of the head label of the edge.
|
|
705
|
+
* Also, this value is used near the head node, overriding any {@link URL} value.
|
|
706
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
707
|
+
*
|
|
708
|
+
* @see {@link https://graphviz.org/docs/attrs/headURL/ Node, Edge and Graph Attributes#headURL}
|
|
709
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
710
|
+
* @graphvizDefault ""
|
|
711
|
+
* @graphvizNotes svg, map only
|
|
712
|
+
* @graphvizUsedBy E
|
|
713
|
+
* @category Attribute
|
|
714
|
+
*/
|
|
715
|
+
headURL: 'headURL';
|
|
716
|
+
/**
|
|
717
|
+
* Position of an edge's head label, {@link https://graphviz.org/doc/info/attrs.html in points}.
|
|
718
|
+
* The position indicates the center of the label.
|
|
719
|
+
*
|
|
720
|
+
* @see {@link https://graphviz.org/docs/attrs/head_lp/ Node, Edge and Graph Attributes#head_lp}
|
|
721
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/point/ point}
|
|
722
|
+
* @graphvizNotes write only
|
|
723
|
+
* @graphvizUsedBy E
|
|
724
|
+
* @category Attribute
|
|
725
|
+
*/
|
|
726
|
+
head_lp: 'head_lp';
|
|
727
|
+
/**
|
|
728
|
+
* If true, the head of an edge is clipped to the boundary of the head node; otherwise,
|
|
729
|
+
* the end of the edge goes to the center of the node, or the center of a port, if applicable.
|
|
730
|
+
*
|
|
731
|
+
* @see {@link https://graphviz.org/docs/attrs/headclip/ Node, Edge and Graph Attributes#headclip}
|
|
732
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
733
|
+
* @graphvizDefault TRUE
|
|
734
|
+
* @graphvizUsedBy E
|
|
735
|
+
* @category Attribute
|
|
736
|
+
*/
|
|
737
|
+
headclip: 'headclip';
|
|
738
|
+
/**
|
|
739
|
+
* Synonym for {@link headURL}.
|
|
740
|
+
*
|
|
741
|
+
* @see {@link https://graphviz.org/docs/attrs/headhref/ Node, Edge and Graph Attributes#headhref}
|
|
742
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
743
|
+
* @graphvizDefault ""
|
|
744
|
+
* @graphvizNotes svg, map only
|
|
745
|
+
* @graphvizUsedBy E
|
|
746
|
+
* @category Attribute
|
|
747
|
+
*/
|
|
748
|
+
headhref: 'headhref';
|
|
749
|
+
/**
|
|
750
|
+
* Text label to be placed near head of edge.
|
|
751
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
752
|
+
*
|
|
753
|
+
* @see {@link https://graphviz.org/docs/attrs/headlabel/ Node, Edge and Graph Attributes#headlabel}
|
|
754
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/lblString/ lblString}
|
|
755
|
+
* @graphvizDefault center
|
|
756
|
+
* @graphvizUsedBy E
|
|
757
|
+
* @category Attribute
|
|
758
|
+
*/
|
|
759
|
+
headlabel: 'headlabel';
|
|
760
|
+
/**
|
|
761
|
+
* Indicates where on the head node to attach the head of the edge.
|
|
762
|
+
* In the default case, the edge is aimed towards the center of the node, and then clipped at the node boundary.
|
|
763
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
764
|
+
*
|
|
765
|
+
* @see {@link https://graphviz.org/docs/attrs/headport/ Node, Edge and Graph Attributes#headport}
|
|
766
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/portPos/ portPos}
|
|
767
|
+
* @graphvizDefault <none>
|
|
768
|
+
* @graphvizNotes svg, map only
|
|
769
|
+
* @graphvizUsedBy E
|
|
770
|
+
* @category Attribute
|
|
771
|
+
*/
|
|
772
|
+
headport: 'headport';
|
|
773
|
+
/**
|
|
774
|
+
* If the edge has a {@link headURL}, this attribute determines which window of the browser is used for the URL.
|
|
775
|
+
* Setting it to "_graphviz" will open a new window if it doesn't already exist, or reuse it if it does.
|
|
776
|
+
* If undefined, the value of the {@link target} is used.
|
|
777
|
+
*
|
|
778
|
+
* @see {@link https://graphviz.org/docs/attrs/headtarget/ Node, Edge and Graph Attributes#headtarget}
|
|
779
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
780
|
+
* @graphvizDefault ""
|
|
781
|
+
* @graphvizNotes svg, cmap only
|
|
782
|
+
* @graphvizUsedBy E
|
|
783
|
+
* @category Attribute
|
|
784
|
+
*/
|
|
785
|
+
headtarget: 'headtarget';
|
|
786
|
+
/**
|
|
787
|
+
* Tooltip annotation attached to the head of an edge.
|
|
788
|
+
* This is used only if the edge has a {@link headURL} attribute.
|
|
789
|
+
*
|
|
790
|
+
* @see {@link https://graphviz.org/docs/attrs/headtooltip/ Node, Edge and Graph Attributes#headtooltip}
|
|
791
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
792
|
+
* @graphvizDefault 0.5
|
|
793
|
+
* @graphvizMinimum 0.02
|
|
794
|
+
* @graphvizUsedBy N
|
|
795
|
+
* @category Attribute
|
|
796
|
+
*/
|
|
797
|
+
headtooltip: 'headtooltip';
|
|
798
|
+
/**
|
|
799
|
+
* Height of node, in inches.
|
|
800
|
+
* This is taken as the initial, minimum height of the node.
|
|
801
|
+
* If {@link fixedsize} is true, this will be the final height of the node.
|
|
802
|
+
* Otherwise, if the node label requires more height to fit, the node's **height** will be increased to contain the label.
|
|
803
|
+
* Note also that, if the output format is dot, the value given to height will be the final value.
|
|
804
|
+
*
|
|
805
|
+
* If the node shape is regular, the width and height are made identical.
|
|
806
|
+
* In this case, if either the width or the height is set explicitly, that value is used.
|
|
807
|
+
* In this case, if both the width or the height are set explicitly, the maximum of the two values is used.
|
|
808
|
+
* If neither is set explicitly, the minimum of the two default values is used.
|
|
809
|
+
*
|
|
810
|
+
* @see {@link https://graphviz.org/docs/attrs/height/ Node, Edge and Graph Attributes#height}
|
|
811
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
812
|
+
* @graphvizDefault ""
|
|
813
|
+
* @graphvizNotes svg, postscript, map only
|
|
814
|
+
* @graphvizUsedBy GCNE
|
|
815
|
+
* @category Attribute
|
|
816
|
+
*/
|
|
817
|
+
height: 'height';
|
|
818
|
+
/**
|
|
819
|
+
* Synonym for {@link URL}.
|
|
820
|
+
*
|
|
821
|
+
* @see {@link https://graphviz.org/docs/attrs/href/ Node, Edge and Graph Attributes#href}
|
|
822
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
823
|
+
* @graphvizDefault ""
|
|
824
|
+
* @graphvizNotes svg, postscript, map only
|
|
825
|
+
* @graphvizUsedBy GCNE
|
|
826
|
+
* @category Attribute
|
|
827
|
+
*/
|
|
828
|
+
href: 'href';
|
|
829
|
+
/**
|
|
830
|
+
* Allows the graph author to provide an id for graph objects which is to be included in the output.
|
|
831
|
+
* Normal "\N", "\E", "\G" substitutions are applied.
|
|
832
|
+
* If provided, it is the responsibility of the provider to keep its values sufficiently unique for its intended downstream use.
|
|
833
|
+
* Note, in particular, that "\E" does not provide a unique id for multi-edges.
|
|
834
|
+
* If no id attribute is provided, then a unique internal id is used.
|
|
835
|
+
* However, this value is unpredictable by the graph writer.
|
|
836
|
+
* An externally provided id is not used internally.
|
|
837
|
+
*
|
|
838
|
+
* If the graph provides an id attribute, this will be used as a prefix for internally generated attributes.
|
|
839
|
+
* By making these distinct, the user can include multiple image maps in the same document.
|
|
840
|
+
*
|
|
841
|
+
* @see {@link https://graphviz.org/docs/attrs/id/ Node, Edge and Graph Attributes#id}
|
|
842
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
843
|
+
* @graphvizDefault ""
|
|
844
|
+
* @graphvizUsedBy N
|
|
845
|
+
* @category Attribute
|
|
846
|
+
*/
|
|
847
|
+
id: 'id';
|
|
848
|
+
/**
|
|
849
|
+
* Gives the name of a file containing an image to be displayed inside a node.
|
|
850
|
+
* The image file must be in one of the recognized {@link https://graphviz.org/docs/outputs/ formats},
|
|
851
|
+
* typically JPEG, PNG, GIF, BMP, SVG or Postscript, and be able to be converted into the desired output format.
|
|
852
|
+
*
|
|
853
|
+
* The file must contain the image size information.
|
|
854
|
+
* This is usually trivially true for the bitmap formats.
|
|
855
|
+
* For PostScript, the file must contain a line starting with %%BoundingBox: followed by four integers specifying the lower left x and y coordinates and the upper right x and y coordinates of the bounding box for the image, the coordinates being in points.
|
|
856
|
+
* An SVG image file must contain width and height attributes, typically as part of the svg element.
|
|
857
|
+
* The values for these should have the form of a floating point number, followed by optional units, e.g.,
|
|
858
|
+
* width="76pt". Recognized units are in, px, pc, pt, cm and mm for inches, pixels, picas, points, centimeters and millimeters, respectively.
|
|
859
|
+
* The default unit is points.
|
|
860
|
+
*
|
|
861
|
+
* Unlike with the {@link shapefile} attribute, the image is treated as node content rather than the entire node. In particular, an image can be contained in a node of any shape, not just a rectangle.
|
|
862
|
+
*
|
|
863
|
+
* @see {@link https://graphviz.org/docs/attrs/image/ Node, Edge and Graph Attributes#image}
|
|
864
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
865
|
+
* @graphvizDefault ""
|
|
866
|
+
* @graphvizUsedBy G
|
|
867
|
+
* @category Attribute
|
|
868
|
+
*/
|
|
869
|
+
image: 'image';
|
|
870
|
+
/**
|
|
871
|
+
* Specifies a list of directories in which to look for image files as specified by the {@link image} attribute or using the IMG element in {@link https://graphviz.org/doc/info/shapes.html HTML-like labels}.
|
|
872
|
+
* The string should be a list of (absolute or relative) pathnames, each separated by a semicolon (for Windows) or a colon (all other OS).
|
|
873
|
+
* The first directory in which a file of the given name is found will be used to load the image.
|
|
874
|
+
* If imagepath is not set, relative pathnames for the image file will be interpreted with respect to the current working directory.
|
|
875
|
+
*
|
|
876
|
+
* @see {@link https://graphviz.org/docs/attrs/imagepath/ Node, Edge and Graph Attributes#imagepath}
|
|
877
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
878
|
+
* @graphvizDefault ""
|
|
879
|
+
* @graphvizUsedBy G
|
|
880
|
+
* @category Attribute
|
|
881
|
+
*/
|
|
882
|
+
imagepath: 'imagepath';
|
|
883
|
+
/**
|
|
884
|
+
* Attribute controlling how an image is positioned within its containing node.
|
|
885
|
+
* This only has an effect when the image is smaller than the containing node.
|
|
886
|
+
* The default is to be centered both horizontally and vertically.
|
|
887
|
+
* Valid values:
|
|
888
|
+
*
|
|
889
|
+
* | | |
|
|
890
|
+
* |----|-------------------------------|
|
|
891
|
+
* | tl | Top Left |
|
|
892
|
+
* | tc | Top Centered |
|
|
893
|
+
* | tr | Top Right |
|
|
894
|
+
* | ml | Middle Left |
|
|
895
|
+
* | mc | Middle Centered (the default) |
|
|
896
|
+
* | mr | Middle Right |
|
|
897
|
+
* | bl | Bottom Left |
|
|
898
|
+
* | bc | Bottom Centered |
|
|
899
|
+
* | br | Bottom Right |
|
|
900
|
+
*
|
|
901
|
+
* @see {@link https://graphviz.org/docs/attrs/imagepos/ Node, Edge and Graph Attributes#imagepos}
|
|
902
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
903
|
+
* @graphvizDefault "mc"
|
|
904
|
+
* @graphvizUsedBy N
|
|
905
|
+
* @category Attribute
|
|
906
|
+
*/
|
|
907
|
+
imagepos: 'imagepos';
|
|
908
|
+
/**
|
|
909
|
+
* Attribute controlling how an image fills its containing node.
|
|
910
|
+
* In general, the image is given its natural size, (cf. {@link dpi}), and the node size is made large enough to contain its image, its label, its margin, and its peripheries.
|
|
911
|
+
* Its width and height will also be at least as large as its minimum {@link width} and {@link height}.
|
|
912
|
+
* If, however, fixedsize=true, the width and height attributes specify the exact size of the node.
|
|
913
|
+
*
|
|
914
|
+
* During rendering, in the default case (imagescale=false), the image retains its natural size. If imagescale=true, the image is uniformly scaled (i.e., its aspect ratio is preserved) to fit inside the node. At least one dimension of the image will be as large as possible given the size of the node. When imagescale=width, the width of the image is scaled to fill the node width. The corresponding property holds when imagescale=height. When imagescale=both, both the height and the width are scaled separately to fill the node.
|
|
915
|
+
*
|
|
916
|
+
* In all cases, if a dimension of the image is larger than the corresponding dimension of the node,
|
|
917
|
+
* that dimension of the image is scaled down to fit the node.
|
|
918
|
+
* As with the case of expansion, if imagescale=true, width and height are scaled uniformly.
|
|
919
|
+
*
|
|
920
|
+
* @see {@link https://graphviz.org/docs/attrs/imagescale/ Node, Edge and Graph Attributes#imagescale}
|
|
921
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}/string
|
|
922
|
+
* @graphvizDefault FALSE
|
|
923
|
+
* @graphvizUsedBy N
|
|
924
|
+
* @category Attribute
|
|
925
|
+
*/
|
|
926
|
+
imagescale: 'imagescale';
|
|
927
|
+
/**
|
|
928
|
+
* For layout algorithms that support initial input positions (specified by the pos attribute),
|
|
929
|
+
* this attribute can be used to appropriately scale the values.
|
|
930
|
+
* By default, fdp and neato interpret the x and y values of pos as being in inches.
|
|
931
|
+
* (**NOTE**: neato -n(2) treats the coordinates as being in points, being the unit used by the layout algorithms for the pos attribute.)
|
|
932
|
+
* Thus, if the graph has pos attributes in points, one should set inputscale=72.
|
|
933
|
+
* This can also be set on the command line using the {@link https://graphviz.org/doc/info/command.html#-s -s flag} flag.
|
|
934
|
+
*
|
|
935
|
+
* If not set, no scaling is done and the units on input are treated as inches.
|
|
936
|
+
* A value of 0 is equivalent to inputscale=72.
|
|
937
|
+
*
|
|
938
|
+
* @see {@link https://graphviz.org/docs/attrs/inputscale/ Node, Edge and Graph Attributes#inputscale}
|
|
939
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
940
|
+
* @graphvizDefault <none>
|
|
941
|
+
* @graphvizNotes fdp, neato only
|
|
942
|
+
* @graphvizUsedBy G
|
|
943
|
+
* @category Attribute
|
|
944
|
+
*/
|
|
945
|
+
inputscale: 'inputscale';
|
|
946
|
+
/**
|
|
947
|
+
* Text label attached to objects.
|
|
948
|
+
* If a node's {@link shape} is record, then the label can have a {@link https://graphviz.org/doc/info/shapes.html special format} which describes the record layout.
|
|
949
|
+
*
|
|
950
|
+
* Note that a node's default label is "\N", so the node's name or ID becomes its label.
|
|
951
|
+
* Technically, a node's name can be an HTML string but this will not mean that the node's label will be interpreted as an {@link https://graphviz.org/doc/info/shapes.html HTML-like} label.
|
|
952
|
+
* This is because the node's actual label is an ordinary string, which will be replaced by the raw bytes stored in the node's name.
|
|
953
|
+
* To get an HTML-like label, the label attribute value itself must be an HTML string.
|
|
954
|
+
*
|
|
955
|
+
* @see {@link https://graphviz.org/docs/attrs/label/ Node, Edge and Graph Attributes#label}
|
|
956
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/lblString/ lblString}
|
|
957
|
+
* @graphvizDefaultValu
|
|
958
|
+
* "\N" (nodes)
|
|
959
|
+
* "" (otherwise)
|
|
960
|
+
* @graphvizUsedBy ENGC
|
|
961
|
+
* @category Attribute
|
|
962
|
+
*/
|
|
963
|
+
label: 'label';
|
|
964
|
+
/**
|
|
965
|
+
* If **labelURL** is defined, this is the link used for the label of an edge.
|
|
966
|
+
* This value overrides any {@link URL} defined for the edge.
|
|
967
|
+
*
|
|
968
|
+
* @see {@link https://graphviz.org/docs/attrs/labelURL/ Node, Edge and Graph Attributes#labelURL}
|
|
969
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
970
|
+
* @graphvizDefault ""
|
|
971
|
+
* @graphvizNotes svg, map only
|
|
972
|
+
* @graphvizUsedBy E
|
|
973
|
+
* @category Attribute
|
|
974
|
+
*/
|
|
975
|
+
labelURL: 'labelURL';
|
|
976
|
+
/**
|
|
977
|
+
* The value indicates whether to treat a node whose name has the form |edgelabel|* as a special node representing an edge label.
|
|
978
|
+
* The default (0) produces no effect.
|
|
979
|
+
* If the attribute is set to 1, sfdp uses a penalty-based method to make that kind of node close to the center of its neighbor.
|
|
980
|
+
* With a value of 2, sfdp uses a penalty-based method to make that kind of node close to the old center of its neighbor.
|
|
981
|
+
* Finally, a value of 3 invokes a two-step process of overlap removal and straightening.
|
|
982
|
+
*
|
|
983
|
+
* @see {@link https://graphviz.org/docs/attrs/label_scheme/ Node, Edge and Graph Attributes#label_scheme}
|
|
984
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
985
|
+
* @graphvizDefault 0
|
|
986
|
+
* @graphvizMinimum 0
|
|
987
|
+
* @graphvizNotes sfdp only
|
|
988
|
+
* @graphvizUsedBy G
|
|
989
|
+
* @category Attribute
|
|
990
|
+
*/
|
|
991
|
+
label_scheme: 'label_scheme';
|
|
992
|
+
/**
|
|
993
|
+
* This, along with {@link labeldistance}, determine where the headlabel (taillabel) are placed with respect to the head (tail) in polar coordinates.
|
|
994
|
+
* The origin in the coordinate system is the point where the edge touches the node.
|
|
995
|
+
* The ray of 0 degrees goes from the origin back along the edge, parallel to the edge at the origin.
|
|
996
|
+
*
|
|
997
|
+
* The angle, in degrees, specifies the rotation from the 0 degree ray, with positive angles moving counterclockwise and negative angles moving clockwise.
|
|
998
|
+
*
|
|
999
|
+
* @see {@link https://graphviz.org/docs/attrs/labelangle/ Node, Edge and Graph Attributes#labelangle}
|
|
1000
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1001
|
+
* @graphvizDefault -25
|
|
1002
|
+
* @graphvizMinimum -180
|
|
1003
|
+
* @graphvizUsedBy E
|
|
1004
|
+
* @category Attribute
|
|
1005
|
+
*/
|
|
1006
|
+
labelangle: 'labelangle';
|
|
1007
|
+
/**
|
|
1008
|
+
* Multiplicative scaling factor adjusting the distance that the headlabel(taillabel) is from the head(tail) node.
|
|
1009
|
+
* The default distance is 10 points.
|
|
1010
|
+
* See {@link labelangle} for more details.
|
|
1011
|
+
*
|
|
1012
|
+
* @see {@link https://graphviz.org/docs/attrs/labeldistance/ Node, Edge and Graph Attributes#labeldistance}
|
|
1013
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1014
|
+
* @graphvizDefault 1
|
|
1015
|
+
* @graphvizMinimum 0
|
|
1016
|
+
* @graphvizUsedBy E
|
|
1017
|
+
* @category Attribute
|
|
1018
|
+
*/
|
|
1019
|
+
labeldistance: 'labeldistance';
|
|
1020
|
+
/**
|
|
1021
|
+
* If true, allows edge labels to be less constrained in position.
|
|
1022
|
+
* In particular, it may appear on top of other edges.
|
|
1023
|
+
*
|
|
1024
|
+
* @see {@link https://graphviz.org/docs/attrs/labelfloat/ Node, Edge and Graph Attributes#labelfloat}
|
|
1025
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1026
|
+
* @graphvizDefault FALSE
|
|
1027
|
+
* @graphvizUsedBy E
|
|
1028
|
+
* @category Attribute
|
|
1029
|
+
*/
|
|
1030
|
+
labelfloat: 'labelfloat';
|
|
1031
|
+
/**
|
|
1032
|
+
* Color used for headlabel and taillabel.
|
|
1033
|
+
* If not set, defaults to edge's fontcolor.
|
|
1034
|
+
*
|
|
1035
|
+
* @see {@link https://graphviz.org/docs/attrs/labelfontcolor/ Node, Edge and Graph Attributes#labelfontcolor}
|
|
1036
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/color/ color}
|
|
1037
|
+
* @graphvizDefault black
|
|
1038
|
+
* @graphvizUsedBy E
|
|
1039
|
+
* @category Attribute
|
|
1040
|
+
*/
|
|
1041
|
+
labelfontcolor: 'labelfontcolor';
|
|
1042
|
+
/**
|
|
1043
|
+
* Font used for headlabel and taillabel.
|
|
1044
|
+
* If not set, defaults to edge's fontname.
|
|
1045
|
+
*
|
|
1046
|
+
* @see {@link https://graphviz.org/docs/attrs/labelfontname/ Node, Edge and Graph Attributes#labelfontname}
|
|
1047
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1048
|
+
* @graphvizDefault "Times-Roman"
|
|
1049
|
+
* @graphvizUsedBy E
|
|
1050
|
+
* @category Attribute
|
|
1051
|
+
*/
|
|
1052
|
+
labelfontname: 'labelfontname';
|
|
1053
|
+
/**
|
|
1054
|
+
* Font size, {@link https://graphviz.org/doc/info/attrs.html in points}, used for headlabel and taillabel.
|
|
1055
|
+
* If not set, defaults to edge's fontsize.
|
|
1056
|
+
*
|
|
1057
|
+
* @see {@link https://graphviz.org/docs/attrs/labelfontsize/ Node, Edge and Graph Attributes#labelfontsize}
|
|
1058
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1059
|
+
* @graphvizDefault 14
|
|
1060
|
+
* @graphvizMinimum 1
|
|
1061
|
+
* @graphvizUsedBy E
|
|
1062
|
+
* @category Attribute
|
|
1063
|
+
*/
|
|
1064
|
+
labelfontsize: 'labelfontsize';
|
|
1065
|
+
/**
|
|
1066
|
+
* Synonym for {@link labelURL}.
|
|
1067
|
+
*
|
|
1068
|
+
* @see {@link https://graphviz.org/docs/attrs/labelhref/ Node, Edge and Graph Attributes#labelhref}
|
|
1069
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
1070
|
+
* @graphvizDefault ""
|
|
1071
|
+
* @graphvizNotes svg, map only
|
|
1072
|
+
* @graphvizUsedBy E
|
|
1073
|
+
* @category Attribute
|
|
1074
|
+
*/
|
|
1075
|
+
labelhref: 'labelhref';
|
|
1076
|
+
/**
|
|
1077
|
+
* Justification for cluster labels.
|
|
1078
|
+
* If "r", the label is right-justified within bounding rectangle; if "l", left-justified; else the label is centered.
|
|
1079
|
+
* Note that a subgraph inherits attributes from its parent.
|
|
1080
|
+
* Thus, if the root graph sets **labeljust** to "l", the subgraph inherits this value.
|
|
1081
|
+
*
|
|
1082
|
+
* @see {@link https://graphviz.org/docs/attrs/labeljust/ Node, Edge and Graph Attributes#labeljust}
|
|
1083
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1084
|
+
* @graphvizDefault "c"
|
|
1085
|
+
* @graphvizUsedBy GC
|
|
1086
|
+
* @category Attribute
|
|
1087
|
+
*/
|
|
1088
|
+
labeljust: 'labeljust';
|
|
1089
|
+
/**
|
|
1090
|
+
* Vertical placement of labels for nodes, root graphs and clusters.
|
|
1091
|
+
*
|
|
1092
|
+
* For graphs and clusters, only "t" and "b" are allowed, corresponding to placement at the top and bottom, respectively.
|
|
1093
|
+
* By default, root graph labels go on the bottom and cluster labels go on the top.
|
|
1094
|
+
* Note that a subgraph inherits attributes from its parent.
|
|
1095
|
+
* Thus, if the root graph sets {@link labelloc} to "b", the subgraph inherits this value.
|
|
1096
|
+
*
|
|
1097
|
+
* For nodes, this attribute is used only when the height of the node is larger than the height of its label.
|
|
1098
|
+
* If labelloc is set to "t", "c", or "b", the label is aligned with the top, centered, or aligned with the bottom of the node, respectively.
|
|
1099
|
+
* In the default case, the label is vertically centered.
|
|
1100
|
+
*
|
|
1101
|
+
* @see {@link https://graphviz.org/docs/attrs/labelloc/ Node, Edge and Graph Attributes#labelloc}
|
|
1102
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1103
|
+
* @graphvizDefault
|
|
1104
|
+
* "t"(clusters)
|
|
1105
|
+
* "b"(root graphs)
|
|
1106
|
+
* "c"(nodes)
|
|
1107
|
+
* @graphvizUsedBy NGC
|
|
1108
|
+
* @category Attribute
|
|
1109
|
+
*/
|
|
1110
|
+
labelloc: 'labelloc';
|
|
1111
|
+
/**
|
|
1112
|
+
* If the edge has a {@link URL} or {@link labelURL} attribute, this attribute determines which window of the browser is used for the URL attached to the label.
|
|
1113
|
+
* Setting it to "_graphviz" will open a new window if it doesn't already exist, or reuse it if it does.
|
|
1114
|
+
* If undefined, the value of the {@link target} is used.
|
|
1115
|
+
*
|
|
1116
|
+
* @see {@link https://graphviz.org/docs/attrs/labeltarget/ Node, Edge and Graph Attributes#labeltarget}
|
|
1117
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
1118
|
+
* @graphvizDefault <none>
|
|
1119
|
+
* @graphvizNotes svg, map only
|
|
1120
|
+
* @graphvizUsedBy E
|
|
1121
|
+
* @category Attribute
|
|
1122
|
+
*/
|
|
1123
|
+
labeltarget: 'labeltarget';
|
|
1124
|
+
/**
|
|
1125
|
+
* Tooltip annotation attached to label of an edge.
|
|
1126
|
+
* This is used only if the edge has a {@link URL} or {@link labelURL} attribute.
|
|
1127
|
+
*
|
|
1128
|
+
* @see {@link https://graphviz.org/docs/attrs/labeltooltip/ Node, Edge and Graph Attributes#labeltooltip}
|
|
1129
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
1130
|
+
* @graphvizDefault ""
|
|
1131
|
+
* @graphvizNotes svg, cmap only
|
|
1132
|
+
* @graphvizUsedBy E
|
|
1133
|
+
* @category Attribute
|
|
1134
|
+
*/
|
|
1135
|
+
labeltooltip: 'labeltooltip';
|
|
1136
|
+
/**
|
|
1137
|
+
* If true, the graph is rendered in landscape mode.
|
|
1138
|
+
* Synonymous with {@link rotate rotate=90} or {@link orientation orientation=landscape}.
|
|
1139
|
+
*
|
|
1140
|
+
* @see {@link https://graphviz.org/docs/attrs/landscape/ Node, Edge and Graph Attributes#landscape}
|
|
1141
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1142
|
+
* @graphvizDefault FALSE
|
|
1143
|
+
* @graphvizUsedBy G
|
|
1144
|
+
* @category Attribute
|
|
1145
|
+
*/
|
|
1146
|
+
landscape: 'landscape';
|
|
1147
|
+
/**
|
|
1148
|
+
* Specifies layers in which the node, edge or cluster is present.
|
|
1149
|
+
*
|
|
1150
|
+
* @see {@link https://graphviz.org/docs/attrs/layer/ Node, Edge and Graph Attributes#layer}
|
|
1151
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:layerRange layerRange}
|
|
1152
|
+
* @graphvizDefault ""
|
|
1153
|
+
* @graphvizUsedBy ENC
|
|
1154
|
+
* @category Attribute
|
|
1155
|
+
*/
|
|
1156
|
+
layer: 'layer';
|
|
1157
|
+
/**
|
|
1158
|
+
* Specifies the separator characters used to split an attribute of type {@link layerRange} into a list of ranges.
|
|
1159
|
+
*
|
|
1160
|
+
* @see {@link https://graphviz.org/docs/attrs/layerlistsep/ Node, Edge and Graph Attributes#layerlistsep}
|
|
1161
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1162
|
+
* @graphvizDefault ""
|
|
1163
|
+
* @graphvizUsedBy G
|
|
1164
|
+
* @category Attribute
|
|
1165
|
+
*/
|
|
1166
|
+
layerlistsep: 'layerlistsep';
|
|
1167
|
+
/**
|
|
1168
|
+
* Specifies a linearly ordered list of layer names attached to the graph The graph is then output in separate layers.
|
|
1169
|
+
* Only those components belonging to the current output layer appear.
|
|
1170
|
+
* For more information, see the page {@link https://graphviz.org/faq/#FaqOverlays How to use drawing layers (overlays)}.
|
|
1171
|
+
*
|
|
1172
|
+
* @see {@link https://graphviz.org/docs/attrs/layers/ Node, Edge and Graph Attributes#layers}
|
|
1173
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:layerList layerList}
|
|
1174
|
+
* @graphvizDefault ""
|
|
1175
|
+
* @graphvizUsedBy G
|
|
1176
|
+
* @category Attribute
|
|
1177
|
+
*/
|
|
1178
|
+
layers: 'layers';
|
|
1179
|
+
/**
|
|
1180
|
+
* Selects a list of layers to be emitted.
|
|
1181
|
+
*
|
|
1182
|
+
* @see {@link https://graphviz.org/docs/attrs/layerselect/ Node, Edge and Graph Attributes#layerselect}
|
|
1183
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:layerRange layerRange}
|
|
1184
|
+
* @graphvizDefault ""
|
|
1185
|
+
* @graphvizUsedBy G
|
|
1186
|
+
* @category Attribute
|
|
1187
|
+
*/
|
|
1188
|
+
layerselect: 'layerselect';
|
|
1189
|
+
/**
|
|
1190
|
+
* Specifies the separator characters used to split the {@link layers} attribute into a list of layer names.
|
|
1191
|
+
*
|
|
1192
|
+
* @see {@link https://graphviz.org/docs/attrs/layersep/ Node, Edge and Graph Attributes#layersep}
|
|
1193
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1194
|
+
* @graphvizDefault " :\t"
|
|
1195
|
+
* @graphvizUsedBy G
|
|
1196
|
+
* @category Attribute
|
|
1197
|
+
*/
|
|
1198
|
+
layersep: 'layersep';
|
|
1199
|
+
/**
|
|
1200
|
+
* Specifies the name of the layout algorithm to use, such as "dot" or "neato".
|
|
1201
|
+
* Normally, graphs should be kept independent of a type of layout.
|
|
1202
|
+
* In some cases, however, it can be convenient to embed the type of layout desired within the graph.
|
|
1203
|
+
* For example, a graph containing position information from a layout might want to record what the associated layout algorithm was.
|
|
1204
|
+
*
|
|
1205
|
+
* @see {@link https://graphviz.org/docs/attrs/layout/ Node, Edge and Graph Attributes#layout}
|
|
1206
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1207
|
+
* @graphvizDefault ""
|
|
1208
|
+
* @graphvizUsedBy G
|
|
1209
|
+
* @category Attribute
|
|
1210
|
+
*/
|
|
1211
|
+
layout: 'layout';
|
|
1212
|
+
/**
|
|
1213
|
+
* Preferred edge length, in inches.
|
|
1214
|
+
*
|
|
1215
|
+
* @see {@link https://graphviz.org/docs/attrs/len/ Node, Edge and Graph Attributes#len}
|
|
1216
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1217
|
+
* @graphvizDefault
|
|
1218
|
+
* 1.0(neato)
|
|
1219
|
+
* 0.3(fdp)
|
|
1220
|
+
* @graphvizNotes fdp, neato only
|
|
1221
|
+
* @graphvizUsedBy E
|
|
1222
|
+
* @category Attribute
|
|
1223
|
+
*/
|
|
1224
|
+
len: 'len';
|
|
1225
|
+
/**
|
|
1226
|
+
* Number of levels allowed in the multilevel scheme.
|
|
1227
|
+
*
|
|
1228
|
+
* @see {@link https://graphviz.org/docs/attrs/levels/ Node, Edge and Graph Attributes#levels}
|
|
1229
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
1230
|
+
* @graphvizDefault MAXINT
|
|
1231
|
+
* @graphvizMinimum 0
|
|
1232
|
+
* @graphvizNotes sfdp only
|
|
1233
|
+
* @graphvizUsedBy G
|
|
1234
|
+
* @category Attribute
|
|
1235
|
+
*/
|
|
1236
|
+
levels: 'levels';
|
|
1237
|
+
/**
|
|
1238
|
+
* Specifies strictness of level constraints in neato when {@link mode}="ipsep" or "hier".
|
|
1239
|
+
* Larger positive values mean stricter constraints, which demand more separation between levels.
|
|
1240
|
+
* On the other hand, negative values will relax the constraints by allowing some overlap between the levels.
|
|
1241
|
+
*
|
|
1242
|
+
* @see {@link https://graphviz.org/docs/attrs/levelsgap/ Node, Edge and Graph Attributes#levelsgap}
|
|
1243
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1244
|
+
* @graphvizDefault 0
|
|
1245
|
+
* @graphvizNotes neato only
|
|
1246
|
+
* @graphvizUsedBy G
|
|
1247
|
+
* @category Attribute
|
|
1248
|
+
*/
|
|
1249
|
+
levelsgap: 'levelsgap';
|
|
1250
|
+
/**
|
|
1251
|
+
* Logical head of an edge.
|
|
1252
|
+
* When {@link compound} is true, if **lhead** is defined and is the name of a cluster containing the real head,
|
|
1253
|
+
* the edge is clipped to the boundary of the cluster.
|
|
1254
|
+
* See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
1255
|
+
*
|
|
1256
|
+
* @see {@link https://graphviz.org/docs/attrs/lhead/ Node, Edge and Graph Attributes#lhead}
|
|
1257
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1258
|
+
* @graphvizDefault ""
|
|
1259
|
+
* @graphvizNotes dot only
|
|
1260
|
+
* @graphvizUsedBy E
|
|
1261
|
+
* @category Attribute
|
|
1262
|
+
*/
|
|
1263
|
+
lhead: 'lhead';
|
|
1264
|
+
/**
|
|
1265
|
+
* Height of graph or cluster label, in inches.
|
|
1266
|
+
*
|
|
1267
|
+
* @see {@link https://graphviz.org/docs/attrs/lheight/ Node, Edge and Graph Attributes#lheight}
|
|
1268
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1269
|
+
* @graphvizNotes write only
|
|
1270
|
+
* @graphvizUsedBy GC
|
|
1271
|
+
* @category Attribute
|
|
1272
|
+
*/
|
|
1273
|
+
lheight: 'lheight';
|
|
1274
|
+
/**
|
|
1275
|
+
* Label position, {@link https://graphviz.org/doc/info/attrs.html in points}.
|
|
1276
|
+
* The position indicates the center of the label.
|
|
1277
|
+
*
|
|
1278
|
+
* @see {@link https://graphviz.org/docs/attrs/lp/ Node, Edge and Graph Attributes#lp}
|
|
1279
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/point/ point}
|
|
1280
|
+
* @graphvizNotes write only
|
|
1281
|
+
* @graphvizUsedBy EGC
|
|
1282
|
+
* @category Attribute
|
|
1283
|
+
*/
|
|
1284
|
+
lp: 'lp';
|
|
1285
|
+
/**
|
|
1286
|
+
* Logical tail of an edge.
|
|
1287
|
+
* When {@link compound} is true, if **ltail** is defined and is the name of a cluster containing the real tail, the edge is clipped to the boundary of the cluster.
|
|
1288
|
+
* See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
1289
|
+
*
|
|
1290
|
+
* @see {@link https://graphviz.org/docs/attrs/ltail/ Node, Edge and Graph Attributes#ltail}
|
|
1291
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1292
|
+
* @graphvizDefault ""
|
|
1293
|
+
* @graphvizNotes dot only
|
|
1294
|
+
* @graphvizUsedBy E
|
|
1295
|
+
* @category Attribute
|
|
1296
|
+
*/
|
|
1297
|
+
ltail: 'ltail';
|
|
1298
|
+
/**
|
|
1299
|
+
* Width of graph or cluster label, in inches.
|
|
1300
|
+
*
|
|
1301
|
+
* @see {@link https://graphviz.org/docs/attrs/lwidth/ Node, Edge and Graph Attributes#lwidth}
|
|
1302
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1303
|
+
* @graphvizNotes write only
|
|
1304
|
+
* @graphvizUsedBy GC
|
|
1305
|
+
* @category Attribute
|
|
1306
|
+
*/
|
|
1307
|
+
lwidth: 'lwidth';
|
|
1308
|
+
/**
|
|
1309
|
+
* For graphs, this sets x and y margins of canvas, in inches.
|
|
1310
|
+
* If the margin is a single double, both margins are set equal to the given value.
|
|
1311
|
+
*
|
|
1312
|
+
* Note that the margin is not part of the drawing but just empty space left around the drawing.
|
|
1313
|
+
* It basically corresponds to a translation of drawing, as would be necessary to center a drawing on a page.
|
|
1314
|
+
* Nothing is actually drawn in the margin.
|
|
1315
|
+
* To actually extend the background of a drawing, see the {@link pad} attribute.
|
|
1316
|
+
*
|
|
1317
|
+
* For clusters, this specifies the space between the nodes in the cluster and the cluster bounding box.
|
|
1318
|
+
* By default, this is 8 points.
|
|
1319
|
+
*
|
|
1320
|
+
* For nodes, this attribute specifies space left around the node's label.
|
|
1321
|
+
* By default, the value is 0.11,0.055.
|
|
1322
|
+
*
|
|
1323
|
+
* @see {@link https://graphviz.org/docs/attrs/margin/ Node, Edge and Graph Attributes#margin}
|
|
1324
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point}
|
|
1325
|
+
* @graphvizDefault <device-dependent>
|
|
1326
|
+
* @graphvizUsedBy NCG
|
|
1327
|
+
* @category Attribute
|
|
1328
|
+
*/
|
|
1329
|
+
margin: 'margin';
|
|
1330
|
+
/**
|
|
1331
|
+
* Sets the number of iterations used.
|
|
1332
|
+
*
|
|
1333
|
+
* @see {@link https://graphviz.org/docs/attrs/maxiter/ Node, Edge and Graph Attributes#maxiter}
|
|
1334
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
1335
|
+
* @graphvizDefault
|
|
1336
|
+
* 100 * # nodes(mode == KK)
|
|
1337
|
+
* 200(mode == major)
|
|
1338
|
+
* 600(fdp)
|
|
1339
|
+
* @graphvizNotes fdp, neato only
|
|
1340
|
+
* @graphvizUsedBy G
|
|
1341
|
+
* @category Attribute
|
|
1342
|
+
*/
|
|
1343
|
+
maxiter: 'maxiter';
|
|
1344
|
+
/**
|
|
1345
|
+
* Multiplicative scale factor used to alter the MinQuit (default = 8) and MaxIter (default = 24) parameters used during crossing minimization.
|
|
1346
|
+
* These correspond to the number of tries without improvement before quitting and the maximum number of iterations in each pass.
|
|
1347
|
+
*
|
|
1348
|
+
* @see {@link https://graphviz.org/docs/attrs/mclimit/ Node, Edge and Graph Attributes#mclimit}
|
|
1349
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1350
|
+
* @graphvizDefault 1
|
|
1351
|
+
* @graphvizNotes dot only
|
|
1352
|
+
* @graphvizUsedBy G
|
|
1353
|
+
* @category Attribute
|
|
1354
|
+
*/
|
|
1355
|
+
mclimit: 'mclimit';
|
|
1356
|
+
/**
|
|
1357
|
+
* Specifies the minimum separation between all nodes.
|
|
1358
|
+
*
|
|
1359
|
+
* @see {@link https://graphviz.org/docs/attrs/mindist/ Node, Edge and Graph Attributes#mindist}
|
|
1360
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1361
|
+
* @graphvizDefault 1
|
|
1362
|
+
* @graphvizMinimum 0
|
|
1363
|
+
* @graphvizNotes circo only
|
|
1364
|
+
* @graphvizUsedBy G
|
|
1365
|
+
* @category Attribute
|
|
1366
|
+
*/
|
|
1367
|
+
mindist: 'mindist';
|
|
1368
|
+
/**
|
|
1369
|
+
* Minimum edge length (rank difference between head and tail).
|
|
1370
|
+
*
|
|
1371
|
+
* @see {@link https://graphviz.org/docs/attrs/minlen/ Node, Edge and Graph Attributes#minlen}
|
|
1372
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
1373
|
+
* @graphvizDefault 1
|
|
1374
|
+
* @graphvizMinimum 0
|
|
1375
|
+
* @graphvizNotes dot only
|
|
1376
|
+
* @graphvizUsedBy E
|
|
1377
|
+
* @category Attribute
|
|
1378
|
+
*/
|
|
1379
|
+
minlen: 'minlen';
|
|
1380
|
+
/**
|
|
1381
|
+
* Technique for optimizing the layout.
|
|
1382
|
+
* For neato, if **mode** is "major", neato uses stress majorization.
|
|
1383
|
+
* If **mode** is "KK", neato uses a version of the gradient descent method.
|
|
1384
|
+
* The only advantage to the latter technique is that it is sometimes appreciably faster for small (number of nodes < 100) graphs.
|
|
1385
|
+
* A significant disadvantage is that it may cycle.
|
|
1386
|
+
*
|
|
1387
|
+
* There are two experimental modes in neato, "hier", which adds a top-down directionality similar to the layout used in dot, and "ipsep",
|
|
1388
|
+
* which allows the graph to specify minimum vertical and horizontal distances between nodes. (See the {@link sep} attribute.)
|
|
1389
|
+
*
|
|
1390
|
+
* For sfdp, the default **mode** is "spring", which corresponds to using a spring-electrical model.
|
|
1391
|
+
* Setting **mode** to "maxent" causes a similar model to be run but one that also takes into account edge lengths specified by the "len" attribute.
|
|
1392
|
+
*
|
|
1393
|
+
* @see {@link https://graphviz.org/docs/attrs/mode/ Node, Edge and Graph Attributes#mode}
|
|
1394
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1395
|
+
* @graphvizDefault major
|
|
1396
|
+
* @graphvizNotes neato only
|
|
1397
|
+
* @graphvizUsedBy G
|
|
1398
|
+
* @category Attribute
|
|
1399
|
+
*/
|
|
1400
|
+
mode: 'mode';
|
|
1401
|
+
/**
|
|
1402
|
+
* This value specifies how the distance matrix is computed for the input graph.
|
|
1403
|
+
* The distance matrix specifies the ideal distance between every pair of nodes.
|
|
1404
|
+
* neato attemps to find a layout which best achieves these distances.
|
|
1405
|
+
* By default, it uses the length of the shortest path, where the length of each edge is given by its {@link len} attribute.
|
|
1406
|
+
* If **model** is "circuit", neato uses the circuit resistance model to compute the distances.
|
|
1407
|
+
* This tends to emphasize clusters.
|
|
1408
|
+
* If **model** is "subset", neato uses the subset model.
|
|
1409
|
+
* This sets the edge length to be the number of nodes that are neighbors of exactly one of the end points, and then calculates the shortest paths.
|
|
1410
|
+
* This helps to separate nodes with high degree.
|
|
1411
|
+
*
|
|
1412
|
+
* For more control of distances, one can use model=mds.
|
|
1413
|
+
* In this case, the {@link len} of an edge is used as the ideal distance between its vertices.
|
|
1414
|
+
* A shortest path calculation is only used for pairs of nodes not connected by an edge.
|
|
1415
|
+
* Thus, by supplying a complete graph, the input can specify all of the relevant distances.
|
|
1416
|
+
*
|
|
1417
|
+
* @see {@link https://graphviz.org/docs/attrs/model/ Node, Edge and Graph Attributes#model}
|
|
1418
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1419
|
+
* @graphvizDefault shortpath
|
|
1420
|
+
* @graphvizNotes neato only
|
|
1421
|
+
* @graphvizUsedBy G
|
|
1422
|
+
* @category Attribute
|
|
1423
|
+
*/
|
|
1424
|
+
model: 'model';
|
|
1425
|
+
/**
|
|
1426
|
+
* If Graphviz is built with MOSEK defined, mode=ipsep and mosek=true, the Mosek software (<www.mosek.com>) is use to solve the ipsep constraints.
|
|
1427
|
+
*
|
|
1428
|
+
* @see {@link https://graphviz.org/docs/attrs/mosek/ Node, Edge and Graph Attributes#mosek}
|
|
1429
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1430
|
+
* @graphvizDefault FALSE
|
|
1431
|
+
* @graphvizNotes neato only
|
|
1432
|
+
* @graphvizUsedBy G
|
|
1433
|
+
* @category Attribute
|
|
1434
|
+
*/
|
|
1435
|
+
mosek: 'mosek';
|
|
1436
|
+
/**
|
|
1437
|
+
* The original ranking algorithm in dot is recursive on clusters.
|
|
1438
|
+
* This can produce fewer ranks and a more compact layout, but sometimes at the cost of a head node being place on a higher rank than the tail node.
|
|
1439
|
+
* It also assumes that a node is not constrained in separate, incompatible subgraphs.
|
|
1440
|
+
* For example, a node cannot be in a cluster and also be constrained by rank=same with a node not in the cluster.
|
|
1441
|
+
*
|
|
1442
|
+
* If newrank=true, the ranking algorithm does a single global ranking, ignoring clusters.
|
|
1443
|
+
* This allows nodes to be subject to multiple constraints.
|
|
1444
|
+
* Rank constraints will usually take precedence over edge constraints.
|
|
1445
|
+
*
|
|
1446
|
+
* @see {@link https://graphviz.org/docs/attrs/newrank/ Node, Edge and Graph Attributes#newrank}
|
|
1447
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1448
|
+
* @graphvizDefault FALSE
|
|
1449
|
+
* @graphvizNotes dot only
|
|
1450
|
+
* @graphvizUsedBy G
|
|
1451
|
+
* @category Attribute
|
|
1452
|
+
*/
|
|
1453
|
+
newrank: 'newrank';
|
|
1454
|
+
/**
|
|
1455
|
+
* In dot, this specifies the minimum space between two adjacent nodes in the same rank, in inches.
|
|
1456
|
+
*
|
|
1457
|
+
* For other layouts, this affects the spacing between loops on a single node, or multiedges between a pair of nodes.
|
|
1458
|
+
*
|
|
1459
|
+
* @see {@link https://graphviz.org/docs/attrs/nodesep/ Node, Edge and Graph Attributes#nodesep}
|
|
1460
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1461
|
+
* @graphvizDefault 0.25
|
|
1462
|
+
* @graphvizMinimum 0.02
|
|
1463
|
+
* @graphvizUsedBy G
|
|
1464
|
+
* @category Attribute
|
|
1465
|
+
*/
|
|
1466
|
+
nodesep: 'nodesep';
|
|
1467
|
+
/**
|
|
1468
|
+
* By default, the justification of multi-line labels is done within the largest context that makes sense.
|
|
1469
|
+
* Thus, in the label of a polygonal node, a left-justified line will align with the left side of the node (shifted by the prescribed {@link margin}).
|
|
1470
|
+
* In record nodes, left-justified line will line up with the left side of the enclosing column of fields.
|
|
1471
|
+
* If **nojustify** is "true", multi-line labels will be justified in the context of itself.
|
|
1472
|
+
* For example, if the attribute is set, the first label line is long, and the second is shorter and left-justified, the second will align with the left-most character in the first line, regardless of how large the node might be.
|
|
1473
|
+
*
|
|
1474
|
+
* @see {@link https://graphviz.org/docs/attrs/nojustify/ Node, Edge and Graph Attributes#nojustify}
|
|
1475
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1476
|
+
* @graphvizDefault FALSE
|
|
1477
|
+
* @graphvizUsedBy GCNE
|
|
1478
|
+
* @category Attribute
|
|
1479
|
+
*/
|
|
1480
|
+
nojustify: 'nojustify';
|
|
1481
|
+
/**
|
|
1482
|
+
* If set, normalize coordinates of final layout so that the first point is at the origin, and then rotate the layout so that the angle of the first edge is specified by the value of normalize in degrees.
|
|
1483
|
+
* If normalize is not a number, it is evaluated as a bool, with true corresponding to 0 degrees.
|
|
1484
|
+
* **NOTE**: Since the attribute is evaluated first as a number, 0 and 1 cannot be used for false and true.
|
|
1485
|
+
*
|
|
1486
|
+
* @see {@link https://graphviz.org/docs/attrs/normalize/ Node, Edge and Graph Attributes#normalize}
|
|
1487
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1488
|
+
* @graphvizDefault FALSE
|
|
1489
|
+
* @graphvizNotes not dot
|
|
1490
|
+
* @graphvizUsedBy G
|
|
1491
|
+
* @category Attribute
|
|
1492
|
+
*/
|
|
1493
|
+
normalize: 'normalize';
|
|
1494
|
+
/**
|
|
1495
|
+
* By default, the final layout is translated so that the lower-left corner of the bounding box is at the origin.
|
|
1496
|
+
* This can be annoying if some nodes are pinned or if the user runs `neato -n`.
|
|
1497
|
+
* To avoid this translation, set notranslate to true.
|
|
1498
|
+
*
|
|
1499
|
+
* @see {@link https://graphviz.org/docs/attrs/notranslate/ Node, Edge and Graph Attributes#notranslate}
|
|
1500
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1501
|
+
* @graphvizDefault FALSE
|
|
1502
|
+
* @graphvizNotes neato only
|
|
1503
|
+
* @graphvizUsedBy G
|
|
1504
|
+
* @category Attribute
|
|
1505
|
+
*/
|
|
1506
|
+
notranslate: 'notranslate';
|
|
1507
|
+
/**
|
|
1508
|
+
* Used to set number of iterations in network simplex applications.
|
|
1509
|
+
* **nslimit** is used in computing node x coordinates, **nslimit1** for ranking nodes.
|
|
1510
|
+
* If defined, # iterations = **nslimit(1)** * # nodes; otherwise, # iterations = MAXINT.
|
|
1511
|
+
*
|
|
1512
|
+
* @see {@link https://graphviz.org/docs/attrs/nslimit/ Node, Edge and Graph Attributes#nslimit}
|
|
1513
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1514
|
+
* @graphvizNotes dot only
|
|
1515
|
+
* @graphvizUsedBy G
|
|
1516
|
+
* @category Attribute
|
|
1517
|
+
*/
|
|
1518
|
+
nslimit: 'nslimit';
|
|
1519
|
+
/**
|
|
1520
|
+
* Used to set number of iterations in network simplex applications.
|
|
1521
|
+
* **nslimit** is used in computing node x coordinates, **nslimit1** for ranking nodes.
|
|
1522
|
+
* If defined, # iterations = **nslimit(1)** * # nodes; otherwise, # iterations = MAXINT.
|
|
1523
|
+
*
|
|
1524
|
+
* @see {@link https://graphviz.org/docs/attrs/nslimit1/ Node, Edge and Graph Attributes#nslimit1}
|
|
1525
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1526
|
+
* @graphvizNotes dot only
|
|
1527
|
+
* @graphvizUsedBy G
|
|
1528
|
+
* @category Attribute
|
|
1529
|
+
*/
|
|
1530
|
+
nslimit1: 'nslimit1';
|
|
1531
|
+
/**
|
|
1532
|
+
* Angle, in degrees, used to rotate polygon node shapes. For any number of polygon sides, 0 degrees rotation results in a flat base.
|
|
1533
|
+
*
|
|
1534
|
+
* @see {@link https://graphviz.org/docs/attrs/ordering/ Node, Edge and Graph Attributes#ordering}
|
|
1535
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1536
|
+
* @graphvizDefault ""
|
|
1537
|
+
* @graphvizNotes dot only
|
|
1538
|
+
* @graphvizUsedBy GN
|
|
1539
|
+
* @category Attribute
|
|
1540
|
+
*/
|
|
1541
|
+
ordering: 'ordering';
|
|
1542
|
+
/**
|
|
1543
|
+
* If "[lL]*", set graph orientation to landscape Used only if {@link rotate} is not defined.
|
|
1544
|
+
*
|
|
1545
|
+
* @see {@link https://graphviz.org/docs/attrs/orientation/ Node, Edge and Graph Attributes#orientation}
|
|
1546
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
1547
|
+
* @graphvizDefault ""
|
|
1548
|
+
* @graphvizUsedBy G
|
|
1549
|
+
* @category Attribute
|
|
1550
|
+
*/
|
|
1551
|
+
orientation: 'orientation';
|
|
1552
|
+
/**
|
|
1553
|
+
* Specify order in which nodes and edges are drawn.
|
|
1554
|
+
*
|
|
1555
|
+
* @see {@link https://graphviz.org/docs/attrs/outputorder/ Node, Edge and Graph Attributes#outputorder}
|
|
1556
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:outputMode outputMode}
|
|
1557
|
+
* @graphvizDefault breadthfirst
|
|
1558
|
+
* @graphvizUsedBy G
|
|
1559
|
+
* @category Attribute
|
|
1560
|
+
*/
|
|
1561
|
+
outputorder: 'outputorder';
|
|
1562
|
+
/**
|
|
1563
|
+
* Determines if and how node overlaps should be removed.
|
|
1564
|
+
* Nodes are first enlarged using the {@link sep} attribute.
|
|
1565
|
+
* If "true" , overlaps are retained.
|
|
1566
|
+
* If the value is "scale", overlaps are removed by uniformly scaling in x and y.
|
|
1567
|
+
* If the value converts to "false", and it is available, Prism, a proximity graph-based algorithm, is used to remove node overlaps.
|
|
1568
|
+
* This can also be invoked explicitly with "overlap=prism".
|
|
1569
|
+
* This technique starts with a small scaling up, controlled by the {@link overlap_scaling} attribute, which can remove a significant portion of the overlap.
|
|
1570
|
+
* The prism option also accepts an optional non-negative integer suffix.
|
|
1571
|
+
* This can be used to control the number of attempts made at overlap removal.
|
|
1572
|
+
* By default, overlap="prism" is equivalent to overlap="prism1000".
|
|
1573
|
+
* Setting overlap="prism0" causes only the scaling phase to be run.
|
|
1574
|
+
*
|
|
1575
|
+
* If Prism is not available, or the version of Graphviz is earlier than 2.28, "overlap=false" uses a Voronoi-based technique.
|
|
1576
|
+
* This can always be invoked explicitly with "overlap=voronoi".
|
|
1577
|
+
*
|
|
1578
|
+
* If the value is "scalexy", x and y are separately scaled to remove overlaps.
|
|
1579
|
+
*
|
|
1580
|
+
* If the value is "compress", the layout will be scaled down as much as possible without introducing any overlaps, obviously assuming there are none to begin with.
|
|
1581
|
+
*
|
|
1582
|
+
* **N.B.**The remaining allowed values of overlap correspond to algorithms which, at present, can produce bad aspect ratios.
|
|
1583
|
+
* In addition, we deprecate the use of the "ortho*" and "portho*".
|
|
1584
|
+
*
|
|
1585
|
+
* If the value is "vpsc", overlap removal is done as a quadratic optimization to minimize node displacement while removing node overlaps.
|
|
1586
|
+
*
|
|
1587
|
+
* If the value is "orthoxy" or "orthoyx", overlaps are moved by optimizing two constraint problems, one for the x axis and one for the y.
|
|
1588
|
+
* The suffix indicates which axis is processed first. If the value is "ortho", the technique is similar to "orthoxy" except a heuristic is used to reduce the bias between the two passes.
|
|
1589
|
+
* If the value is "ortho_yx", the technique is the same as "ortho", except the roles of x and y are reversed.
|
|
1590
|
+
* The values "portho", "porthoxy", "porthoxy", and "portho_yx" are similar to the previous four, except only pseudo-orthogonal ordering is enforced.
|
|
1591
|
+
*
|
|
1592
|
+
* If the layout is done by neato with {@link mode}="ipsep", then one can use overlap=ipsep.
|
|
1593
|
+
* In this case, the overlap removal constraints are incorporated into the layout algorithm itself.
|
|
1594
|
+
* N.B. At present, this only supports one level of clustering.
|
|
1595
|
+
*
|
|
1596
|
+
* Except for fdp and sfdp, the layouts assume overlap="true" as the default.
|
|
1597
|
+
* Fdp first uses a number of passes using a built-in, force-directed technique to try to remove overlaps.
|
|
1598
|
+
* Thus, fdp accepts **overlap** with an integer prefix followed by a colon, specifying the number of tries.
|
|
1599
|
+
* If there is no prefix, no initial tries will be performed.
|
|
1600
|
+
* If there is nothing following a colon, none of the above methods will be attempted.
|
|
1601
|
+
* By default, fdp uses overlap="9:prism".
|
|
1602
|
+
* Note that overlap="true", overlap="0:true" and overlap="0:" all turn off all overlap removal.
|
|
1603
|
+
*
|
|
1604
|
+
* By default, sfdp uses `overlap="prism0"`.
|
|
1605
|
+
*
|
|
1606
|
+
* Except for the Voronoi and prism methods, all of these transforms preserve the orthogonal ordering of the original layout.
|
|
1607
|
+
* That is, if the x coordinates of two nodes are originally the same, they will remain the same, and if the x coordinate of one node is originally less than the x coordinate of another, this relation will still hold in the transformed layout.
|
|
1608
|
+
* The similar properties hold for the y coordinates.
|
|
1609
|
+
* This is not quite true for the "porth*" cases.
|
|
1610
|
+
* For these, orthogonal ordering is only preserved among nodes related by an edge.
|
|
1611
|
+
*
|
|
1612
|
+
* @see {@link https://graphviz.org/docs/attrs/overlap/ Node, Edge and Graph Attributes#overlap}
|
|
1613
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}/{@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1614
|
+
* @graphvizDefault TRUE
|
|
1615
|
+
* @graphvizNotes not dot
|
|
1616
|
+
* @graphvizUsedBy G
|
|
1617
|
+
* @category Attribute
|
|
1618
|
+
*/
|
|
1619
|
+
overlap: 'overlap';
|
|
1620
|
+
/**
|
|
1621
|
+
* When overlap=prism, the layout is scaled by this factor, thereby removing a fair amount of node overlap,
|
|
1622
|
+
* and making node overlap removal faster and better able to retain the graph's shape.
|
|
1623
|
+
*
|
|
1624
|
+
* If overlap_scaling is negative, the layout is scaled by -1*overlap_scaling times the average label size.
|
|
1625
|
+
* If overlap_scaling is positive, the layout is scaled by overlap_scaling.
|
|
1626
|
+
* If overlap_scaling is zero, no scaling is done.
|
|
1627
|
+
*
|
|
1628
|
+
* @see {@link https://graphviz.org/docs/attrs/overlap_scaling/ Node, Edge and Graph Attributes#overlap_scaling}
|
|
1629
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1630
|
+
* @graphvizDefault -4
|
|
1631
|
+
* @graphvizMinimum -1.00E+10
|
|
1632
|
+
* @graphvizNotes prism only
|
|
1633
|
+
* @graphvizUsedBy G
|
|
1634
|
+
* @category Attribute
|
|
1635
|
+
*/
|
|
1636
|
+
overlap_scaling: 'overlap_scaling';
|
|
1637
|
+
/**
|
|
1638
|
+
* If true, the overlap removal algorithm will perform a compression pass to reduce the size of the layout.
|
|
1639
|
+
*
|
|
1640
|
+
* @see {@link https://graphviz.org/docs/attrs/overlap_shrink/ Node, Edge and Graph Attributes#overlap_shrink}
|
|
1641
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1642
|
+
* @graphvizDefault TRUE
|
|
1643
|
+
* @graphvizNotes prism only
|
|
1644
|
+
* @graphvizUsedBy G
|
|
1645
|
+
* @category Attribute
|
|
1646
|
+
*/
|
|
1647
|
+
overlap_shrink: 'overlap_shrink';
|
|
1648
|
+
/**
|
|
1649
|
+
* This is true if the value of pack is "true" (case-insensitive) or a non-negative integer.
|
|
1650
|
+
* If true, each connected component of the graph is laid out separately, and then the graphs are packed together.
|
|
1651
|
+
* If pack has an integral value, this is used as the size, in {@link points}, of a margin around each part; otherwise, a default margin of 8 is used.
|
|
1652
|
+
* If pack is interpreted as false, the entire graph is laid out together.
|
|
1653
|
+
* The granularity and method of packing is influenced by the {@link packmode} attribute.
|
|
1654
|
+
*
|
|
1655
|
+
* For layouts which always do packing, such a twopi, the **pack** attribute is just used to set the margin.
|
|
1656
|
+
*
|
|
1657
|
+
* @see {@link https://graphviz.org/docs/attrs/pack/ Node, Edge and Graph Attributes#pack}
|
|
1658
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}/int
|
|
1659
|
+
* @graphvizDefault FALSE
|
|
1660
|
+
* @graphvizUsedBy G
|
|
1661
|
+
* @category Attribute
|
|
1662
|
+
*/
|
|
1663
|
+
pack: 'pack';
|
|
1664
|
+
/**
|
|
1665
|
+
* This indicates how connected components should be packed (cf. {@link https://graphviz.org/docs/attrs/packmode/ packMode}).
|
|
1666
|
+
* Note that defining {@link packmode} will automatically turn on packing as though one had set `pack=true`.
|
|
1667
|
+
*
|
|
1668
|
+
* @see {@link https://graphviz.org/docs/attrs/packmode/ Node, Edge and Graph Attributes#packmode}
|
|
1669
|
+
* @graphvizType {@link https://graphviz.org/docs/attrs/packmode/ packMode}
|
|
1670
|
+
* @graphvizDefault node
|
|
1671
|
+
* @graphvizUsedBy G
|
|
1672
|
+
* @category Attribute
|
|
1673
|
+
*/
|
|
1674
|
+
packmode: 'packmode';
|
|
1675
|
+
/**
|
|
1676
|
+
* The pad attribute specifies how much, in inches, to extend the drawing area around the minimal area needed to draw the graph.
|
|
1677
|
+
* If the pad is a single double, both the x and y pad values are set equal to the given value.
|
|
1678
|
+
* This area is part of the drawing and will be filled with the background color, if appropriate.
|
|
1679
|
+
*
|
|
1680
|
+
* Normally, a small pad is used for aesthetic reasons, especially when a background color is used,
|
|
1681
|
+
* to avoid having nodes and edges abutting the boundary of the drawn region.
|
|
1682
|
+
*
|
|
1683
|
+
* @see {@link https://graphviz.org/docs/attrs/pad/ Node, Edge and Graph Attributes#pad}
|
|
1684
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point}
|
|
1685
|
+
* @graphvizDefault 0.0555 (4 points)
|
|
1686
|
+
* @graphvizUsedBy G
|
|
1687
|
+
* @category Attribute
|
|
1688
|
+
*/
|
|
1689
|
+
pad: 'pad';
|
|
1690
|
+
/**
|
|
1691
|
+
* Width and height of output pages, in inches.
|
|
1692
|
+
* If only a single value is given, this is used for both the width and height.
|
|
1693
|
+
*
|
|
1694
|
+
* If this is set and is smaller than the size of the layout,
|
|
1695
|
+
* a rectangular array of pages of the specified page size is overlaid on the layout,
|
|
1696
|
+
* with origins aligned in the lower-left corner, thereby partitioning the layout into pages.
|
|
1697
|
+
* The pages are then produced one at a time, in {@link pagedir} order.
|
|
1698
|
+
*
|
|
1699
|
+
* At present, this only works for PostScript output.
|
|
1700
|
+
* For other types of output, one should use another tool to split the output into multiple output files.
|
|
1701
|
+
* Or use the {@link viewport} to generate multiple files.
|
|
1702
|
+
*
|
|
1703
|
+
* @see {@link https://graphviz.org/docs/attrs/page/ Node, Edge and Graph Attributes#page}
|
|
1704
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point}
|
|
1705
|
+
* @graphvizUsedBy G
|
|
1706
|
+
* @category Attribute
|
|
1707
|
+
*/
|
|
1708
|
+
page: 'page';
|
|
1709
|
+
/**
|
|
1710
|
+
* If the page attribute is set and applicable, this attribute specifies the order in which the pages are emitted. This is limited to one of the 8 row or column major orders.
|
|
1711
|
+
*
|
|
1712
|
+
* @see {@link https://graphviz.org/docs/attrs/pagedir/ Node, Edge and Graph Attributes#pagedir}
|
|
1713
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:pagedir pagedir}
|
|
1714
|
+
* @graphvizDefault BL
|
|
1715
|
+
* @graphvizUsedBy G
|
|
1716
|
+
* @category Attribute
|
|
1717
|
+
*/
|
|
1718
|
+
pagedir: 'pagedir';
|
|
1719
|
+
/**
|
|
1720
|
+
* Color used to draw the bounding box around a cluster.
|
|
1721
|
+
* If **pencolor** is not defined, {@link color} is used.
|
|
1722
|
+
* If this is not defined, {@link bgcolor} is used.
|
|
1723
|
+
* If this is not defined, the default is used.
|
|
1724
|
+
*
|
|
1725
|
+
* Note that a cluster inherits the root graph's attributes if defined.
|
|
1726
|
+
* Thus, if the root graph has defined a **pencolor**, this will override a **color** or **bgcolor** attribute set for the cluster.
|
|
1727
|
+
*
|
|
1728
|
+
* @see {@link https://graphviz.org/docs/attrs/pagedir/ Node, Edge and Graph Attributes#pagedir}
|
|
1729
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/color/ color}
|
|
1730
|
+
* @graphvizDefault black
|
|
1731
|
+
* @graphvizUsedBy C
|
|
1732
|
+
* @category Attribute
|
|
1733
|
+
*/
|
|
1734
|
+
pencolor: 'pencolor';
|
|
1735
|
+
/**
|
|
1736
|
+
* Specifies the width of the pen, in points, used to draw lines and curves, including the boundaries of edges and clusters.
|
|
1737
|
+
* The value is inherited by subclusters.
|
|
1738
|
+
* It has no effect on text.
|
|
1739
|
+
*
|
|
1740
|
+
* Previous to 31 January 2008, the effect of penwidth=W was achieved by including setlinewidth(W) as part of a {@link style} specification.
|
|
1741
|
+
* If both are used, penwidth will be used.
|
|
1742
|
+
*
|
|
1743
|
+
* @see {@link https://graphviz.org/docs/attrs/penwidth/ Node, Edge and Graph Attributes#penwidth}
|
|
1744
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1745
|
+
* @graphvizDefault 1
|
|
1746
|
+
* @graphvizMinimum 0
|
|
1747
|
+
* @graphvizUsedBy CNE
|
|
1748
|
+
* @category Attribute
|
|
1749
|
+
*/
|
|
1750
|
+
penwidth: 'penwidth';
|
|
1751
|
+
/**
|
|
1752
|
+
* Set number of peripheries used in polygonal shapes and cluster boundaries.
|
|
1753
|
+
* Note that {@link https://graphviz.org/doc/info/shapes.html#epsf user-defined shapes} are treated as a form of box shape, so the default peripheries value is 1 and the user-defined shape will be drawn in a bounding rectangle.
|
|
1754
|
+
* Setting peripheries=0 will turn this off.
|
|
1755
|
+
* Also, 1 is the maximum peripheries value for clusters.
|
|
1756
|
+
*
|
|
1757
|
+
* @see {@link https://graphviz.org/docs/attrs/peripheries/ Node, Edge and Graph Attributes#peripheries}
|
|
1758
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
1759
|
+
* @graphvizDefault
|
|
1760
|
+
* shape default(nodes)
|
|
1761
|
+
* 1(clusters)
|
|
1762
|
+
* @graphvizMinimum 0
|
|
1763
|
+
* @graphvizUsedBy NC
|
|
1764
|
+
* @category Attribute
|
|
1765
|
+
*/
|
|
1766
|
+
peripheries: 'peripheries';
|
|
1767
|
+
/**
|
|
1768
|
+
* If true and the node has a pos attribute on input, neato or fdp prevents the node from moving from the input position.
|
|
1769
|
+
* This property can also be specified in the pos attribute itself (cf. the {@link https://graphviz.org/docs/attr-types/point/ point} type).
|
|
1770
|
+
*
|
|
1771
|
+
* Note: Due to an artifact of the implementation, previous to 27 Feb 2014, final coordinates are translated to the origin.
|
|
1772
|
+
* Thus, if you look at the output coordinates given in the (x)dot or plain format, pinned nodes will not have the same output coordinates as were given on input.
|
|
1773
|
+
* If this is important, a simple workaround is to maintain the coordinates of a pinned node.
|
|
1774
|
+
* The vector difference between the old and new coordinates will give the translation, which can then be subtracted from all of the appropriate coordinates.
|
|
1775
|
+
*
|
|
1776
|
+
* After 27 Feb 2014, this translation can be avoided in neato by setting the {@link notranslate} to TRUE.
|
|
1777
|
+
* However, if the graph specifies {@link overlap node overlap removal} or a change in {@link ratio aspect ratio}, node coordinates may still change.
|
|
1778
|
+
*
|
|
1779
|
+
* @see {@link https://graphviz.org/docs/attrs/pin/ Node, Edge and Graph Attributes#pin}
|
|
1780
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1781
|
+
* @graphvizDefault FALSE
|
|
1782
|
+
* @graphvizNotes fdp, neato only
|
|
1783
|
+
* @graphvizUsedBy N
|
|
1784
|
+
* @category Attribute
|
|
1785
|
+
*/
|
|
1786
|
+
pin: 'pin';
|
|
1787
|
+
/**
|
|
1788
|
+
* Position of node, or spline control points.
|
|
1789
|
+
* For nodes, the position indicates the center of the node.
|
|
1790
|
+
* On output, the coordinates are in {@link https://graphviz.org/doc/info/attrs.html points}.
|
|
1791
|
+
*
|
|
1792
|
+
* In neato and fdp, pos can be used to set the initial position of a node.
|
|
1793
|
+
* By default, the coordinates are assumed to be in inches.
|
|
1794
|
+
* However, the {@link https://graphviz.org/_pages/doc/info/command.html#d:s -s} command line flag can be used to specify different units.
|
|
1795
|
+
* As the output coordinates are in points, feeding the output of a graph laid out by a Graphviz program into neato or fdp will almost always require the -s flag.
|
|
1796
|
+
*
|
|
1797
|
+
* When the {@link https://graphviz.org/_pages/doc/info/command.html#d:n -n} command line flag is used with neato,
|
|
1798
|
+
* it is assumed the positions have been set by one of the layout programs, and are therefore in points.
|
|
1799
|
+
* Thus, neato -n can accept input correctly without requiring a -s flag and, in fact, ignores any such flag.
|
|
1800
|
+
*
|
|
1801
|
+
* @see {@link https://graphviz.org/docs/attrs/pos/ Node, Edge and Graph Attributes#pos}
|
|
1802
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/point/ point}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:smoothType splineType}
|
|
1803
|
+
* @graphvizUsedBy EN
|
|
1804
|
+
* @category Attribute
|
|
1805
|
+
*/
|
|
1806
|
+
pos: 'pos';
|
|
1807
|
+
/**
|
|
1808
|
+
* Quadtree scheme to use.
|
|
1809
|
+
*
|
|
1810
|
+
* A TRUE bool value corresponds to "normal"; a FALSE bool value corresponds to "none".
|
|
1811
|
+
* As a slight exception to the normal interpretation of bool, a value of "2" corresponds to "fast".
|
|
1812
|
+
*
|
|
1813
|
+
* @see {@link https://graphviz.org/docs/attrs/quadtree/ Node, Edge and Graph Attributes#quadtree}
|
|
1814
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:quadType quadType}/{@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1815
|
+
* @graphvizDefault normal
|
|
1816
|
+
* @graphvizNotes sfdp only
|
|
1817
|
+
* @graphvizUsedBy G
|
|
1818
|
+
* @category Attribute
|
|
1819
|
+
*/
|
|
1820
|
+
quadtree: 'quadtree';
|
|
1821
|
+
/**
|
|
1822
|
+
* If **quantum** > 0.0, node label dimensions will be rounded to integral multiples of the quantum.
|
|
1823
|
+
*
|
|
1824
|
+
* @see {@link https://graphviz.org/docs/attrs/quantum/ Node, Edge and Graph Attributes#quantum}
|
|
1825
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1826
|
+
* @graphvizDefault 0
|
|
1827
|
+
* @graphvizMinimum 0
|
|
1828
|
+
* @graphvizUsedBy G
|
|
1829
|
+
* @category Attribute
|
|
1830
|
+
*/
|
|
1831
|
+
quantum: 'quantum';
|
|
1832
|
+
/**
|
|
1833
|
+
* Rank constraints on the nodes in a subgraph.
|
|
1834
|
+
* If **rank**="same", all nodes are placed on the same rank.
|
|
1835
|
+
* If **rank**="min", all nodes are placed on the minimum rank.
|
|
1836
|
+
* If **rank**="source", all nodes are placed on the minimum rank, and the only nodes on the minimum rank belong to some subgraph whose rank attribute is "source" or "min".
|
|
1837
|
+
* Analogous criteria hold for rank="max" and rank="sink".
|
|
1838
|
+
* (Note: the minimum rank is topmost or leftmost, and the maximum rank is bottommost or rightmost.)
|
|
1839
|
+
*
|
|
1840
|
+
* @see {@link https://graphviz.org/docs/attrs/rank/ Node, Edge and Graph Attributes#rank}
|
|
1841
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:rankType rankType}
|
|
1842
|
+
* @graphvizNotes dot only
|
|
1843
|
+
* @graphvizUsedBy S
|
|
1844
|
+
* @category Attribute
|
|
1845
|
+
*/
|
|
1846
|
+
rank: 'rank';
|
|
1847
|
+
/**
|
|
1848
|
+
* Sets direction of graph layout.
|
|
1849
|
+
* For example, if **rankdir**="LR", and barring cycles, an edge T -> H; will go from left to right.
|
|
1850
|
+
* By default, graphs are laid out from top to bottom.
|
|
1851
|
+
*
|
|
1852
|
+
* This attribute also has a side-effect in determining how record nodes are interpreted.
|
|
1853
|
+
* See {@link https://graphviz.org/doc/info/shapes.html record shapes}.
|
|
1854
|
+
*
|
|
1855
|
+
* @see {@link https://graphviz.org/docs/attrs/rankdir/ Node, Edge and Graph Attributes#rankdir}
|
|
1856
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:rankdir rankdir}
|
|
1857
|
+
* @graphvizDefault TB
|
|
1858
|
+
* @graphvizNotes dot only
|
|
1859
|
+
* @graphvizUsedBy G
|
|
1860
|
+
* @category Attribute
|
|
1861
|
+
*/
|
|
1862
|
+
rankdir: 'rankdir';
|
|
1863
|
+
/**
|
|
1864
|
+
* In dot, this gives the desired rank separation, in inches.
|
|
1865
|
+
* This is the minimum vertical distance between the bottom of the nodes in one rank and the tops of nodes in the next.
|
|
1866
|
+
* If the value contains "equally", the centers of all ranks are spaced equally apart.
|
|
1867
|
+
* Note that both settings are possible, e.g., ranksep = "1.2 equally".
|
|
1868
|
+
*
|
|
1869
|
+
* In twopi, this attribute specifies the radial separation of concentric circles.
|
|
1870
|
+
* For twopi, ranksep can also be a list of doubles.
|
|
1871
|
+
* The first double specifies the radius of the inner circle; the second double specifies the increase in radius from the first circle to the second; etc.
|
|
1872
|
+
* If there are more circles than numbers, the last number is used as the increment for the remainder.
|
|
1873
|
+
*
|
|
1874
|
+
* @see {@link https://graphviz.org/docs/attrs/ranksep/ Node, Edge and Graph Attributes#ranksep}
|
|
1875
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:doubleList doubleList}
|
|
1876
|
+
* @graphvizDefault
|
|
1877
|
+
* 0.5(dot)
|
|
1878
|
+
* 1.0(twopi)
|
|
1879
|
+
* @graphvizMinimum 0.02
|
|
1880
|
+
* @graphvizNotes twopi, dot only
|
|
1881
|
+
* @graphvizUsedBy G
|
|
1882
|
+
* @category Attribute
|
|
1883
|
+
*/
|
|
1884
|
+
ranksep: 'ranksep';
|
|
1885
|
+
/**
|
|
1886
|
+
* Sets the aspect ratio (drawing height/drawing width) for the drawing.
|
|
1887
|
+
* Note that this is adjusted before the {@link size} attribute constraints are enforced.
|
|
1888
|
+
* In addition, the calculations usually ignore the node sizes, so the final drawing size may only approximate what is desired.
|
|
1889
|
+
*
|
|
1890
|
+
* If **ratio** is numeric, it is taken as the desired aspect ratio.
|
|
1891
|
+
* Then, if the actual aspect ratio is less than the desired ratio, the drawing height is scaled up to achieve the desired ratio;
|
|
1892
|
+
* if the actual ratio is greater than that desired ratio, the drawing width is scaled up.
|
|
1893
|
+
*
|
|
1894
|
+
* If **ratio** = "fill" and the {@link size} attribute is set, node positions are scaled, separately in both x and y, so that the final drawing exactly fills the specified size.
|
|
1895
|
+
* If both {@link size} values exceed the width and height of the drawing, then both coordinate values of each node are scaled up accordingly.
|
|
1896
|
+
* However, if either size dimension is smaller than the corresponding dimension in the drawing, one dimension is scaled up so that the final drawing has the same aspect ratio as specified by {@link size}.
|
|
1897
|
+
* Then, when rendered, the layout will be scaled down uniformly in both dimensions to fit the given {@link size}, which may cause nodes and text to shrink as well.
|
|
1898
|
+
* This may not be what the user wants, but it avoids the hard problem of how to reposition the nodes in an acceptable fashion to reduce the drawing size.
|
|
1899
|
+
*
|
|
1900
|
+
* If **** = "compress" and the {@link size} attribute is set, dot attempts to compress the initial layout to fit in the given size.
|
|
1901
|
+
* This achieves a tighter packing of nodes but reduces the balance and symmetry.
|
|
1902
|
+
* This feature only works in dot.
|
|
1903
|
+
*
|
|
1904
|
+
* If **** = "expand", the {@link size} attribute is set, and both the width and the height of the graph are less than the value in {@link size},
|
|
1905
|
+
* node positions are scaled uniformly until at least one dimension fits {@link size} exactly.
|
|
1906
|
+
* Note that this is distinct from using {@link size} as the desired size, as here the drawing is expanded before edges are generated and all node and text sizes remain unchanged.
|
|
1907
|
+
*
|
|
1908
|
+
* If **** = "auto", the {@link page} attribute is set and the graph cannot be drawn on a single page, then {@link size} is set to an ``ideal'' value.
|
|
1909
|
+
* In particular, the size in a given dimension will be the smallest integral multiple of the page size in that dimension which is at least half the current size.
|
|
1910
|
+
* The two dimensions are then scaled independently to the new size.
|
|
1911
|
+
* This feature only works in dot.
|
|
1912
|
+
*
|
|
1913
|
+
* @see {@link https://graphviz.org/docs/attrs/ratio/ Node, Edge and Graph Attributes#ratio}
|
|
1914
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/string
|
|
1915
|
+
* @graphvizUsedBy G
|
|
1916
|
+
* @category Attribute
|
|
1917
|
+
*/
|
|
1918
|
+
ratio: 'ratio';
|
|
1919
|
+
/**
|
|
1920
|
+
* Rectangles for fields of records,
|
|
1921
|
+
* {@link https://graphviz.org/doc/info/attrs.html in points}.
|
|
1922
|
+
*
|
|
1923
|
+
* @see {@link https://graphviz.org/docs/attrs/rects/ Node, Edge and Graph Attributes#rects}
|
|
1924
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/rect/ rect}
|
|
1925
|
+
* @graphvizNotes write only
|
|
1926
|
+
* @graphvizUsedBy N
|
|
1927
|
+
* @category Attribute
|
|
1928
|
+
*/
|
|
1929
|
+
rects: 'rects';
|
|
1930
|
+
/**
|
|
1931
|
+
* If true, force polygon to be regular, i.e.,
|
|
1932
|
+
* the vertices of the polygon will lie on a circle whose center is the center of the node.
|
|
1933
|
+
*
|
|
1934
|
+
* @see {@link https://graphviz.org/docs/attrs/regular/ Node, Edge and Graph Attributes#regular}
|
|
1935
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1936
|
+
* @graphvizDefault FALSE
|
|
1937
|
+
* @graphvizUsedBy N
|
|
1938
|
+
* @category Attribute
|
|
1939
|
+
*/
|
|
1940
|
+
regular: 'regular';
|
|
1941
|
+
/**
|
|
1942
|
+
* If true and there are multiple clusters, run crossing minimization a second time.
|
|
1943
|
+
*
|
|
1944
|
+
* @see {@link https://graphviz.org/docs/attrs/remincross/ Node, Edge and Graph Attributes#remincross}
|
|
1945
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1946
|
+
* @graphvizDefault TRUE
|
|
1947
|
+
* @graphvizNotes dot only
|
|
1948
|
+
* @graphvizUsedBy G
|
|
1949
|
+
* @category Attribute
|
|
1950
|
+
*/
|
|
1951
|
+
remincross: 'remincross';
|
|
1952
|
+
/**
|
|
1953
|
+
* The power of the repulsive force used in an extended Fruchterman-Reingold force directed model.
|
|
1954
|
+
* Values larger than 1 tend to reduce the warping effect at the expense of less clustering.
|
|
1955
|
+
*
|
|
1956
|
+
* @see {@link https://graphviz.org/docs/attrs/repulsiveforce/ Node, Edge and Graph Attributes#repulsiveforce}
|
|
1957
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1958
|
+
* @graphvizDefault 1
|
|
1959
|
+
* @graphvizMinimum 0
|
|
1960
|
+
* @graphvizNotes sfdp only
|
|
1961
|
+
* @graphvizUsedBy G
|
|
1962
|
+
* @category Attribute
|
|
1963
|
+
*/
|
|
1964
|
+
repulsiveforce: 'repulsiveforce';
|
|
1965
|
+
/**
|
|
1966
|
+
* This is a synonym for the {@link dpi} attribute.
|
|
1967
|
+
*
|
|
1968
|
+
* @see {@link https://graphviz.org/docs/attrs/resolution/ Node, Edge and Graph Attributes#resolution}
|
|
1969
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
1970
|
+
* @graphvizDefault
|
|
1971
|
+
* 96.0
|
|
1972
|
+
* 0.0"
|
|
1973
|
+
* @graphvizNotes svg, bitmap output only
|
|
1974
|
+
* @graphvizUsedBy G
|
|
1975
|
+
* @category Attribute
|
|
1976
|
+
*/
|
|
1977
|
+
resolution: 'resolution';
|
|
1978
|
+
/**
|
|
1979
|
+
* This specifies nodes to be used as the center of the layout and the root of the generated spanning tree.
|
|
1980
|
+
* As a graph attribute, this gives the name of the node.
|
|
1981
|
+
* As a node attribute, it specifies that the node should be used as a central node.
|
|
1982
|
+
* In twopi, this will actually be the central node.
|
|
1983
|
+
* In circo, the block containing the node will be central in the drawing of its connected component.
|
|
1984
|
+
* If not defined, twopi will pick a most central node, and circo will pick a random node.
|
|
1985
|
+
*
|
|
1986
|
+
* If the root attribute is defined as the empty string, twopi will reset it to name of the node picked as the root node.
|
|
1987
|
+
*
|
|
1988
|
+
* For twopi, it is possible to have multiple roots, presumably one for each component.
|
|
1989
|
+
* If more than one node in a component is marked as the root, twopi will pick one.
|
|
1990
|
+
*
|
|
1991
|
+
* @see {@link https://graphviz.org/docs/attrs/root/ Node, Edge and Graph Attributes#root}
|
|
1992
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}/{@link https://graphviz.org/docs/attr-types/bool bool}
|
|
1993
|
+
* @graphvizDefault
|
|
1994
|
+
* <none>(graphs)
|
|
1995
|
+
* false(nodes)
|
|
1996
|
+
* @graphvizMinimum
|
|
1997
|
+
* @graphvizNotes circo, twopi only
|
|
1998
|
+
* @graphvizUsedBy GN
|
|
1999
|
+
* @category Attribute
|
|
2000
|
+
*/
|
|
2001
|
+
root: 'root';
|
|
2002
|
+
/**
|
|
2003
|
+
* If 90, set drawing orientation to landscape.
|
|
2004
|
+
*
|
|
2005
|
+
* @see {@link https://graphviz.org/docs/attrs/rotate/ Node, Edge and Graph Attributes#rotate}
|
|
2006
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
2007
|
+
* @graphvizDefault 0
|
|
2008
|
+
* @graphvizUsedBy G
|
|
2009
|
+
* @category Attribute
|
|
2010
|
+
*/
|
|
2011
|
+
rotate: 'rotate';
|
|
2012
|
+
/**
|
|
2013
|
+
* Causes the final layout to be rotated counter-clockwise by the specified number of degrees.
|
|
2014
|
+
*
|
|
2015
|
+
* @see {@link https://graphviz.org/docs/attrs/rotation/ Node, Edge and Graph Attributes#rotation}
|
|
2016
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
2017
|
+
* @graphvizDefault 0
|
|
2018
|
+
* @graphvizNotes sfdp only
|
|
2019
|
+
* @graphvizUsedBy G
|
|
2020
|
+
* @category Attribute
|
|
2021
|
+
*/
|
|
2022
|
+
rotation: 'rotation';
|
|
2023
|
+
/**
|
|
2024
|
+
* Edges with the same head and the same **samehead** value are aimed at the same point on the head.
|
|
2025
|
+
* This has no effect on loops.
|
|
2026
|
+
* Each node can have at most 5 unique samehead values.
|
|
2027
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
2028
|
+
*
|
|
2029
|
+
* @see {@link https://graphviz.org/docs/attrs/samehead/ Node, Edge and Graph Attributes#samehead}
|
|
2030
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
2031
|
+
* @graphvizDefault ""
|
|
2032
|
+
* @graphvizNotes dot only
|
|
2033
|
+
* @graphvizUsedBy E
|
|
2034
|
+
* @category Attribute
|
|
2035
|
+
*/
|
|
2036
|
+
samehead: 'samehead';
|
|
2037
|
+
/**
|
|
2038
|
+
* Edges with the same tail and the same sametail value are aimed at the same point on the tail.
|
|
2039
|
+
* This has no effect on loops.
|
|
2040
|
+
* Each node can have at most 5 unique sametail values.
|
|
2041
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
2042
|
+
*
|
|
2043
|
+
* @see {@link https://graphviz.org/docs/attrs/sametail/ Node, Edge and Graph Attributes#sametail}
|
|
2044
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
2045
|
+
* @graphvizDefault ""
|
|
2046
|
+
* @graphvizNotes dot only
|
|
2047
|
+
* @graphvizUsedBy E
|
|
2048
|
+
* @category Attribute
|
|
2049
|
+
*/
|
|
2050
|
+
sametail: 'sametail';
|
|
2051
|
+
/**
|
|
2052
|
+
* If the input graph defines the {@link vertices} attribute, and output is dot or xdot, this gives the number of points used for a node whose shape is a circle or ellipse.
|
|
2053
|
+
* It plays the same role in neato, when adjusting the layout to avoid overlapping nodes, and in image maps.
|
|
2054
|
+
*
|
|
2055
|
+
* @see {@link https://graphviz.org/docs/attrs/samplepoints/ Node, Edge and Graph Attributes#samplepoints}
|
|
2056
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
2057
|
+
* @graphvizDefault
|
|
2058
|
+
* 8(output)
|
|
2059
|
+
* 20(overlap and image maps)
|
|
2060
|
+
* @graphvizUsedBy N
|
|
2061
|
+
* @category Attribute
|
|
2062
|
+
*/
|
|
2063
|
+
samplepoints: 'samplepoints';
|
|
2064
|
+
/**
|
|
2065
|
+
* If set, after the initial layout, the layout is scaled by the given factors.
|
|
2066
|
+
* If only a single number is given, this is used for both factors.
|
|
2067
|
+
*
|
|
2068
|
+
* @see {@link https://graphviz.org/docs/attrs/scale/ Node, Edge and Graph Attributes#scale}
|
|
2069
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point}
|
|
2070
|
+
* @graphvizNotes not dot
|
|
2071
|
+
* @graphvizUsedBy G
|
|
2072
|
+
* @category Attribute
|
|
2073
|
+
*/
|
|
2074
|
+
scale: 'scale';
|
|
2075
|
+
/**
|
|
2076
|
+
* During network simplex, maximum number of edges with negative cut values to search when looking for one with minimum cut value.
|
|
2077
|
+
*
|
|
2078
|
+
* @see {@link https://graphviz.org/docs/attrs/searchsize/ Node, Edge and Graph Attributes#searchsize}
|
|
2079
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
2080
|
+
* @graphvizDefault 30
|
|
2081
|
+
* @graphvizNotes dot only
|
|
2082
|
+
* @graphvizUsedBy G
|
|
2083
|
+
* @category Attribute
|
|
2084
|
+
*/
|
|
2085
|
+
searchsize: 'searchsize';
|
|
2086
|
+
/**
|
|
2087
|
+
* Specifies margin to leave around nodes when removing node overlap.
|
|
2088
|
+
* This guarantees a minimal non-zero distance between nodes.
|
|
2089
|
+
*
|
|
2090
|
+
* If the attribute begins with a plus sign '+', an additive margin is specified.
|
|
2091
|
+
* That is, "+w,h" causes the node's bounding box to be increased by w points on the left and right sides, and by h points on the top and bottom.
|
|
2092
|
+
* Without a plus sign, the node is scaled by 1 + w in the x coordinate and 1 + h in the y coordinate.
|
|
2093
|
+
*
|
|
2094
|
+
* If only a single number is given, this is used for both dimensions.
|
|
2095
|
+
*
|
|
2096
|
+
* If unset but {@link esep} is defined, the sep values will be set to the esep values divided by 0.8. If esep is unset, the default value is used.
|
|
2097
|
+
*
|
|
2098
|
+
* @see {@link https://graphviz.org/docs/attrs/sep/ Node, Edge and Graph Attributes#sep}
|
|
2099
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/addDouble/ addDouble}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:addPoint addPoint}
|
|
2100
|
+
* @graphvizDefault 4
|
|
2101
|
+
* @graphvizNotes not dot
|
|
2102
|
+
* @graphvizUsedBy G
|
|
2103
|
+
* @category Attribute
|
|
2104
|
+
*/
|
|
2105
|
+
sep: 'sep';
|
|
2106
|
+
/**
|
|
2107
|
+
* Set the shape of a node.
|
|
2108
|
+
*
|
|
2109
|
+
* @see {@link https://graphviz.org/docs/attrs/shape/ Node, Edge and Graph Attributes#shape}
|
|
2110
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:shape shape}
|
|
2111
|
+
* @graphvizDefault ellipse
|
|
2112
|
+
* @graphvizUsedBy N
|
|
2113
|
+
* @category Attribute
|
|
2114
|
+
*/
|
|
2115
|
+
shape: 'shape';
|
|
2116
|
+
/**
|
|
2117
|
+
* (Deprecated) If defined, shapefile specifies a file containing user-supplied node content.
|
|
2118
|
+
* The {@link shape} of the node is set to box.
|
|
2119
|
+
* The image in the shapefile must be rectangular.
|
|
2120
|
+
* The image formats supported as well as the precise semantics of how the file is used depends on the {@link https://graphviz.org/_pages/doc/info/output.html output format}.
|
|
2121
|
+
* For further details, see {@link https://graphviz.org/docs/outputs/ Image Formats} and {@link https://graphviz.org/faq/#ext_image External PostScript files}.
|
|
2122
|
+
*
|
|
2123
|
+
* @see {@link https://graphviz.org/docs/attrs/shapefile/ Node, Edge and Graph Attributes#shapefile}
|
|
2124
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
2125
|
+
* @graphvizDefault ""
|
|
2126
|
+
* @graphvizUsedBy N
|
|
2127
|
+
* @deprecated
|
|
2128
|
+
* @category Attribute
|
|
2129
|
+
*/
|
|
2130
|
+
shapefile: 'shapefile';
|
|
2131
|
+
/**
|
|
2132
|
+
* Print guide boxes in PostScript at the beginning of routesplines if 1, or at the end if 2. (Debugging)
|
|
2133
|
+
*
|
|
2134
|
+
* @see {@link https://graphviz.org/docs/attrs/showboxes/ Node, Edge and Graph Attributes#showboxes}
|
|
2135
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
2136
|
+
* @graphvizDefault 0
|
|
2137
|
+
* @graphvizMinimum 0
|
|
2138
|
+
* @graphvizNotes dot only
|
|
2139
|
+
* @graphvizUsedBy ENG
|
|
2140
|
+
* @category Attribute
|
|
2141
|
+
*/
|
|
2142
|
+
showboxes: 'showboxes';
|
|
2143
|
+
/**
|
|
2144
|
+
* Number of sides if {@link shape}=polygon.
|
|
2145
|
+
*
|
|
2146
|
+
* @see {@link https://graphviz.org/docs/attrs/sides/ Node, Edge and Graph Attributes#sides}
|
|
2147
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
2148
|
+
* @graphvizDefault 4
|
|
2149
|
+
* @graphvizMinimum 0
|
|
2150
|
+
* @graphvizUsedBy N
|
|
2151
|
+
* @category Attribute
|
|
2152
|
+
*/
|
|
2153
|
+
sides: 'sides';
|
|
2154
|
+
/**
|
|
2155
|
+
* Maximum width and height of drawing, in inches.
|
|
2156
|
+
* If only a single number is given, this is used for both the width and the height.
|
|
2157
|
+
*
|
|
2158
|
+
* If defined and the drawing is larger than the given size, the drawing is uniformly scaled down so that it fits within the given size.
|
|
2159
|
+
*
|
|
2160
|
+
* If size ends in an exclamation point (!), then it is taken to be the desired size. In this case, if both dimensions of the drawing are less than size, the drawing is scaled up uniformly until at least one dimension equals its dimension in size.
|
|
2161
|
+
*
|
|
2162
|
+
* Note that there is some interaction between the **size** and {@link ratio} attributes.
|
|
2163
|
+
*
|
|
2164
|
+
* @see {@link https://graphviz.org/docs/attrs/size/ Node, Edge and Graph Attributes#size}
|
|
2165
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point}
|
|
2166
|
+
* @graphvizUsedBy G
|
|
2167
|
+
* @category Attribute
|
|
2168
|
+
*/
|
|
2169
|
+
size: 'size';
|
|
2170
|
+
/**
|
|
2171
|
+
* Skew factor for {@link shape}=polygon. Positive values skew top of polygon to right; negative to left.
|
|
2172
|
+
*
|
|
2173
|
+
* @see {@link https://graphviz.org/docs/attrs/skew/ Node, Edge and Graph Attributes#skew}
|
|
2174
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
2175
|
+
* @graphvizDefault 0
|
|
2176
|
+
* @graphvizMinimum -100
|
|
2177
|
+
* @graphvizUsedBy N
|
|
2178
|
+
* @category Attribute
|
|
2179
|
+
*/
|
|
2180
|
+
skew: 'skew';
|
|
2181
|
+
/**
|
|
2182
|
+
* Specifies a post-processing step used to smooth out an uneven distribution of nodes.
|
|
2183
|
+
*
|
|
2184
|
+
* @see {@link https://graphviz.org/docs/attrs/smoothing/ Node, Edge and Graph Attributes#smoothing}
|
|
2185
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:smoothType smoothType}
|
|
2186
|
+
* @graphvizDefault "none"
|
|
2187
|
+
* @graphvizNotes sfdp only
|
|
2188
|
+
* @graphvizUsedBy G
|
|
2189
|
+
* @category Attribute
|
|
2190
|
+
*/
|
|
2191
|
+
smoothing: 'smoothing';
|
|
2192
|
+
/**
|
|
2193
|
+
* If {@link packmode} indicates an array packing, this attribute specifies an insertion order among the components,
|
|
2194
|
+
* with smaller values inserted first.
|
|
2195
|
+
*
|
|
2196
|
+
* @see {@link https://graphviz.org/docs/attrs/sortv/ Node, Edge and Graph Attributes#sortv}
|
|
2197
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}
|
|
2198
|
+
* @graphvizDefault 0
|
|
2199
|
+
* @graphvizMinimum 0
|
|
2200
|
+
* @graphvizUsedBy GCN
|
|
2201
|
+
* @category Attribute
|
|
2202
|
+
*/
|
|
2203
|
+
sortv: 'sortv';
|
|
2204
|
+
/**
|
|
2205
|
+
* Controls how, and if, edges are represented.
|
|
2206
|
+
* If true, edges are drawn as splines routed around nodes; if false, edges are drawn as line segments.
|
|
2207
|
+
* If set to none or "", no edges are drawn at all.
|
|
2208
|
+
*
|
|
2209
|
+
* (1 March 2007) The values line and spline can be used as synonyms for false and true, respectively. In addition, the value polyline specifies that edges should be drawn as polylines.
|
|
2210
|
+
*
|
|
2211
|
+
* (28 Sep 2010) The value ortho specifies edges should be routed as polylines of axis-aligned segments. Currently, the routing does not handle ports or, in dot, edge labels.
|
|
2212
|
+
*
|
|
2213
|
+
* (25 Sep 2012) The value curved specifies edges should be drawn as curved arcs.
|
|
2214
|
+
*
|
|
2215
|
+
* | | |
|
|
2216
|
+
* |------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
|
|
2217
|
+
* |  |  |
|
|
2218
|
+
* | `splines=none` | `splines=line` |
|
|
2219
|
+
* | `splines=""` | `splines=false` |
|
|
2220
|
+
* |  |  |
|
|
2221
|
+
* | `splines=polyline` | `splines=curved` |
|
|
2222
|
+
* |  |  |
|
|
2223
|
+
* | `splines=ortho` | `splines=spline` |
|
|
2224
|
+
* | | `splines=true` |
|
|
2225
|
+
*
|
|
2226
|
+
* By default, the attribute is unset. How this is interpreted depends on the layout. For dot,
|
|
2227
|
+
* the default is to draw edges as splines. For all other layouts,
|
|
2228
|
+
* the default is to draw edges as line segments.
|
|
2229
|
+
* Note that for these latter layouts, if splines="true", this requires non-overlapping nodes (cf. {@link overlap}). If fdp is used for layout and splines="compound",
|
|
2230
|
+
* then the edges are drawn to avoid clusters as well as nodes.
|
|
2231
|
+
*
|
|
2232
|
+
* @see {@link https://graphviz.org/docs/attrs/splines/ Node, Edge and Graph Attributes#splines}
|
|
2233
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}/string
|
|
2234
|
+
* @graphvizUsedBy G
|
|
2235
|
+
* @category Attribute
|
|
2236
|
+
*/
|
|
2237
|
+
splines: 'splines';
|
|
2238
|
+
/**
|
|
2239
|
+
* Parameter used to determine the initial layout of nodes.
|
|
2240
|
+
* If unset, the nodes are randomly placed in a unit square with the same seed is always used for the random number generator, so the initial placement is repeatable.
|
|
2241
|
+
*
|
|
2242
|
+
* @see {@link https://graphviz.org/docs/attrs/start/ Node, Edge and Graph Attributes#start}
|
|
2243
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:startType startType}
|
|
2244
|
+
* @graphvizDefault ""
|
|
2245
|
+
* @graphvizNotes fdp, neato only
|
|
2246
|
+
* @graphvizUsedBy G
|
|
2247
|
+
* @category Attribute
|
|
2248
|
+
*/
|
|
2249
|
+
start: 'start';
|
|
2250
|
+
/**
|
|
2251
|
+
* Set style information for components of the graph.
|
|
2252
|
+
* For cluster subgraphs, if style="filled", the cluster box's background is filled.
|
|
2253
|
+
*
|
|
2254
|
+
* If the default style attribute has been set for a component, an individual component can use style="" to revert to the normal default.
|
|
2255
|
+
* For example, if the graph has
|
|
2256
|
+
*
|
|
2257
|
+
* ```
|
|
2258
|
+
* edge [style="invis"]
|
|
2259
|
+
* ```
|
|
2260
|
+
*
|
|
2261
|
+
* making all edges invisible, a specific edge can overrride this via:
|
|
2262
|
+
*
|
|
2263
|
+
* ```
|
|
2264
|
+
* a -> b [style=""]
|
|
2265
|
+
* ```
|
|
2266
|
+
*
|
|
2267
|
+
* Of course, the component can also explicitly set its style attribute to the desired value.
|
|
2268
|
+
*
|
|
2269
|
+
* @see {@link https://graphviz.org/docs/attrs/style/ Node, Edge and Graph Attributes#style}
|
|
2270
|
+
* @graphvizType {@link https://graphviz.org/_pages/doc/info/attrs.html#k:style style}
|
|
2271
|
+
* @graphvizDefault ""
|
|
2272
|
+
* @graphvizUsedBy ENCG
|
|
2273
|
+
* @category Attribute
|
|
2274
|
+
*/
|
|
2275
|
+
style: 'style';
|
|
2276
|
+
/**
|
|
2277
|
+
* A URL or pathname specifying an XML style sheet, used in SVG output.
|
|
2278
|
+
*
|
|
2279
|
+
* @see {@link https://graphviz.org/docs/attrs/stylesheet/ Node, Edge and Graph Attributes#stylesheet}
|
|
2280
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
2281
|
+
* @graphvizDefault ""
|
|
2282
|
+
* @graphvizNotes svg only
|
|
2283
|
+
* @graphvizUsedBy G
|
|
2284
|
+
* @category Attribute
|
|
2285
|
+
*/
|
|
2286
|
+
stylesheet: 'stylesheet';
|
|
2287
|
+
/**
|
|
2288
|
+
* If **tailURL** is defined, it is output as part of the tail label of the edge.
|
|
2289
|
+
* Also, this value is used near the tail node, overriding any {@link URL} value.
|
|
2290
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
2291
|
+
*
|
|
2292
|
+
* @see {@link https://graphviz.org/docs/attrs/tailURL/ Node, Edge and Graph Attributes#tailURL}
|
|
2293
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
2294
|
+
* @graphvizDefault ""
|
|
2295
|
+
* @graphvizNotes svg, map only
|
|
2296
|
+
* @graphvizUsedBy E
|
|
2297
|
+
* @category Attribute
|
|
2298
|
+
*/
|
|
2299
|
+
tailURL: 'tailURL';
|
|
2300
|
+
/**
|
|
2301
|
+
* Position of an edge's tail label, {@link https://graphviz.org/doc/info/attrs.html in points}.
|
|
2302
|
+
* The position indicates the center of the label.
|
|
2303
|
+
*
|
|
2304
|
+
* @see {@link https://graphviz.org/docs/attrs/tail_lp/ Node, Edge and Graph Attributes#tail_lp}
|
|
2305
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/point/ point}
|
|
2306
|
+
* @graphvizNotes write only
|
|
2307
|
+
* @graphvizUsedBy E
|
|
2308
|
+
* @category Attribute
|
|
2309
|
+
*/
|
|
2310
|
+
tail_lp: 'tail_lp';
|
|
2311
|
+
/**
|
|
2312
|
+
* If true, the tail of an edge is clipped to the boundary of the tail node; otherwise,
|
|
2313
|
+
* the end of the edge goes to the center of the node, or the center of a port, if applicable.
|
|
2314
|
+
*
|
|
2315
|
+
* @see {@link https://graphviz.org/docs/attrs/tailclip/ Node, Edge and Graph Attributes#tailclip}
|
|
2316
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
2317
|
+
* @graphvizDefault TRUE
|
|
2318
|
+
* @graphvizUsedBy E
|
|
2319
|
+
* @category Attribute
|
|
2320
|
+
*/
|
|
2321
|
+
tailclip: 'tailclip';
|
|
2322
|
+
/**
|
|
2323
|
+
* Synonym for {@link tailURL}.
|
|
2324
|
+
*
|
|
2325
|
+
* @see {@link https://graphviz.org/docs/attrs/tailhref/ Node, Edge and Graph Attributes#tailhref}
|
|
2326
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
2327
|
+
* @graphvizDefault ""
|
|
2328
|
+
* @graphvizNotes svg, map only
|
|
2329
|
+
* @graphvizUsedBy E
|
|
2330
|
+
* @category Attribute
|
|
2331
|
+
*/
|
|
2332
|
+
tailhref: 'tailhref';
|
|
2333
|
+
/**
|
|
2334
|
+
* Text label to be placed near tail of edge.
|
|
2335
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
2336
|
+
*
|
|
2337
|
+
* @see {@link https://graphviz.org/docs/attrs/taillabel/ Node, Edge and Graph Attributes#taillabel}
|
|
2338
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/lblString/ lblString}
|
|
2339
|
+
* @graphvizDefault ""
|
|
2340
|
+
* @graphvizUsedBy E
|
|
2341
|
+
* @category Attribute
|
|
2342
|
+
*/
|
|
2343
|
+
taillabel: 'taillabel';
|
|
2344
|
+
/**
|
|
2345
|
+
* Indicates where on the tail node to attach the tail of the edge.
|
|
2346
|
+
* See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
|
|
2347
|
+
*
|
|
2348
|
+
* @see {@link https://graphviz.org/docs/attrs/tailport/ Node, Edge and Graph Attributes#tailport}
|
|
2349
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/portPos/ portPos}
|
|
2350
|
+
* @graphvizDefault center
|
|
2351
|
+
* @graphvizUsedBy E
|
|
2352
|
+
* @category Attribute
|
|
2353
|
+
*/
|
|
2354
|
+
tailport: 'tailport';
|
|
2355
|
+
/**
|
|
2356
|
+
* If the edge has a {@link tailURL}, this attribute determines which window of the browser is used for the URL.
|
|
2357
|
+
* Setting it to "_graphviz" will open a new window if it doesn't already exist, or reuse it if it does.
|
|
2358
|
+
* If undefined, the value of the {@link target} is used.
|
|
2359
|
+
*
|
|
2360
|
+
* @see {@link https://graphviz.org/docs/attrs/tailtarget/ Node, Edge and Graph Attributes#tailtarget}
|
|
2361
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
2362
|
+
* @graphvizDefault <none>
|
|
2363
|
+
* @graphvizNotes svg, map only
|
|
2364
|
+
* @graphvizUsedBy E
|
|
2365
|
+
* @category Attribute
|
|
2366
|
+
*/
|
|
2367
|
+
tailtarget: 'tailtarget';
|
|
2368
|
+
/**
|
|
2369
|
+
* Tooltip annotation attached to the tail of an edge.
|
|
2370
|
+
* This is used only if the edge has a {@link tailURL} attribute.
|
|
2371
|
+
*
|
|
2372
|
+
* @see {@link https://graphviz.org/docs/attrs/tailtooltip/ Node, Edge and Graph Attributes#tailtooltip}
|
|
2373
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
2374
|
+
* @graphvizDefault ""
|
|
2375
|
+
* @graphvizNotes svg, cmap only
|
|
2376
|
+
* @graphvizUsedBy E
|
|
2377
|
+
* @category Attribute
|
|
2378
|
+
*/
|
|
2379
|
+
tailtooltip: 'tailtooltip';
|
|
2380
|
+
/**
|
|
2381
|
+
* If the object has a URL, this attribute determines which window of the browser is used for the URL.
|
|
2382
|
+
* See {@link http://www.w3.org/TR/html401/present/frames.html#adef-target W3C documentation}.
|
|
2383
|
+
*
|
|
2384
|
+
* @see {@link https://graphviz.org/docs/attrs/target/ Node, Edge and Graph Attributes#target}
|
|
2385
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}/string
|
|
2386
|
+
* @graphvizDefault <none>
|
|
2387
|
+
* @graphvizNotes svg, map only
|
|
2388
|
+
* @graphvizUsedBy ENGC
|
|
2389
|
+
* @category Attribute
|
|
2390
|
+
*/
|
|
2391
|
+
target: 'target';
|
|
2392
|
+
/**
|
|
2393
|
+
* Tooltip annotation attached to the node or edge.
|
|
2394
|
+
* If unset, Graphviz will use the object's {@link label} if defined.
|
|
2395
|
+
* Note that if the label is a record specification or an HTML-like label, the resulting tooltip may be unhelpful.
|
|
2396
|
+
* In this case, if tooltips will be generated, the user should set a tooltip attribute explicitly.
|
|
2397
|
+
*
|
|
2398
|
+
* @see {@link https://graphviz.org/docs/attrs/tooltip/ Node, Edge and Graph Attributes#tooltip}
|
|
2399
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/escString/ escString}
|
|
2400
|
+
* @graphvizDefault ""
|
|
2401
|
+
* @graphvizNotes svg, cmap only
|
|
2402
|
+
* @graphvizUsedBy NEC
|
|
2403
|
+
* @category Attribute
|
|
2404
|
+
*/
|
|
2405
|
+
tooltip: 'tooltip';
|
|
2406
|
+
/**
|
|
2407
|
+
* If set explicitly to true or false, the value determines whether or not internal bitmap rendering relies on a truecolor color model or uses a color palette.
|
|
2408
|
+
* If the attribute is unset, truecolor is not used unless there is a {@link shapefile} property for some node in the graph.
|
|
2409
|
+
* The output model will use the input model when possible.
|
|
2410
|
+
*
|
|
2411
|
+
* Use of color palettes results in less memory usage during creation of the bitmaps and smaller output files.
|
|
2412
|
+
*
|
|
2413
|
+
* Usually, the only time it is necessary to specify the truecolor model is if the graph uses more than 256 colors.
|
|
2414
|
+
* However, if one uses bgcolor=transparent with a color palette, font antialiasing can show up as a fuzzy white area around characters.
|
|
2415
|
+
* Using **truecolor**=true avoids this problem.
|
|
2416
|
+
*
|
|
2417
|
+
* @see {@link https://graphviz.org/docs/attrs/truecolor/ Node, Edge and Graph Attributes#truecolor}
|
|
2418
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/bool bool}
|
|
2419
|
+
* @graphvizNotes bitmap output only
|
|
2420
|
+
* @graphvizUsedBy G
|
|
2421
|
+
* @category Attribute
|
|
2422
|
+
*/
|
|
2423
|
+
truecolor: 'truecolor';
|
|
2424
|
+
/**
|
|
2425
|
+
* If the input graph defines this attribute, the node is polygonal, and output is dot or xdot, this attribute provides the coordinates of the vertices of the node's polygon, in inches.
|
|
2426
|
+
* If the node is an ellipse or circle, the {@link samplepoints} attribute affects the output.
|
|
2427
|
+
*
|
|
2428
|
+
* @see {@link https://graphviz.org/docs/attrs/vertices/ Node, Edge and Graph Attributes#vertices}
|
|
2429
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/pointList pointList}
|
|
2430
|
+
* @graphvizNotes write only
|
|
2431
|
+
* @graphvizUsedBy N
|
|
2432
|
+
* @category Attribute
|
|
2433
|
+
*/
|
|
2434
|
+
vertices: 'vertices';
|
|
2435
|
+
/**
|
|
2436
|
+
* Clipping window on final drawing.
|
|
2437
|
+
* Note that this attribute supersedes any {@link size} attribute.
|
|
2438
|
+
* The width and height of the viewport specify precisely the final size of the output.
|
|
2439
|
+
*
|
|
2440
|
+
* @see {@link https://graphviz.org/docs/attrs/viewport/ Node, Edge and Graph Attributes#viewport}
|
|
2441
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/viewPort/ viewPort}
|
|
2442
|
+
* @graphvizDefault ""
|
|
2443
|
+
* @graphvizUsedBy G
|
|
2444
|
+
* @category Attribute
|
|
2445
|
+
*/
|
|
2446
|
+
viewport: 'viewport';
|
|
2447
|
+
/**
|
|
2448
|
+
* Factor to scale up drawing to allow margin for expansion in Voronoi technique.
|
|
2449
|
+
* dim' = (1+2*margin)*dim.
|
|
2450
|
+
*
|
|
2451
|
+
* @see {@link https://graphviz.org/docs/attrs/voro_margin/ Node, Edge and Graph Attributes#voro_margin}
|
|
2452
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
2453
|
+
* @graphvizDefault 0.05
|
|
2454
|
+
* @graphvizMinimum 0
|
|
2455
|
+
* @graphvizNotes not dot
|
|
2456
|
+
* @graphvizUsedBy G
|
|
2457
|
+
* @category Attribute
|
|
2458
|
+
*/
|
|
2459
|
+
voro_margin: 'voro_margin';
|
|
2460
|
+
/**
|
|
2461
|
+
* Weight of edge.
|
|
2462
|
+
* In dot, the heavier the weight, the shorter, straighter and more vertical the edge is. **N.B.** Weights in dot must be integers.
|
|
2463
|
+
* For twopi, a weight of 0 indicates the edge should not be used in constructing a spanning tree from the root.
|
|
2464
|
+
* For other layouts, a larger weight encourages the layout to make the edge length closer to that specified by the len attribute.
|
|
2465
|
+
*
|
|
2466
|
+
* @see {@link https://graphviz.org/docs/attrs/weight/ Node, Edge and Graph Attributes#weight}
|
|
2467
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/int/ int}/{@link https://graphviz.org/docs/attr-types/double/ double}
|
|
2468
|
+
* @graphvizDefault 1
|
|
2469
|
+
* @graphvizMinimum
|
|
2470
|
+
* 0(dot,twopi)
|
|
2471
|
+
* 1(neato,fdp)
|
|
2472
|
+
* @graphvizUsedBy E
|
|
2473
|
+
* @category Attribute
|
|
2474
|
+
*/
|
|
2475
|
+
weight: 'weight';
|
|
2476
|
+
/**
|
|
2477
|
+
* Width of node, in inches.
|
|
2478
|
+
* This is taken as the initial, minimum width of the node.
|
|
2479
|
+
* If {@link fixedsize} is true, this will be the final width of the node.
|
|
2480
|
+
* Otherwise, if the node label requires more width to fit, the node's width will be increased to contain the label.
|
|
2481
|
+
* Note also that, if the output format is dot, the value given to width will be the final value.
|
|
2482
|
+
*
|
|
2483
|
+
* @see {@link https://graphviz.org/docs/attrs/width/ Node, Edge and Graph Attributes#width}
|
|
2484
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
2485
|
+
* @graphvizDefault 0.75
|
|
2486
|
+
* @graphvizMinimum 0.01
|
|
2487
|
+
* @graphvizUsedBy N
|
|
2488
|
+
* @category Attribute
|
|
2489
|
+
*/
|
|
2490
|
+
width: 'width';
|
|
2491
|
+
/**
|
|
2492
|
+
* For xdot output, if this attribute is set, this determines the version of xdot used in output.
|
|
2493
|
+
* If not set, the attribute will be set to the xdot version used for output.
|
|
2494
|
+
*
|
|
2495
|
+
* @see {@link https://graphviz.org/docs/attrs/xdotversion/ Node, Edge and Graph Attributes#xdotversion}
|
|
2496
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/string/ string}
|
|
2497
|
+
* @graphvizNotes xdot only
|
|
2498
|
+
* @graphvizUsedBy G
|
|
2499
|
+
* @category Attribute
|
|
2500
|
+
*/
|
|
2501
|
+
xdotversion: 'xdotversion';
|
|
2502
|
+
/**
|
|
2503
|
+
* External label for a node or edge.
|
|
2504
|
+
* For nodes, the label will be placed outside of the node but near it.
|
|
2505
|
+
* For edges, the label will be placed near the center of the edge.
|
|
2506
|
+
* This can be useful in dot to avoid the occasional problem when the use of edge labels distorts the layout.
|
|
2507
|
+
* For other layouts, the xlabel attribute can be viewed as a synonym for the {@link label} attribute.
|
|
2508
|
+
*
|
|
2509
|
+
* These labels are added after all nodes and edges have been placed.
|
|
2510
|
+
* The labels will be placed so that they do not overlap any node or label.
|
|
2511
|
+
* This means it may not be possible to place all of them.
|
|
2512
|
+
* To force placing all of them, use the {@link forcelabels} attribute.
|
|
2513
|
+
*
|
|
2514
|
+
* @see {@link https://graphviz.org/docs/attrs/xlabel/ Node, Edge and Graph Attributes#xlabel}
|
|
2515
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/lblString/ lblString}
|
|
2516
|
+
* @graphvizDefault ""
|
|
2517
|
+
* @graphvizUsedBy EN
|
|
2518
|
+
* @category Attribute
|
|
2519
|
+
*/
|
|
2520
|
+
xlabel: 'xlabel';
|
|
2521
|
+
/**
|
|
2522
|
+
* Position of an exterior label, {@link https://graphviz.org/doc/info/attrs.html in points}.
|
|
2523
|
+
* The position indicates the center of the label.
|
|
2524
|
+
*
|
|
2525
|
+
* @see {@link https://graphviz.org/docs/attrs/xlp/ Node, Edge and Graph Attributes#xlp}
|
|
2526
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/point/ point}
|
|
2527
|
+
* @graphvizNotes write only
|
|
2528
|
+
* @graphvizUsedBy NE
|
|
2529
|
+
* @category Attribute
|
|
2530
|
+
*/
|
|
2531
|
+
xlp: 'xlp';
|
|
2532
|
+
/**
|
|
2533
|
+
* Deprecated:Use {@link pos} attribute, along with {@link dimen} and/or {@link dim} to specify dimensions.
|
|
2534
|
+
*
|
|
2535
|
+
* Provides z coordinate value for 3D layouts and displays.
|
|
2536
|
+
* If the graph has {@link dim} set to 3 (or more), neato will use a node's **z** value for the z coordinate of its initial position if its {@link pos} attribute is also defined.
|
|
2537
|
+
*
|
|
2538
|
+
* Even if no **z** values are specified in the input, it is necessary to declare a **z** attribute for nodes, e.g,
|
|
2539
|
+
* using node[z=""] in order to get z values on output.
|
|
2540
|
+
* Thus, setting dim=3 but not declaring **z** will cause neato -Tvrml to layout the graph in 3D but project the layout onto the xy-plane for the rendering.
|
|
2541
|
+
* If the **z** attribute is declared, the final rendering will be in 3D.
|
|
2542
|
+
*
|
|
2543
|
+
*
|
|
2544
|
+
* @see {@link https://graphviz.org/docs/attrs/z/ Node, Edge and Graph Attributes#z}
|
|
2545
|
+
* @graphvizType {@link https://graphviz.org/docs/attr-types/double/ double}
|
|
2546
|
+
* @graphvizDefault 0
|
|
2547
|
+
* @graphvizMinimum
|
|
2548
|
+
* -MAXFLOAT
|
|
2549
|
+
* -1000
|
|
2550
|
+
* @graphvizUsedBy N
|
|
2551
|
+
* @deprecated
|
|
2552
|
+
* @category Attribute
|
|
2553
|
+
*/
|
|
2554
|
+
z: 'z';
|
|
2555
|
+
}
|
|
2556
|
+
/**
|
|
2557
|
+
* $types is an interface that defines a set of attributes that can be used to configure a graph.
|
|
2558
|
+
*/
|
|
2559
|
+
export interface $types {
|
|
2560
|
+
_background: string;
|
|
2561
|
+
area: Double;
|
|
2562
|
+
arrowhead: ArrowType;
|
|
2563
|
+
arrowsize: Double;
|
|
2564
|
+
arrowtail: ArrowType;
|
|
2565
|
+
bb: Rect;
|
|
2566
|
+
bgcolor: Color | ColorList;
|
|
2567
|
+
TBbalance: TBbalanceType;
|
|
2568
|
+
center: boolean;
|
|
2569
|
+
charset: string;
|
|
2570
|
+
class: string;
|
|
2571
|
+
clusterrank: ClusterMode;
|
|
2572
|
+
color: Color | ColorList;
|
|
2573
|
+
colorscheme: string;
|
|
2574
|
+
comment: string;
|
|
2575
|
+
compound: boolean;
|
|
2576
|
+
concentrate: boolean;
|
|
2577
|
+
constraint: boolean;
|
|
2578
|
+
Damping: Double;
|
|
2579
|
+
decorate: boolean;
|
|
2580
|
+
defaultdist: Double;
|
|
2581
|
+
dim: Int;
|
|
2582
|
+
dimen: Int;
|
|
2583
|
+
dir: DirType;
|
|
2584
|
+
diredgeconstraints: string | boolean;
|
|
2585
|
+
distortion: Double;
|
|
2586
|
+
dpi: Double;
|
|
2587
|
+
edgehref: EscString;
|
|
2588
|
+
edgetarget: EscString;
|
|
2589
|
+
edgetooltip: EscString;
|
|
2590
|
+
edgeURL: EscString;
|
|
2591
|
+
epsilon: Double;
|
|
2592
|
+
esep: AddDouble | AddPoint;
|
|
2593
|
+
fillcolor: Color | ColorList;
|
|
2594
|
+
fixedsize: boolean | string;
|
|
2595
|
+
fontcolor: Color;
|
|
2596
|
+
fontname: string;
|
|
2597
|
+
fontnames: string;
|
|
2598
|
+
fontpath: string;
|
|
2599
|
+
fontsize: Double;
|
|
2600
|
+
forcelabels: boolean;
|
|
2601
|
+
gradientangle: Blank | Int;
|
|
2602
|
+
group: string;
|
|
2603
|
+
head_lp: Point;
|
|
2604
|
+
headclip: boolean;
|
|
2605
|
+
headhref: EscString;
|
|
2606
|
+
headlabel: LblString;
|
|
2607
|
+
headport: PortPos;
|
|
2608
|
+
headtarget: EscString;
|
|
2609
|
+
headtooltip: EscString;
|
|
2610
|
+
headURL: EscString;
|
|
2611
|
+
height: Blank | Double;
|
|
2612
|
+
href: EscString;
|
|
2613
|
+
id: EscString;
|
|
2614
|
+
image: string;
|
|
2615
|
+
imagepath: string;
|
|
2616
|
+
imagepos: string;
|
|
2617
|
+
imagescale: string | boolean;
|
|
2618
|
+
inputscale: Double;
|
|
2619
|
+
K: Double;
|
|
2620
|
+
label: LblString;
|
|
2621
|
+
label_scheme: Int;
|
|
2622
|
+
labelangle: Double;
|
|
2623
|
+
labeldistance: Double;
|
|
2624
|
+
labelfloat: boolean;
|
|
2625
|
+
labelfontcolor: Color;
|
|
2626
|
+
labelfontname: string;
|
|
2627
|
+
labelfontsize: Double;
|
|
2628
|
+
labelhref: EscString;
|
|
2629
|
+
labeljust: string;
|
|
2630
|
+
labelloc: string;
|
|
2631
|
+
labeltarget: EscString;
|
|
2632
|
+
labeltooltip: EscString;
|
|
2633
|
+
labelURL: EscString;
|
|
2634
|
+
landscape: boolean;
|
|
2635
|
+
layer: LayerRange;
|
|
2636
|
+
layerlistsep: string;
|
|
2637
|
+
layers: LayerList;
|
|
2638
|
+
layerselect: LayerRange;
|
|
2639
|
+
layersep: string;
|
|
2640
|
+
layout: string;
|
|
2641
|
+
len: Double;
|
|
2642
|
+
levels: Int;
|
|
2643
|
+
levelsgap: Double;
|
|
2644
|
+
lhead: string;
|
|
2645
|
+
lheight: Double;
|
|
2646
|
+
lp: Point;
|
|
2647
|
+
ltail: string;
|
|
2648
|
+
lwidth: Double;
|
|
2649
|
+
margin: Double | Point;
|
|
2650
|
+
maxiter: Int;
|
|
2651
|
+
mclimit: Double;
|
|
2652
|
+
mindist: Double;
|
|
2653
|
+
minlen: Int;
|
|
2654
|
+
mode: string;
|
|
2655
|
+
model: string;
|
|
2656
|
+
mosek: boolean;
|
|
2657
|
+
newrank: boolean;
|
|
2658
|
+
nodesep: Double;
|
|
2659
|
+
nojustify: boolean;
|
|
2660
|
+
normalize: Double | boolean;
|
|
2661
|
+
notranslate: boolean;
|
|
2662
|
+
nslimit: Double;
|
|
2663
|
+
nslimit1: Double;
|
|
2664
|
+
ordering: string;
|
|
2665
|
+
orientation: string | Double;
|
|
2666
|
+
outputorder: OutputMode;
|
|
2667
|
+
overlap: string | boolean;
|
|
2668
|
+
overlap_scaling: Double;
|
|
2669
|
+
overlap_shrink: boolean;
|
|
2670
|
+
pack: boolean | Int;
|
|
2671
|
+
packmode: PackMode;
|
|
2672
|
+
pad: Double | Point;
|
|
2673
|
+
page: Double | Point;
|
|
2674
|
+
pagedir: Pagedir;
|
|
2675
|
+
pencolor: Color;
|
|
2676
|
+
penwidth: Double;
|
|
2677
|
+
peripheries: Int;
|
|
2678
|
+
pin: boolean;
|
|
2679
|
+
pos: Point | SplineType;
|
|
2680
|
+
quadtree: QuadType | boolean;
|
|
2681
|
+
quantum: Double;
|
|
2682
|
+
rank: RankType;
|
|
2683
|
+
rankdir: Rankdir;
|
|
2684
|
+
ranksep: Double | DoubleList;
|
|
2685
|
+
ratio: Double | string;
|
|
2686
|
+
rects: Rect;
|
|
2687
|
+
regular: boolean;
|
|
2688
|
+
remincross: boolean;
|
|
2689
|
+
repulsiveforce: Double;
|
|
2690
|
+
resolution: Double;
|
|
2691
|
+
root: string | boolean;
|
|
2692
|
+
rotate: Int;
|
|
2693
|
+
rotation: Double;
|
|
2694
|
+
samehead: string;
|
|
2695
|
+
sametail: string;
|
|
2696
|
+
samplepoints: Int;
|
|
2697
|
+
scale: Double | Point;
|
|
2698
|
+
searchsize: Int;
|
|
2699
|
+
sep: AddDouble | AddPoint;
|
|
2700
|
+
shape: Shape;
|
|
2701
|
+
shapefile: string;
|
|
2702
|
+
showboxes: Int;
|
|
2703
|
+
sides: Int;
|
|
2704
|
+
size: Double | Point;
|
|
2705
|
+
skew: Double;
|
|
2706
|
+
smoothing: SmoothType;
|
|
2707
|
+
sortv: Int;
|
|
2708
|
+
splines: boolean | string;
|
|
2709
|
+
start: Blank | StartType;
|
|
2710
|
+
style: Blank | Style;
|
|
2711
|
+
stylesheet: string;
|
|
2712
|
+
tail_lp: string;
|
|
2713
|
+
tailclip: Point;
|
|
2714
|
+
tailhref: EscString;
|
|
2715
|
+
taillabel: LblString;
|
|
2716
|
+
tailport: PortPos;
|
|
2717
|
+
tailtarget: EscString;
|
|
2718
|
+
tailtooltip: EscString;
|
|
2719
|
+
tailURL: EscString;
|
|
2720
|
+
target: EscString | string;
|
|
2721
|
+
tooltip: EscString;
|
|
2722
|
+
truecolor: boolean;
|
|
2723
|
+
URL: EscString;
|
|
2724
|
+
vertices: PointList;
|
|
2725
|
+
viewport: Blank | ViewPort;
|
|
2726
|
+
voro_margin: Double;
|
|
2727
|
+
weight: Int | Double;
|
|
2728
|
+
width: Double;
|
|
2729
|
+
xdotversion: string;
|
|
2730
|
+
xlabel: LblString;
|
|
2731
|
+
xlp: Point;
|
|
2732
|
+
z: Blank | Double;
|
|
2733
|
+
}
|
|
2734
|
+
}
|
|
2735
|
+
|
|
2736
|
+
/**
|
|
2737
|
+
* Attribute types.
|
|
2738
|
+
* @group Attribute
|
|
2739
|
+
*/
|
|
2740
|
+
export declare type AttributeKey = NodeAttributeKey | EdgeAttributeKey | GraphAttributeKey | SubgraphAttributeKey | ClusterSubgraphAttributeKey;
|
|
2741
|
+
|
|
2742
|
+
/**
|
|
2743
|
+
* @group Models
|
|
2744
|
+
*/
|
|
2745
|
+
export declare type AttributeListKind = 'Graph' | 'Edge' | 'Node';
|
|
2746
|
+
|
|
2747
|
+
/**
|
|
2748
|
+
* A list object of attributes commonly specified for nodes, subgraphs, and edges
|
|
2749
|
+
* under graph and subgraph.
|
|
2750
|
+
*
|
|
2751
|
+
* @typeParam K - The type of object is being specified.
|
|
2752
|
+
* @typeParam T - The attribute keys to set DOT object.
|
|
2753
|
+
* @group Models
|
|
2754
|
+
*/
|
|
2755
|
+
export declare interface AttributeListModel<K extends AttributeListKind = AttributeListKind, T extends AttributeKey = AttributeKey> extends Attributes<T>, HasComment, DotObjectModel<'AttributeList'> {
|
|
2756
|
+
$$kind: K;
|
|
2757
|
+
}
|
|
2758
|
+
|
|
2759
|
+
/**
|
|
2760
|
+
* DOT object with the property
|
|
2761
|
+
* that attributes can be held as a set of keys and values.
|
|
2762
|
+
*
|
|
2763
|
+
* @typeParam T - The attribute keys to set DOT object.
|
|
2764
|
+
* @group Models
|
|
2765
|
+
*/
|
|
2766
|
+
export declare interface Attributes<T extends AttributeKey> {
|
|
2767
|
+
/** Size of the set of keys and values held by the DOT object. */
|
|
2768
|
+
readonly size: number;
|
|
2769
|
+
/** The key/value tuples of the object attributes. */
|
|
2770
|
+
readonly values: ReadonlyArray<[T, Attribute<T>]>;
|
|
2771
|
+
/**
|
|
2772
|
+
* Get the value of an attribute by a DOT object by specifying its key.
|
|
2773
|
+
*
|
|
2774
|
+
* If the value corresponding to the key does not exist, undefined is returned.
|
|
2775
|
+
*/
|
|
2776
|
+
get<K extends T>(key: K): Attribute<K> | undefined;
|
|
2777
|
+
/** Set a value, by specifying the key of the attributes in the DOT object. */
|
|
2778
|
+
set<K extends T>(key: K, value: Attribute<K>): void;
|
|
2779
|
+
/**
|
|
2780
|
+
* Apply keys and values that can be specified for DOT objects collectively.
|
|
2781
|
+
*
|
|
2782
|
+
* @param attributes - An array of objects or tuples of attribute key/value pairs.
|
|
2783
|
+
*/
|
|
2784
|
+
apply(attributes: AttributesObject<T> | AttributesEntities<T>): void;
|
|
2785
|
+
/** Delete the value of an attribute from a DOT object by specifying a key. */
|
|
2786
|
+
delete(key: T): void;
|
|
2787
|
+
/** Delete all attributes specified for the DOT object. */
|
|
2788
|
+
clear(): void;
|
|
2789
|
+
}
|
|
2790
|
+
|
|
2791
|
+
/**
|
|
2792
|
+
* An array of attribute key/value tuple.
|
|
2793
|
+
* @group Models
|
|
2794
|
+
*/
|
|
2795
|
+
export declare type AttributesEntities<T extends AttributeKey> = readonly [
|
|
2796
|
+
T,
|
|
2797
|
+
Attribute<T>
|
|
2798
|
+
][];
|
|
2799
|
+
|
|
2800
|
+
/**
|
|
2801
|
+
* @group Models
|
|
2802
|
+
*/
|
|
2803
|
+
export declare interface AttributesGroupModel<T extends AttributeKey> extends Attributes<T>, HasComment {
|
|
2804
|
+
}
|
|
2805
|
+
|
|
2806
|
+
/**
|
|
2807
|
+
* An objects of attribute key/value pairs.
|
|
2808
|
+
* @group Models
|
|
2809
|
+
*/
|
|
2810
|
+
export declare type AttributesObject<T extends AttributeKey> = {
|
|
2811
|
+
[K in T]?: Attribute<K>;
|
|
2812
|
+
};
|
|
2813
|
+
|
|
2814
|
+
/**
|
|
2815
|
+
* @group Models
|
|
2816
|
+
*/
|
|
2817
|
+
export declare type AttributeValue = Attribute<AttributeKey>;
|
|
2818
|
+
|
|
2819
|
+
/**
|
|
2820
|
+
* A value specifying an empty string for resetting some values.
|
|
2821
|
+
* @group Attribute Types
|
|
2822
|
+
*/
|
|
2823
|
+
export declare type Blank = '';
|
|
2824
|
+
|
|
2825
|
+
/**
|
|
2826
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/clusterMode/ clusterMode}
|
|
2827
|
+
* @group Attribute Types
|
|
2828
|
+
*/
|
|
2829
|
+
export declare type ClusterMode = ClusterMode.values;
|
|
2830
|
+
|
|
2831
|
+
export declare namespace ClusterMode {
|
|
2832
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
2833
|
+
export interface $values extends $keywords<'local' | 'global' | 'none'> {
|
|
2834
|
+
}
|
|
2835
|
+
export interface $exclude extends $keywordsValidation {
|
|
2836
|
+
}
|
|
2837
|
+
}
|
|
2838
|
+
|
|
2839
|
+
/**
|
|
2840
|
+
* Attribute types available for cluster subgraph.
|
|
2841
|
+
* @group Attribute
|
|
2842
|
+
*/
|
|
2843
|
+
export declare type ClusterSubgraphAttributeKey = ClusterSubgraphAttributeKey.values;
|
|
2844
|
+
|
|
2845
|
+
/** @hidden */
|
|
2846
|
+
export declare namespace ClusterSubgraphAttributeKey {
|
|
2847
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
2848
|
+
export interface $values extends $keywords<'K' | 'URL' | 'area' | 'bgcolor' | 'color' | 'colorscheme' | 'fillcolor' | 'fontcolor' | 'fontname' | 'fontsize' | 'gradientangle' | 'href' | 'id' | 'label' | 'labeljust' | 'labelloc' | 'layer' | 'lheight' | 'lp' | 'lwidth' | 'margin' | 'nojustify' | 'pencolor' | 'penwidth' | 'peripheries' | 'sortv' | 'style' | 'target' | 'tooltip' | 'class'> {
|
|
2849
|
+
}
|
|
2850
|
+
export interface $exclude extends $keywordsValidation {
|
|
2851
|
+
}
|
|
2852
|
+
}
|
|
2853
|
+
|
|
2854
|
+
/**
|
|
2855
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/color/ color}
|
|
2856
|
+
* @group Attribute Types
|
|
2857
|
+
*/
|
|
2858
|
+
export declare type Color = Color.RGB_RGBA | Color.HSV | Color.ColorName | number;
|
|
2859
|
+
|
|
2860
|
+
/** @hidden */
|
|
2861
|
+
export declare namespace Color {
|
|
2862
|
+
/**
|
|
2863
|
+
* `"#%2x%2x%2x"` Red-Green-Blue (RGB)
|
|
2864
|
+
*
|
|
2865
|
+
* `"#%2x%2x%2x%2x"` Red-Green-Blue-Alpha (RGBA)
|
|
2866
|
+
* @note A type that is too complicated to express in TypeScript.
|
|
2867
|
+
*/
|
|
2868
|
+
export type RGB_RGBA = `#${string}`;
|
|
2869
|
+
/**
|
|
2870
|
+
* Hue-Saturation-Value (HSV) 0.0 <= H,S,V <= 1.0
|
|
2871
|
+
*/
|
|
2872
|
+
export type HSV = `${number}+${number}+${number}`;
|
|
2873
|
+
/**
|
|
2874
|
+
* Color names are resolved in the context of a color scheme.
|
|
2875
|
+
*
|
|
2876
|
+
* Graphviz currently supports the X11 scheme, the SVG scheme, and the Brewer schemes, with X11 being the default.
|
|
2877
|
+
* @see {@link https://graphviz.org/doc/info/colors.html Color Names}
|
|
2878
|
+
*/
|
|
2879
|
+
export type ColorName = Exclude<keyof $colors, keyof $exclude>;
|
|
2880
|
+
export interface $colors extends $keywords<'aliceblue' | 'antiquewhite' | 'antiquewhite1' | 'antiquewhite2' | 'antiquewhite3' | 'antiquewhite4' | 'aqua' | 'aquamarine' | 'aquamarine1' | 'aquamarine2' | 'aquamarine3' | 'aquamarine4' | 'azure' | 'azure1' | 'azure2' | 'azure3' | 'azure4' | 'beige' | 'bisque' | 'bisque1' | 'bisque2' | 'bisque3' | 'bisque4' | 'black' | 'blanchedalmond' | 'blue' | 'blue1' | 'blue2' | 'blue3' | 'blue4' | 'blueviolet' | 'brown' | 'brown1' | 'brown2' | 'brown3' | 'brown4' | 'burlywood' | 'burlywood1' | 'burlywood2' | 'burlywood3' | 'burlywood4' | 'cadetblue' | 'cadetblue1' | 'cadetblue2' | 'cadetblue3' | 'cadetblue4' | 'chartreuse' | 'chartreuse1' | 'chartreuse2' | 'chartreuse3' | 'chartreuse4' | 'chocolate' | 'chocolate1' | 'chocolate2' | 'chocolate3' | 'chocolate4' | 'coral' | 'coral1' | 'coral2' | 'coral3' | 'coral4' | 'cornflowerblue' | 'cornsilk' | 'cornsilk1' | 'cornsilk2' | 'cornsilk3' | 'cornsilk4' | 'crimson' | 'cyan' | 'cyan1' | 'cyan2' | 'cyan3' | 'cyan4' | 'darkblue' | 'darkcyan' | 'darkgoldenrod' | 'darkgoldenrod1' | 'darkgoldenrod2' | 'darkgoldenrod3' | 'darkgoldenrod4' | 'darkgray' | 'darkgreen' | 'darkgrey' | 'darkkhaki' | 'darkmagenta' | 'darkolivegreen' | 'darkolivegreen1' | 'darkolivegreen2' | 'darkolivegreen3' | 'darkolivegreen4' | 'darkorange' | 'darkorange1' | 'darkorange2' | 'darkorange3' | 'darkorange4' | 'darkorchid' | 'darkorchid1' | 'darkorchid2' | 'darkorchid3' | 'darkorchid4' | 'darkred' | 'darksalmon' | 'darkseagreen' | 'darkseagreen1' | 'darkseagreen2' | 'darkseagreen3' | 'darkseagreen4' | 'darkslateblue' | 'darkslategray' | 'darkslategray1' | 'darkslategray2' | 'darkslategray3' | 'darkslategray4' | 'darkslategrey' | 'darkturquoise' | 'darkviolet' | 'deeppink' | 'deeppink1' | 'deeppink2' | 'deeppink3' | 'deeppink4' | 'deepskyblue' | 'deepskyblue1' | 'deepskyblue2' | 'deepskyblue3' | 'deepskyblue4' | 'dimgray' | 'dimgrey' | 'dodgerblue' | 'dodgerblue1' | 'dodgerblue2' | 'dodgerblue3' | 'dodgerblue4' | 'firebrick' | 'firebrick1' | 'firebrick2' | 'firebrick3' | 'firebrick4' | 'floralwhite' | 'forestgreen' | 'fuchsia' | 'gainsboro' | 'ghostwhite' | 'gold' | 'gold1' | 'gold2' | 'gold3' | 'gold4' | 'goldenrod' | 'goldenrod1' | 'goldenrod2' | 'goldenrod3' | 'goldenrod4' | 'gray' | 'gray0' | 'gray1' | 'gray10' | 'gray100' | 'gray11' | 'gray12' | 'gray13' | 'gray14' | 'gray15' | 'gray16' | 'gray17' | 'gray18' | 'gray19' | 'gray2' | 'gray20' | 'gray21' | 'gray22' | 'gray23' | 'gray24' | 'gray25' | 'gray26' | 'gray27' | 'gray28' | 'gray29' | 'gray3' | 'gray30' | 'gray31' | 'gray32' | 'gray33' | 'gray34' | 'gray35' | 'gray36' | 'gray37' | 'gray38' | 'gray39' | 'gray4' | 'gray40' | 'gray41' | 'gray42' | 'gray43' | 'gray44' | 'gray45' | 'gray46' | 'gray47' | 'gray48' | 'gray49' | 'gray5' | 'gray50' | 'gray51' | 'gray52' | 'gray53' | 'gray54' | 'gray55' | 'gray56' | 'gray57' | 'gray58' | 'gray59' | 'gray6' | 'gray60' | 'gray61' | 'gray62' | 'gray63' | 'gray64' | 'gray65' | 'gray66' | 'gray67' | 'gray68' | 'gray69' | 'gray7' | 'gray70' | 'gray71' | 'gray72' | 'gray73' | 'gray74' | 'gray75' | 'gray76' | 'gray77' | 'gray78' | 'gray79' | 'gray8' | 'gray80' | 'gray81' | 'gray82' | 'gray83' | 'gray84' | 'gray85' | 'gray86' | 'gray87' | 'gray88' | 'gray89' | 'gray9' | 'gray90' | 'gray91' | 'gray92' | 'gray93' | 'gray94' | 'gray95' | 'gray96' | 'gray97' | 'gray98' | 'gray99' | 'green' | 'green1' | 'green2' | 'green3' | 'green4' | 'greenyellow' | 'grey' | 'grey0' | 'grey1' | 'grey10' | 'grey100' | 'grey11' | 'grey12' | 'grey13' | 'grey14' | 'grey15' | 'grey16' | 'grey17' | 'grey18' | 'grey19' | 'grey2' | 'grey20' | 'grey21' | 'grey22' | 'grey23' | 'grey24' | 'grey25' | 'grey26' | 'grey27' | 'grey28' | 'grey29' | 'grey3' | 'grey30' | 'grey31' | 'grey32' | 'grey33' | 'grey34' | 'grey35' | 'grey36' | 'grey37' | 'grey38' | 'grey39' | 'grey4' | 'grey40' | 'grey41' | 'grey42' | 'grey43' | 'grey44' | 'grey45' | 'grey46' | 'grey47' | 'grey48' | 'grey49' | 'grey5' | 'grey50' | 'grey51' | 'grey52' | 'grey53' | 'grey54' | 'grey55' | 'grey56' | 'grey57' | 'grey58' | 'grey59' | 'grey6' | 'grey60' | 'grey61' | 'grey62' | 'grey63' | 'grey64' | 'grey65' | 'grey66' | 'grey67' | 'grey68' | 'grey69' | 'grey7' | 'grey70' | 'grey71' | 'grey72' | 'grey73' | 'grey74' | 'grey75' | 'grey76' | 'grey77' | 'grey78' | 'grey79' | 'grey8' | 'grey80' | 'grey81' | 'grey82' | 'grey83' | 'grey84' | 'grey85' | 'grey86' | 'grey87' | 'grey88' | 'grey89' | 'grey9' | 'grey90' | 'grey91' | 'grey92' | 'grey93' | 'grey94' | 'grey95' | 'grey96' | 'grey97' | 'grey98' | 'grey99' | 'honeydew' | 'honeydew1' | 'honeydew2' | 'honeydew3' | 'honeydew4' | 'hotpink' | 'hotpink1' | 'hotpink2' | 'hotpink3' | 'hotpink4' | 'indianred' | 'indianred1' | 'indianred2' | 'indianred3' | 'indianred4' | 'indigo' | 'invis' | 'ivory' | 'ivory1' | 'ivory2' | 'ivory3' | 'ivory4' | 'khaki' | 'khaki1' | 'khaki2' | 'khaki3' | 'khaki4' | 'lavender' | 'lavenderblush' | 'lavenderblush1' | 'lavenderblush2' | 'lavenderblush3' | 'lavenderblush4' | 'lawngreen' | 'lemonchiffon' | 'lemonchiffon1' | 'lemonchiffon2' | 'lemonchiffon3' | 'lemonchiffon4' | 'lightblue' | 'lightblue1' | 'lightblue2' | 'lightblue3' | 'lightblue4' | 'lightcoral' | 'lightcyan' | 'lightcyan1' | 'lightcyan2' | 'lightcyan3' | 'lightcyan4' | 'lightgoldenrod' | 'lightgoldenrod1' | 'lightgoldenrod2' | 'lightgoldenrod3' | 'lightgoldenrod4' | 'lightgoldenrodyellow' | 'lightgray' | 'lightgreen' | 'lightgrey' | 'lightpink' | 'lightpink1' | 'lightpink2' | 'lightpink3' | 'lightpink4' | 'lightsalmon' | 'lightsalmon1' | 'lightsalmon2' | 'lightsalmon3' | 'lightsalmon4' | 'lightseagreen' | 'lightskyblue' | 'lightskyblue1' | 'lightskyblue2' | 'lightskyblue3' | 'lightskyblue4' | 'lightslateblue' | 'lightslategray' | 'lightslategrey' | 'lightsteelblue' | 'lightsteelblue1' | 'lightsteelblue2' | 'lightsteelblue3' | 'lightsteelblue4' | 'lightyellow' | 'lightyellow1' | 'lightyellow2' | 'lightyellow3' | 'lightyellow4' | 'lime' | 'limegreen' | 'linen' | 'magenta' | 'magenta1' | 'magenta2' | 'magenta3' | 'magenta4' | 'maroon' | 'maroon1' | 'maroon2' | 'maroon3' | 'maroon4' | 'mediumaquamarine' | 'mediumblue' | 'mediumorchid' | 'mediumorchid1' | 'mediumorchid2' | 'mediumorchid3' | 'mediumorchid4' | 'mediumpurple' | 'mediumpurple1' | 'mediumpurple2' | 'mediumpurple3' | 'mediumpurple4' | 'mediumseagreen' | 'mediumslateblue' | 'mediumspringgreen' | 'mediumturquoise' | 'mediumvioletred' | 'midnightblue' | 'mintcream' | 'mistyrose' | 'mistyrose1' | 'mistyrose2' | 'mistyrose3' | 'mistyrose4' | 'moccasin' | 'navajowhite' | 'navajowhite1' | 'navajowhite2' | 'navajowhite3' | 'navajowhite4' | 'navy' | 'navyblue' | 'none' | 'oldlace' | 'olive' | 'olivedrab' | 'olivedrab1' | 'olivedrab2' | 'olivedrab3' | 'olivedrab4' | 'orange' | 'orange1' | 'orange2' | 'orange3' | 'orange4' | 'orangered' | 'orangered1' | 'orangered2' | 'orangered3' | 'orangered4' | 'orchid' | 'orchid1' | 'orchid2' | 'orchid3' | 'orchid4' | 'palegoldenrod' | 'palegreen' | 'palegreen1' | 'palegreen2' | 'palegreen3' | 'palegreen4' | 'paleturquoise' | 'paleturquoise1' | 'paleturquoise2' | 'paleturquoise3' | 'paleturquoise4' | 'palevioletred' | 'palevioletred1' | 'palevioletred2' | 'palevioletred3' | 'palevioletred4' | 'papayawhip' | 'peachpuff' | 'peachpuff1' | 'peachpuff2' | 'peachpuff3' | 'peachpuff4' | 'peru' | 'pink' | 'pink1' | 'pink2' | 'pink3' | 'pink4' | 'plum' | 'plum1' | 'plum2' | 'plum3' | 'plum4' | 'powderblue' | 'purple' | 'purple1' | 'purple2' | 'purple3' | 'purple4' | 'rebeccapurple' | 'red' | 'red1' | 'red2' | 'red3' | 'red4' | 'rosybrown' | 'rosybrown1' | 'rosybrown2' | 'rosybrown3' | 'rosybrown4' | 'royalblue' | 'royalblue1' | 'royalblue2' | 'royalblue3' | 'royalblue4' | 'saddlebrown' | 'salmon' | 'salmon1' | 'salmon2' | 'salmon3' | 'salmon4' | 'sandybrown' | 'seagreen' | 'seagreen1' | 'seagreen2' | 'seagreen3' | 'seagreen4' | 'seashell' | 'seashell1' | 'seashell2' | 'seashell3' | 'seashell4' | 'sienna' | 'sienna1' | 'sienna2' | 'sienna3' | 'sienna4' | 'silver' | 'skyblue' | 'skyblue1' | 'skyblue2' | 'skyblue3' | 'skyblue4' | 'slateblue' | 'slateblue1' | 'slateblue2' | 'slateblue3' | 'slateblue4' | 'slategray' | 'slategray1' | 'slategray2' | 'slategray3' | 'slategray4' | 'slategrey' | 'snow' | 'snow1' | 'snow2' | 'snow3' | 'snow4' | 'springgreen' | 'springgreen1' | 'springgreen2' | 'springgreen3' | 'springgreen4' | 'steelblue' | 'steelblue1' | 'steelblue2' | 'steelblue3' | 'steelblue4' | 'tan' | 'tan1' | 'tan2' | 'tan3' | 'tan4' | 'teal' | 'thistle' | 'thistle1' | 'thistle2' | 'thistle3' | 'thistle4' | 'tomato' | 'tomato1' | 'tomato2' | 'tomato3' | 'tomato4' | 'transparent' | 'turquoise' | 'turquoise1' | 'turquoise2' | 'turquoise3' | 'turquoise4' | 'violet' | 'violetred' | 'violetred1' | 'violetred2' | 'violetred3' | 'violetred4' | 'webgray' | 'webgreen' | 'webgrey' | 'webmaroon' | 'webpurple' | 'wheat' | 'wheat1' | 'wheat2' | 'wheat3' | 'wheat4' | 'white' | 'whitesmoke' | 'x11gray' | 'x11green' | 'x11grey' | 'x11maroon' | 'x11purple' | 'yellow' | 'yellow1' | 'yellow2' | 'yellow3' | 'yellow4' | 'yellowgreen' | 'aliceblue' | 'antiquewhite' | 'aqua' | 'aquamarine' | 'azure' | 'beige' | 'bisque' | 'black' | 'blanchedalmond' | 'blue' | 'blueviolet' | 'brown' | 'burlywood' | 'cadetblue' | 'chartreuse' | 'chocolate' | 'coral' | 'cornflowerblue' | 'cornsilk' | 'crimson' | 'cyan' | 'darkblue' | 'darkcyan' | 'darkgoldenrod' | 'darkgray' | 'darkgreen' | 'darkgrey' | 'darkkhaki' | 'darkmagenta' | 'darkolivegreen' | 'darkorange' | 'darkorchid' | 'darkred' | 'darksalmon' | 'darkseagreen' | 'darkslateblue' | 'darkslategray' | 'darkslategrey' | 'darkturquoise' | 'darkviolet' | 'deeppink' | 'deepskyblue' | 'dimgray' | 'dimgrey' | 'dodgerblue' | 'firebrick' | 'floralwhite' | 'forestgreen' | 'fuchsia' | 'gainsboro' | 'ghostwhite' | 'gold' | 'goldenrod' | 'gray' | 'grey' | 'green' | 'greenyellow' | 'honeydew' | 'hotpink' | 'indianred' | 'indigo' | 'ivory' | 'khaki' | 'lavender' | 'lavenderblush' | 'lawngreen' | 'lemonchiffon' | 'lightblue' | 'lightcoral' | 'lightcyan' | 'lightgoldenrodyellow' | 'lightgray' | 'lightgreen' | 'lightgrey' | 'lightpink' | 'lightsalmon' | 'lightseagreen' | 'lightskyblue' | 'lightslategray' | 'lightslategrey' | 'lightsteelblue' | 'lightyellow' | 'lime' | 'limegreen' | 'linen' | 'magenta' | 'maroon' | 'mediumaquamarine' | 'mediumblue' | 'mediumorchid' | 'mediumpurple' | 'mediumseagreen' | 'mediumslateblue' | 'mediumspringgreen' | 'mediumturquoise' | 'mediumvioletred' | 'midnightblue' | 'mintcream' | 'mistyrose' | 'moccasin' | 'navajowhite' | 'navy' | 'oldlace' | 'olive' | 'olivedrab' | 'orange' | 'orangered' | 'orchid' | 'palegoldenrod' | 'palegreen' | 'paleturquoise' | 'palevioletred' | 'papayawhip' | 'peachpuff' | 'peru' | 'pink' | 'plum' | 'powderblue' | 'purple' | 'red' | 'rosybrown' | 'royalblue' | 'saddlebrown' | 'salmon' | 'sandybrown' | 'seagreen' | 'seashell' | 'sienna' | 'silver' | 'skyblue' | 'slateblue' | 'slategray' | 'slategrey' | 'snow' | 'springgreen' | 'steelblue' | 'tan' | 'teal' | 'thistle' | 'tomato' | 'turquoise' | 'violet' | 'wheat' | 'white' | 'whitesmoke' | 'yellow' | 'yellowgreen'> {
|
|
2881
|
+
}
|
|
2882
|
+
export interface $exclude extends $keywordsValidation {
|
|
2883
|
+
}
|
|
2884
|
+
}
|
|
2885
|
+
|
|
2886
|
+
/**
|
|
2887
|
+
* A colon-separated list of weighted color values: WC(:WC)* where each WC has the form C(;F)? with C a color value and the optional F a floating-point number, 0 ≤ F ≤ 1.
|
|
2888
|
+
*
|
|
2889
|
+
* The sum of the floating-point numbers in a colorList must sum to at most 1.
|
|
2890
|
+
*
|
|
2891
|
+
* @note A type that is too complicated to express in TypeScript.
|
|
2892
|
+
*
|
|
2893
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/colorList/}
|
|
2894
|
+
* @group Attribute Types
|
|
2895
|
+
*/
|
|
2896
|
+
export declare type ColorList = string;
|
|
2897
|
+
|
|
2898
|
+
/**
|
|
2899
|
+
* Directive indicating which direction the Edge should point.
|
|
2900
|
+
* @group Attribute Types
|
|
2901
|
+
*/
|
|
2902
|
+
export declare type Compass = Compass.values;
|
|
2903
|
+
|
|
2904
|
+
/** @hidden */
|
|
2905
|
+
export declare namespace Compass {
|
|
2906
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
2907
|
+
export interface $values extends $keywords<'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'nw' | 'c' | '_'> {
|
|
2908
|
+
}
|
|
2909
|
+
export interface $exclude extends $keywordsValidation {
|
|
2910
|
+
}
|
|
2911
|
+
}
|
|
2912
|
+
|
|
2913
|
+
/**
|
|
2914
|
+
* @group Models Context
|
|
2915
|
+
*/
|
|
2916
|
+
export declare function createModelsContext(models: Partial<ModelsContext>): ModelsContext;
|
|
2917
|
+
|
|
2918
|
+
/**
|
|
2919
|
+
* Direction Type
|
|
2920
|
+
*
|
|
2921
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/dirType/ dirType}
|
|
2922
|
+
* @group Attribute Types
|
|
2923
|
+
*/
|
|
2924
|
+
export declare type DirType = DirType.values;
|
|
2925
|
+
|
|
2926
|
+
/** @hidden */
|
|
2927
|
+
export declare namespace DirType {
|
|
2928
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
2929
|
+
export interface $values extends $keywords<'forward' | 'back' | 'both' | 'none'> {
|
|
2930
|
+
}
|
|
2931
|
+
export interface $exclude extends $keywordsValidation {
|
|
2932
|
+
}
|
|
2933
|
+
}
|
|
2934
|
+
|
|
2935
|
+
/**
|
|
2936
|
+
* DotObjectModel is an interface that defines a generic type for a {@link DotObjectType}.
|
|
2937
|
+
*
|
|
2938
|
+
* @template T The type of the {@link DotObjectType}.
|
|
2939
|
+
* @group Models
|
|
2940
|
+
*/
|
|
2941
|
+
export declare interface DotObjectModel<T extends DotObjectType = DotObjectType> {
|
|
2942
|
+
/**
|
|
2943
|
+
* The type of the DotObjectType.
|
|
2944
|
+
*/
|
|
2945
|
+
$$type: T;
|
|
2946
|
+
}
|
|
2947
|
+
|
|
2948
|
+
/**
|
|
2949
|
+
* @group Models
|
|
2950
|
+
*/
|
|
2951
|
+
export declare type DotObjectType = 'AttributeList' | 'Node' | 'Edge' | 'Subgraph' | 'Graph';
|
|
2952
|
+
|
|
2953
|
+
/**
|
|
2954
|
+
* Double-precision floating point number.
|
|
2955
|
+
*
|
|
2956
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/double/ double}
|
|
2957
|
+
* @group Attribute Types
|
|
2958
|
+
*/
|
|
2959
|
+
export declare type Double = number;
|
|
2960
|
+
|
|
2961
|
+
/**
|
|
2962
|
+
* A colon-separated list of doubles: `"%f(:%f)*"` where each %f is a double.
|
|
2963
|
+
*
|
|
2964
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/doubleList/ doubleList}
|
|
2965
|
+
* @group Attribute Types
|
|
2966
|
+
*/
|
|
2967
|
+
export declare type DoubleList = Double | `${Double}:${Double}` | `${Double}:${Double}:${Double}` | `${Double}:${Double}:${Double}:${Double}` | `${Double}:${Double}:${Double}:${Double}:${Double}` | `${Double}:${Double}:${Double}:${Double}:${Double}:${Double}` | `${Double}:${Double}:${Double}:${Double}:${Double}:${Double}:${Double}` | `${Double}:${Double}:${Double}:${Double}:${Double}:${Double}:${Double}:${Double}` | `${Double}:${Double}:${Double}:${Double}:${Double}:${Double}:${Double}:${Double}:${Double}`;
|
|
2968
|
+
|
|
2969
|
+
/**
|
|
2970
|
+
* Attribute types available for edges.
|
|
2971
|
+
* @group Attribute
|
|
2972
|
+
*/
|
|
2973
|
+
export declare type EdgeAttributeKey = EdgeAttributeKey.values;
|
|
2974
|
+
|
|
2975
|
+
/** @hidden */
|
|
2976
|
+
export declare namespace EdgeAttributeKey {
|
|
2977
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
2978
|
+
export interface $values extends $keywords<'URL' | 'arrowhead' | 'arrowsize' | 'arrowtail' | 'color' | 'colorscheme' | 'comment' | 'constraint' | 'decorate' | 'dir' | 'edgeURL' | 'edgehref' | 'edgetarget' | 'edgetooltip' | 'fillcolor' | 'fontcolor' | 'fontname' | 'fontsize' | 'headURL' | 'head_lp' | 'headclip' | 'headhref' | 'headlabel' | 'headport' | 'headtarget' | 'headtooltip' | 'href' | 'id' | 'label' | 'labelURL' | 'labelangle' | 'labeldistance' | 'labelfloat' | 'labelfontcolor' | 'labelfontname' | 'labelfontsize' | 'labelhref' | 'labeltarget' | 'labeltooltip' | 'layer' | 'len' | 'lhead' | 'lp' | 'ltail' | 'minlen' | 'nojustify' | 'penwidth' | 'pos' | 'samehead' | 'sametail' | 'showboxes' | 'style' | 'tailURL' | 'tail_lp' | 'tailclip' | 'tailhref' | 'taillabel' | 'tailport' | 'tailtarget' | 'tailtooltip' | 'target' | 'tooltip' | 'weight' | 'xlabel' | 'xlp' | 'class'> {
|
|
2979
|
+
}
|
|
2980
|
+
export interface $exclude extends $keywordsValidation {
|
|
2981
|
+
}
|
|
2982
|
+
}
|
|
2983
|
+
|
|
2984
|
+
/**
|
|
2985
|
+
* Attribute object that can be set to Edge.
|
|
2986
|
+
* @group Models
|
|
2987
|
+
*/
|
|
2988
|
+
export declare type EdgeAttributesObject = AttributesObject<EdgeAttributeKey>;
|
|
2989
|
+
|
|
2990
|
+
/**
|
|
2991
|
+
* @group Models
|
|
2992
|
+
*/
|
|
2993
|
+
export declare interface EdgeConstructor {
|
|
2994
|
+
new (targets: EdgeTargetTuple, attributes?: EdgeAttributesObject): EdgeModel;
|
|
2995
|
+
new (...args: any[]): EdgeModel;
|
|
2996
|
+
}
|
|
2997
|
+
|
|
2998
|
+
/**
|
|
2999
|
+
* Model that can be converted to Edge in DOT language.
|
|
3000
|
+
* @group Models
|
|
3001
|
+
*/
|
|
3002
|
+
export declare interface EdgeModel extends HasComment, HasAttributes<EdgeAttributeKey>, DotObjectModel<'Edge'> {
|
|
3003
|
+
readonly targets: EdgeTargetTuple;
|
|
3004
|
+
}
|
|
3005
|
+
|
|
3006
|
+
/**
|
|
3007
|
+
* @group Models
|
|
3008
|
+
*/
|
|
3009
|
+
export declare type EdgeTarget = NodeRef | NodeRefGroup;
|
|
3010
|
+
|
|
3011
|
+
/**
|
|
3012
|
+
* @group Models
|
|
3013
|
+
*/
|
|
3014
|
+
export declare type EdgeTargetLike = NodeRefLike | NodeRefGroupLike;
|
|
3015
|
+
|
|
3016
|
+
/**
|
|
3017
|
+
* @group Models
|
|
3018
|
+
*/
|
|
3019
|
+
export declare type EdgeTargetLikeTuple = [
|
|
3020
|
+
from: EdgeTargetLike,
|
|
3021
|
+
to: EdgeTargetLike,
|
|
3022
|
+
...rest: EdgeTargetLike[]
|
|
3023
|
+
];
|
|
3024
|
+
|
|
3025
|
+
/**
|
|
3026
|
+
* @group Models
|
|
3027
|
+
*/
|
|
3028
|
+
export declare type EdgeTargetTuple = [
|
|
3029
|
+
from: EdgeTarget,
|
|
3030
|
+
to: EdgeTarget,
|
|
3031
|
+
...rest: EdgeTarget[]
|
|
3032
|
+
];
|
|
3033
|
+
|
|
3034
|
+
/**
|
|
3035
|
+
* String with Escape Sequences
|
|
3036
|
+
*
|
|
3037
|
+
* A string allowing escape sequences which are replaced according to the context.
|
|
3038
|
+
*
|
|
3039
|
+
* For node attributes, the substring `"\N"` is replaced by the name of the node,
|
|
3040
|
+
* and the substring `"\G"` by the name of the graph.
|
|
3041
|
+
*
|
|
3042
|
+
* For graph or cluster attributes, the substring `"\G"` is replaced by the name of the graph or cluster.
|
|
3043
|
+
*
|
|
3044
|
+
* For edge attributes, the substring `"\E"` is replaced by the name of the edge, the substring `"\G"` is replaced by the name of the graph or cluster,
|
|
3045
|
+
* and the substrings `"\T"` and `"\H"` by the names of the tail and head nodes,
|
|
3046
|
+
* respectively.
|
|
3047
|
+
*
|
|
3048
|
+
* The name of an edge is the string formed from the name of the tail node,
|
|
3049
|
+
* the appropriate edge operator (`"--"` or `"->"`) and the name of the head node.
|
|
3050
|
+
*
|
|
3051
|
+
* In all cases, the substring `"\L"` is replaced by the object's label attribute.
|
|
3052
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/escString/ escString}
|
|
3053
|
+
* @group Attribute Types
|
|
3054
|
+
*/
|
|
3055
|
+
export declare type EscString = string;
|
|
3056
|
+
|
|
3057
|
+
export declare type F<A extends any[], O> = (...args: A) => O;
|
|
3058
|
+
|
|
3059
|
+
export declare const filter: <T>(pred: (item: T) => boolean) => (src: Iterable<T>) => T[];
|
|
3060
|
+
|
|
3061
|
+
/**
|
|
3062
|
+
* @group Models
|
|
3063
|
+
*/
|
|
3064
|
+
export declare interface ForwardRefNode extends Partial<Port> {
|
|
3065
|
+
readonly id: string;
|
|
3066
|
+
}
|
|
3067
|
+
|
|
3068
|
+
/**
|
|
3069
|
+
* Attribute types available for graph.
|
|
3070
|
+
* @group Attribute
|
|
3071
|
+
*/
|
|
3072
|
+
export declare type GraphAttributeKey = GraphAttributeKey.values;
|
|
3073
|
+
|
|
3074
|
+
/** @hidden */
|
|
3075
|
+
export declare namespace GraphAttributeKey {
|
|
3076
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3077
|
+
export interface $values extends $keywords<'Damping' | 'K' | 'URL' | '_background' | 'bb' | 'bgcolor' | 'center' | 'charset' | 'clusterrank' | 'colorscheme' | 'comment' | 'compound' | 'concentrate' | 'defaultdist' | 'dim' | 'dimen' | 'diredgeconstraints' | 'dpi' | 'epsilon' | 'esep' | 'fontcolor' | 'fontname' | 'fontnames' | 'fontpath' | 'fontsize' | 'forcelabels' | 'gradientangle' | 'href' | 'id' | 'imagepath' | 'inputscale' | 'label' | 'label_scheme' | 'labeljust' | 'labelloc' | 'landscape' | 'layerlistsep' | 'layers' | 'layerselect' | 'layersep' | 'layout' | 'levels' | 'levelsgap' | 'lheight' | 'lp' | 'lwidth' | 'margin' | 'maxiter' | 'mclimit' | 'mindist' | 'mode' | 'model' | 'mosek' | 'newrank' | 'nodesep' | 'nojustify' | 'normalize' | 'notranslate' | 'nslimit' | 'nslimit1' | 'ordering' | 'orientation' | 'outputorder' | 'overlap' | 'overlap_scaling' | 'overlap_shrink' | 'pack' | 'packmode' | 'pad' | 'page' | 'pagedir' | 'quadtree' | 'quantum' | 'rankdir' | 'ranksep' | 'ratio' | 'remincross' | 'repulsiveforce' | 'resolution' | 'root' | 'rotate' | 'rotation' | 'scale' | 'searchsize' | 'sep' | 'showboxes' | 'size' | 'smoothing' | 'sortv' | 'splines' | 'start' | 'style' | 'stylesheet' | 'target' | 'truecolor' | 'viewport' | 'voro_margin' | 'xdotversion' | 'class' | 'TBbalance'> {
|
|
3078
|
+
}
|
|
3079
|
+
export interface $exclude extends $keywordsValidation {
|
|
3080
|
+
}
|
|
3081
|
+
}
|
|
3082
|
+
|
|
3083
|
+
/**
|
|
3084
|
+
* Attribute object that can be set to Graph.
|
|
3085
|
+
* @group Models
|
|
3086
|
+
*/
|
|
3087
|
+
export declare type GraphAttributesObject = AttributesObject<GraphAttributeKey>;
|
|
3088
|
+
|
|
3089
|
+
/**
|
|
3090
|
+
* DOT model representing a graph/digraph/subgraph.
|
|
3091
|
+
* @group Models
|
|
3092
|
+
*/
|
|
3093
|
+
export declare interface GraphBaseModel<T extends AttributeKey = AttributeKey> extends HasComment, Attributes<T> {
|
|
3094
|
+
readonly id?: string;
|
|
3095
|
+
readonly attributes: Readonly<GraphCommonAttributes>;
|
|
3096
|
+
/** Node objects in the graph. */
|
|
3097
|
+
readonly nodes: ReadonlyArray<NodeModel>;
|
|
3098
|
+
/** Edge objects in the graph. */
|
|
3099
|
+
readonly edges: ReadonlyArray<EdgeModel>;
|
|
3100
|
+
/** Subgraph objects in the graph. */
|
|
3101
|
+
readonly subgraphs: ReadonlyArray<SubgraphModel>;
|
|
3102
|
+
with(models: Partial<ModelsContext>): void;
|
|
3103
|
+
/**
|
|
3104
|
+
* Add a Node to the graph.
|
|
3105
|
+
*/
|
|
3106
|
+
addNode(node: NodeModel): void;
|
|
3107
|
+
/**
|
|
3108
|
+
* Add Edge to the graph.
|
|
3109
|
+
*/
|
|
3110
|
+
addEdge(edge: EdgeModel): void;
|
|
3111
|
+
/**
|
|
3112
|
+
* Add a Subgraph to the graph.
|
|
3113
|
+
*/
|
|
3114
|
+
addSubgraph(subgraph: SubgraphModel): void;
|
|
3115
|
+
/**
|
|
3116
|
+
* Check if the Node exists in the graph.
|
|
3117
|
+
*/
|
|
3118
|
+
existNode(nodeId: string): boolean;
|
|
3119
|
+
/**
|
|
3120
|
+
* Check if the Edge exists in the graph.
|
|
3121
|
+
*/
|
|
3122
|
+
existEdge(edge: EdgeModel): boolean;
|
|
3123
|
+
/**
|
|
3124
|
+
* Check if the Subgraph exists in the graph.
|
|
3125
|
+
*/
|
|
3126
|
+
existSubgraph(subgraph: SubgraphModel): boolean;
|
|
3127
|
+
/**
|
|
3128
|
+
* Remove Node from the graph.
|
|
3129
|
+
*/
|
|
3130
|
+
removeNode(node: NodeModel | string): void;
|
|
3131
|
+
/**
|
|
3132
|
+
* Remove Edge from the graph.
|
|
3133
|
+
*/
|
|
3134
|
+
removeEdge(edge: EdgeModel): void;
|
|
3135
|
+
/**
|
|
3136
|
+
* Remove Subgraph from the graph.
|
|
3137
|
+
*/
|
|
3138
|
+
removeSubgraph(subgraph: SubgraphModel): void;
|
|
3139
|
+
/**
|
|
3140
|
+
* Create a Node in the graph.
|
|
3141
|
+
*/
|
|
3142
|
+
createNode(id: string, attributes?: NodeAttributesObject): NodeModel;
|
|
3143
|
+
/**
|
|
3144
|
+
* Create a Subgraph and add it to the graph.
|
|
3145
|
+
*
|
|
3146
|
+
* @param id - Subgraph ID
|
|
3147
|
+
* @param attributes - Subgraph attribute object
|
|
3148
|
+
*/
|
|
3149
|
+
createSubgraph(id?: string, attributes?: SubgraphAttributesObject): SubgraphModel;
|
|
3150
|
+
createSubgraph(attributes?: SubgraphAttributesObject): SubgraphModel;
|
|
3151
|
+
/**
|
|
3152
|
+
* Get Subgraph in cluster by specifying id.
|
|
3153
|
+
*
|
|
3154
|
+
* If there is no Subgraph with the specified id in the graph, return undefined.
|
|
3155
|
+
*/
|
|
3156
|
+
getSubgraph(id: string): SubgraphModel | undefined;
|
|
3157
|
+
/**
|
|
3158
|
+
* Get Node in cluster by specifying id.
|
|
3159
|
+
*
|
|
3160
|
+
* @description
|
|
3161
|
+
* If there is no Node with the specified id in the graph, return undefined.
|
|
3162
|
+
*/
|
|
3163
|
+
getNode(id: string): NodeModel | undefined;
|
|
3164
|
+
/** Create Edge and add it to the graph. */
|
|
3165
|
+
createEdge(targets: EdgeTargetLikeTuple, attributes?: EdgeAttributesObject): EdgeModel;
|
|
3166
|
+
/**
|
|
3167
|
+
* Create a subgraph by specifying its id (or get it if it already exists).
|
|
3168
|
+
*
|
|
3169
|
+
* By specifying a callback function, the target subgraph can be received and manipulated as an argument.
|
|
3170
|
+
*
|
|
3171
|
+
* ```ts
|
|
3172
|
+
* const G = digraph('G', (g) => {
|
|
3173
|
+
* // Create a cluster with id as A.
|
|
3174
|
+
* g.subgraph('A', (A) => {
|
|
3175
|
+
* // Create a node with id as A1 in cluster A.
|
|
3176
|
+
* A.node('A1');
|
|
3177
|
+
* });
|
|
3178
|
+
* });
|
|
3179
|
+
*
|
|
3180
|
+
* console.log(toDot(G));
|
|
3181
|
+
* // digraph "G" {
|
|
3182
|
+
* // subgraph "A" {
|
|
3183
|
+
* // "A1";
|
|
3184
|
+
* // }
|
|
3185
|
+
* // }
|
|
3186
|
+
* ```
|
|
3187
|
+
*
|
|
3188
|
+
* @param id Subgraph ID.
|
|
3189
|
+
* @param callback Callbacks for manipulating created or retrieved subgraph.
|
|
3190
|
+
*/
|
|
3191
|
+
subgraph(id: string, callback?: (subgraph: SubgraphModel) => void): SubgraphModel;
|
|
3192
|
+
/**
|
|
3193
|
+
* Create a subgraph (or get one if it already exists) and adapt the attributes.
|
|
3194
|
+
*
|
|
3195
|
+
* By specifying a callback function, the target subgraph can be received and manipulated as an argument.
|
|
3196
|
+
*
|
|
3197
|
+
* ```ts
|
|
3198
|
+
* const G = digraph('G', (g) => {
|
|
3199
|
+
* // Create a cluster with id as A and specifying its attributes.
|
|
3200
|
+
* g.subgraph('A', { [attribute.color]: 'red', [attribute.label]: 'my label' }, (A) => {
|
|
3201
|
+
* // Create a node with id as A1 in cluster A.
|
|
3202
|
+
* A.node('A1');
|
|
3203
|
+
* });
|
|
3204
|
+
* });
|
|
3205
|
+
*
|
|
3206
|
+
* console.log(toDot(G));
|
|
3207
|
+
* // digraph "G" {
|
|
3208
|
+
* // subgraph "A" {
|
|
3209
|
+
* // color = "red";
|
|
3210
|
+
* // label = "my label";
|
|
3211
|
+
* // "A1";
|
|
3212
|
+
* // }
|
|
3213
|
+
* // }
|
|
3214
|
+
* ```
|
|
3215
|
+
*
|
|
3216
|
+
* @param id Subgraph ID.
|
|
3217
|
+
* @param attributes Object of attributes to be adapted to the subgraph.
|
|
3218
|
+
* @param callback Callbacks for manipulating created or retrieved subgraph.
|
|
3219
|
+
*/
|
|
3220
|
+
subgraph(id: string, attributes: SubgraphAttributesObject, callback?: (subgraph: SubgraphModel) => void): SubgraphModel;
|
|
3221
|
+
/**
|
|
3222
|
+
* Create anonymous subgraphs and and adapt the attributes.
|
|
3223
|
+
*
|
|
3224
|
+
* By specifying a callback function, the target subgraph can be received and manipulated as an argument.
|
|
3225
|
+
*
|
|
3226
|
+
* ```ts
|
|
3227
|
+
* const G = digraph('G', (g) => {
|
|
3228
|
+
* // Create a anonymous cluster and specifying its attributes.
|
|
3229
|
+
* g.subgraph({ [attribute.color]: 'red', [attribute.label]: 'my label' }, (A) => {
|
|
3230
|
+
* // Create a node with id as A1 in anonymous cluster.
|
|
3231
|
+
* A.node('A1');
|
|
3232
|
+
* });
|
|
3233
|
+
* });
|
|
3234
|
+
*
|
|
3235
|
+
* console.log(toDot(G));
|
|
3236
|
+
* // digraph "G" {
|
|
3237
|
+
* // subgraph {
|
|
3238
|
+
* // color = "red";
|
|
3239
|
+
* // label = "my label";
|
|
3240
|
+
* // "A1";
|
|
3241
|
+
* // }
|
|
3242
|
+
* // }
|
|
3243
|
+
* ```
|
|
3244
|
+
*
|
|
3245
|
+
* @param attributes Object of attributes to be adapted to the subgraph.
|
|
3246
|
+
* @param callback Callbacks for manipulating created or retrieved subgraph.
|
|
3247
|
+
*/
|
|
3248
|
+
subgraph(attributes: SubgraphAttributesObject, callback?: (subgraph: SubgraphModel) => void): SubgraphModel;
|
|
3249
|
+
/**
|
|
3250
|
+
* Create anonymous subgraphs and manipulate them with callback functions.
|
|
3251
|
+
*
|
|
3252
|
+
* By specifying a callback function, the target subgraph can be received and manipulated as an argument.
|
|
3253
|
+
*
|
|
3254
|
+
* @param callback Callbacks for manipulating created or retrieved subgraph.
|
|
3255
|
+
*/
|
|
3256
|
+
subgraph(callback?: (subgraph: SubgraphModel) => void): SubgraphModel;
|
|
3257
|
+
/**
|
|
3258
|
+
* Create a node by specifying its id (or get it if it already exists).
|
|
3259
|
+
*
|
|
3260
|
+
* By specifying a callback function, the target node can be received and manipulated as an argument.
|
|
3261
|
+
*
|
|
3262
|
+
* ```ts
|
|
3263
|
+
* const G = digraph('G', (g) => {
|
|
3264
|
+
* // Create a node with id as A.
|
|
3265
|
+
* g.node('A');
|
|
3266
|
+
* });
|
|
3267
|
+
*
|
|
3268
|
+
* console.log(toDot(G));
|
|
3269
|
+
* // digraph "G" {
|
|
3270
|
+
* // "A";
|
|
3271
|
+
* // }
|
|
3272
|
+
* ```
|
|
3273
|
+
*
|
|
3274
|
+
* @param id Node ID.
|
|
3275
|
+
* @param callback Callbacks for manipulating created or retrieved node.
|
|
3276
|
+
*/
|
|
3277
|
+
node(id: string, callback?: (node: NodeModel) => void): NodeModel;
|
|
3278
|
+
/**
|
|
3279
|
+
* Create a node (or get one if it already exists) and adapt the attributes.
|
|
3280
|
+
*
|
|
3281
|
+
* By specifying a callback function, the target node can be received and manipulated as an argument.
|
|
3282
|
+
*
|
|
3283
|
+
* ```ts
|
|
3284
|
+
* const G = digraph('G', (g) => {
|
|
3285
|
+
* // Create a node by specifying its id and specifying its attributes.
|
|
3286
|
+
* g.node('A', {
|
|
3287
|
+
* [attribute.color]: 'red',
|
|
3288
|
+
* [attribute.label]: 'my label',
|
|
3289
|
+
* });
|
|
3290
|
+
* });
|
|
3291
|
+
*
|
|
3292
|
+
* console.log(toDot(G));
|
|
3293
|
+
* // digraph "G" {
|
|
3294
|
+
* // "A" [
|
|
3295
|
+
* // color = "red",
|
|
3296
|
+
* // label = "my label",
|
|
3297
|
+
* // ];
|
|
3298
|
+
* // }
|
|
3299
|
+
* ```
|
|
3300
|
+
*
|
|
3301
|
+
* @param id Node ID.
|
|
3302
|
+
* @param attributes Object of attributes to be adapted to the node.
|
|
3303
|
+
* @param callback Callbacks for manipulating created or retrieved node.
|
|
3304
|
+
*/
|
|
3305
|
+
node(id: string, attributes: NodeAttributesObject, callback?: (node: NodeModel) => void): NodeModel;
|
|
3306
|
+
/**
|
|
3307
|
+
* Set a common attribute for the nodes in the graph.
|
|
3308
|
+
*
|
|
3309
|
+
* ```ts
|
|
3310
|
+
* const G = digraph('G', (g) => {
|
|
3311
|
+
* // Set a common attribute for the nodes in the graph.
|
|
3312
|
+
* g.node({
|
|
3313
|
+
* [attribute.color]: 'red',
|
|
3314
|
+
* [attribute.label]: 'my label',
|
|
3315
|
+
* });
|
|
3316
|
+
* });
|
|
3317
|
+
*
|
|
3318
|
+
* console.log(toDot(G));
|
|
3319
|
+
* // digraph "G" {
|
|
3320
|
+
* // node [
|
|
3321
|
+
* // color = "red",
|
|
3322
|
+
* // label = "my label",
|
|
3323
|
+
* // ];
|
|
3324
|
+
* // }
|
|
3325
|
+
* ```
|
|
3326
|
+
*
|
|
3327
|
+
* @param attributes Object of attributes to be adapted to the nodes.
|
|
3328
|
+
*/
|
|
3329
|
+
node(attributes: NodeAttributesObject): void;
|
|
3330
|
+
/**
|
|
3331
|
+
* Create a edge.
|
|
3332
|
+
*
|
|
3333
|
+
* By specifying a callback function, the target edge can be received and manipulated as an argument.
|
|
3334
|
+
*
|
|
3335
|
+
* ```ts
|
|
3336
|
+
* const G = digraph('G', (g) => {
|
|
3337
|
+
* // Create a edge.
|
|
3338
|
+
* g.edge(['a', 'b']);
|
|
3339
|
+
* });
|
|
3340
|
+
*
|
|
3341
|
+
* console.log(toDot(G));
|
|
3342
|
+
* // digraph "G" {
|
|
3343
|
+
* // "a" -> "b";
|
|
3344
|
+
* // }
|
|
3345
|
+
* ```
|
|
3346
|
+
* @param targets Nodes.
|
|
3347
|
+
* @param callback Callbacks for manipulating created or retrieved edge.
|
|
3348
|
+
*/
|
|
3349
|
+
edge(targets: EdgeTargetLikeTuple, callback?: (edge: EdgeModel) => void): EdgeModel;
|
|
3350
|
+
/**
|
|
3351
|
+
* Create a edge and adapt the attributes.
|
|
3352
|
+
*
|
|
3353
|
+
* By specifying a callback function, the target edge can be received and manipulated as an argument.
|
|
3354
|
+
*
|
|
3355
|
+
* ```ts
|
|
3356
|
+
* const G = digraph('G', (g) => {
|
|
3357
|
+
* // Create a edge and specifying its attributes.
|
|
3358
|
+
* g.edge(['a', 'b'], {
|
|
3359
|
+
* [attribute.color]: 'red',
|
|
3360
|
+
* [attribute.label]: 'my label',
|
|
3361
|
+
* });
|
|
3362
|
+
* });
|
|
3363
|
+
*
|
|
3364
|
+
* console.log(toDot(G));
|
|
3365
|
+
* // digraph "G" {
|
|
3366
|
+
* // "a" -> "b" [
|
|
3367
|
+
* // color = "red",
|
|
3368
|
+
* // label = "my label",
|
|
3369
|
+
* // ];
|
|
3370
|
+
* // }
|
|
3371
|
+
* ```
|
|
3372
|
+
*
|
|
3373
|
+
* @param attributes Object of attributes to be adapted to the edge.
|
|
3374
|
+
* @param callback Callbacks for manipulating created or retrieved edge.
|
|
3375
|
+
*/
|
|
3376
|
+
edge(targets: EdgeTargetLikeTuple, attributes: EdgeAttributesObject, callback?: (edge: EdgeModel) => void): EdgeModel;
|
|
3377
|
+
/**
|
|
3378
|
+
* Set a common attribute for the edges in the graph.
|
|
3379
|
+
*
|
|
3380
|
+
*
|
|
3381
|
+
* ```ts
|
|
3382
|
+
* const G = digraph('G', (g) => {
|
|
3383
|
+
* // Set a common attribute for the edges in the graph.
|
|
3384
|
+
* g.edge({
|
|
3385
|
+
* [attribute.color]: 'red',
|
|
3386
|
+
* [attribute.label]: 'my label',
|
|
3387
|
+
* });
|
|
3388
|
+
* });
|
|
3389
|
+
*
|
|
3390
|
+
* console.log(toDot(G));
|
|
3391
|
+
* // digraph "G" {
|
|
3392
|
+
* // edge [
|
|
3393
|
+
* // color = "red",
|
|
3394
|
+
* // label = "my label",
|
|
3395
|
+
* // ];
|
|
3396
|
+
* // }
|
|
3397
|
+
* ```
|
|
3398
|
+
* @param attributes Object of attributes to be adapted to the edges.
|
|
3399
|
+
*/
|
|
3400
|
+
edge(attributes: EdgeAttributesObject): void;
|
|
3401
|
+
/**
|
|
3402
|
+
* Set a common attribute for the graph in the graph.
|
|
3403
|
+
*
|
|
3404
|
+
* ```ts
|
|
3405
|
+
* const G = digraph('G', (g) => {
|
|
3406
|
+
* g.graph({
|
|
3407
|
+
* [attribute.color]: 'red',
|
|
3408
|
+
* [attribute.label]: 'my label',
|
|
3409
|
+
* });
|
|
3410
|
+
* });
|
|
3411
|
+
*
|
|
3412
|
+
* console.log(toDot(G));
|
|
3413
|
+
* // digraph "G" {
|
|
3414
|
+
* // graph [
|
|
3415
|
+
* // color = "red",
|
|
3416
|
+
* // label = "my label",
|
|
3417
|
+
* // ];
|
|
3418
|
+
* // }
|
|
3419
|
+
* ```
|
|
3420
|
+
* @param attributes Object of attributes to be adapted to the graph.
|
|
3421
|
+
*/
|
|
3422
|
+
graph(attributes: SubgraphAttributesObject): void;
|
|
3423
|
+
}
|
|
3424
|
+
|
|
3425
|
+
/**
|
|
3426
|
+
* Cluster common attribute interface.
|
|
3427
|
+
* @group Models
|
|
3428
|
+
*/
|
|
3429
|
+
export declare interface GraphCommonAttributes {
|
|
3430
|
+
/** Manage common attributes of graphs in a graph. */
|
|
3431
|
+
graph: AttributeListModel<'Graph', SubgraphAttributeKey | ClusterSubgraphAttributeKey>;
|
|
3432
|
+
/** Manage common attributes of edges in a graph. */
|
|
3433
|
+
edge: AttributeListModel<'Edge', EdgeAttributeKey>;
|
|
3434
|
+
/** Manage common attributes of nodes in a graph. */
|
|
3435
|
+
node: AttributeListModel<'Node', NodeAttributeKey>;
|
|
3436
|
+
}
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
* @group Models
|
|
3440
|
+
*/
|
|
3441
|
+
export declare interface HasAttributes<T extends AttributeKey> {
|
|
3442
|
+
readonly attributes: AttributesGroupModel<T>;
|
|
3443
|
+
}
|
|
3444
|
+
|
|
3445
|
+
/**
|
|
3446
|
+
* @group Models
|
|
3447
|
+
*/
|
|
3448
|
+
export declare interface HasComment {
|
|
3449
|
+
/** Comments to include when outputting with toDot. */
|
|
3450
|
+
comment?: string;
|
|
3451
|
+
}
|
|
3452
|
+
|
|
3453
|
+
/**
|
|
3454
|
+
* @see {@link https://graphviz.org/doc/info/shapes.html#html HTML-Like Labels}
|
|
3455
|
+
* @group Attribute Types
|
|
3456
|
+
*/
|
|
3457
|
+
export declare type HTMLLikeLabel = `<${string}>`;
|
|
3458
|
+
|
|
3459
|
+
/** @hidden */
|
|
3460
|
+
export declare namespace HTMLLikeLabel {
|
|
3461
|
+
export type TableAttributes = Insensitive<{
|
|
3462
|
+
align?: 'CENTER' | 'LEFT' | 'RIGHT';
|
|
3463
|
+
bgcolor?: Color | ColorList;
|
|
3464
|
+
border?: number;
|
|
3465
|
+
cellborder?: number;
|
|
3466
|
+
cellPadding?: number;
|
|
3467
|
+
cellSpacing?: number;
|
|
3468
|
+
color?: Color | ColorList;
|
|
3469
|
+
columns?: number;
|
|
3470
|
+
fixedSize?: true;
|
|
3471
|
+
gradientAngle?: number;
|
|
3472
|
+
height?: number;
|
|
3473
|
+
href?: string;
|
|
3474
|
+
id?: string;
|
|
3475
|
+
port?: Compass | string;
|
|
3476
|
+
rows?: number;
|
|
3477
|
+
sides?: Side.Combinations;
|
|
3478
|
+
style?: Style;
|
|
3479
|
+
target?: string;
|
|
3480
|
+
title?: string;
|
|
3481
|
+
tooltip?: string;
|
|
3482
|
+
valign?: 'MIDDLE' | 'BOTTOM' | 'TOP';
|
|
3483
|
+
width?: number;
|
|
3484
|
+
}>;
|
|
3485
|
+
export type NoAttributes = Record<string, unknown>;
|
|
3486
|
+
export type TrAttributes = NoAttributes;
|
|
3487
|
+
export type TdAttributes = Insensitive<{
|
|
3488
|
+
align?: 'CENTER' | 'LEFT' | 'RIGHT' | 'TEXT';
|
|
3489
|
+
balign?: 'CENTER' | 'LEFT' | 'RIGHT';
|
|
3490
|
+
bgcolor?: Color | ColorList;
|
|
3491
|
+
border?: number;
|
|
3492
|
+
cellPadding?: number;
|
|
3493
|
+
cellSpacing?: number;
|
|
3494
|
+
color?: Color | ColorList;
|
|
3495
|
+
colspan?: number;
|
|
3496
|
+
fixedSize?: boolean;
|
|
3497
|
+
gradientAngle?: number;
|
|
3498
|
+
height?: number;
|
|
3499
|
+
href?: string;
|
|
3500
|
+
id?: string;
|
|
3501
|
+
port?: Compass | string;
|
|
3502
|
+
rowSpan?: number;
|
|
3503
|
+
sides?: Side.Combinations;
|
|
3504
|
+
style?: Style;
|
|
3505
|
+
target?: string;
|
|
3506
|
+
title?: string;
|
|
3507
|
+
tooltip?: string;
|
|
3508
|
+
valign?: 'MIDDLE' | 'BOTTOM' | 'TOP';
|
|
3509
|
+
width?: number;
|
|
3510
|
+
}>;
|
|
3511
|
+
export type FontAttributes = Insensitive<{
|
|
3512
|
+
color?: Color | ColorList;
|
|
3513
|
+
face?: string;
|
|
3514
|
+
'point-size'?: number;
|
|
3515
|
+
}>;
|
|
3516
|
+
export type BrAttributes = Insensitive<{
|
|
3517
|
+
align?: 'CENTER' | 'LEFT' | 'RIGHT';
|
|
3518
|
+
}>;
|
|
3519
|
+
export type ImgAttributes = Insensitive<{
|
|
3520
|
+
scale?: boolean | 'WIDTH' | 'HEIGHT' | 'BOTH';
|
|
3521
|
+
src?: string;
|
|
3522
|
+
}>;
|
|
3523
|
+
export type IAttributes = NoAttributes;
|
|
3524
|
+
export type BAttributes = NoAttributes;
|
|
3525
|
+
export type UAttributes = NoAttributes;
|
|
3526
|
+
export type OAttributes = NoAttributes;
|
|
3527
|
+
export type SubAttributes = NoAttributes;
|
|
3528
|
+
export type SupAttributes = NoAttributes;
|
|
3529
|
+
export type SAttributes = NoAttributes;
|
|
3530
|
+
export type HrAttributes = NoAttributes;
|
|
3531
|
+
export type VrAttributes = NoAttributes;
|
|
3532
|
+
}
|
|
3533
|
+
|
|
3534
|
+
export declare type Insensitive<T> = T & Insensitive.LowercaseKeys<T> & Insensitive.UppercaseKeys<T>;
|
|
3535
|
+
|
|
3536
|
+
export declare namespace Insensitive {
|
|
3537
|
+
export type LowercaseKeys<T> = {
|
|
3538
|
+
[key in keyof T as Lowercase<string & key>]: T[key];
|
|
3539
|
+
};
|
|
3540
|
+
export type UppercaseKeys<T> = {
|
|
3541
|
+
[key in keyof T as Uppercase<string & key>]: T[key];
|
|
3542
|
+
};
|
|
3543
|
+
}
|
|
3544
|
+
|
|
3545
|
+
/**
|
|
3546
|
+
* Integer number.
|
|
3547
|
+
*
|
|
3548
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/int/ int}
|
|
3549
|
+
* @group Attribute Types
|
|
3550
|
+
*/
|
|
3551
|
+
export declare type Int = number;
|
|
3552
|
+
|
|
3553
|
+
export declare type IO<I, O> = F<[I], O>;
|
|
3554
|
+
|
|
3555
|
+
/** @hidden */
|
|
3556
|
+
export declare function isCompass(c: string): c is Compass;
|
|
3557
|
+
|
|
3558
|
+
/** @hidden */
|
|
3559
|
+
export declare function isForwardRefNode(object: unknown): object is ForwardRefNode;
|
|
3560
|
+
|
|
3561
|
+
/** @hidden */
|
|
3562
|
+
export declare function isNodeModel(object: unknown): object is NodeModel;
|
|
3563
|
+
|
|
3564
|
+
/** @hidden */
|
|
3565
|
+
export declare function isNodeRef(node: unknown): node is NodeRef;
|
|
3566
|
+
|
|
3567
|
+
/** @hidden */
|
|
3568
|
+
export declare function isNodeRefGroupLike(target: NodeRefLike | NodeRefGroupLike): target is NodeRefGroupLike;
|
|
3569
|
+
|
|
3570
|
+
/** @hidden */
|
|
3571
|
+
export declare function isNodeRefLike(node: unknown): node is NodeRefLike;
|
|
3572
|
+
|
|
3573
|
+
/**
|
|
3574
|
+
* list of strings separated by characters from the layersep attribute (by default, colons, tabs or spaces),
|
|
3575
|
+
* defining layer names and implicitly numbered 1,2,…
|
|
3576
|
+
*
|
|
3577
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/layerList/ layerList}
|
|
3578
|
+
* @group Attribute Types
|
|
3579
|
+
*/
|
|
3580
|
+
export declare type LayerList = string;
|
|
3581
|
+
|
|
3582
|
+
/**
|
|
3583
|
+
* specifies a list of layers defined by the layers attribute.
|
|
3584
|
+
*
|
|
3585
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/layerRange/ layerRange}
|
|
3586
|
+
* @group Attribute Types
|
|
3587
|
+
*/
|
|
3588
|
+
export declare type LayerRange = string;
|
|
3589
|
+
|
|
3590
|
+
/**
|
|
3591
|
+
* An escString or an HTML label.
|
|
3592
|
+
*
|
|
3593
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/lblString/ lblString}
|
|
3594
|
+
* @group Attribute Types
|
|
3595
|
+
*/
|
|
3596
|
+
export declare type LblString = HTMLLikeLabel | EscString;
|
|
3597
|
+
|
|
3598
|
+
export declare const map: <T, O>(selector: (item: T) => O) => (src: Iterable<T>) => O[];
|
|
3599
|
+
|
|
3600
|
+
/**
|
|
3601
|
+
* @group Models Context
|
|
3602
|
+
*/
|
|
3603
|
+
export declare interface ModelsContext {
|
|
3604
|
+
Graph: RootGraphConstructor;
|
|
3605
|
+
Digraph: RootGraphConstructor;
|
|
3606
|
+
Subgraph: SubgraphConstructor;
|
|
3607
|
+
Node: NodeConstructor;
|
|
3608
|
+
Edge: EdgeConstructor;
|
|
3609
|
+
}
|
|
3610
|
+
|
|
3611
|
+
/**
|
|
3612
|
+
* Attribute types available for nodes.
|
|
3613
|
+
* @group Attribute
|
|
3614
|
+
*/
|
|
3615
|
+
export declare type NodeAttributeKey = NodeAttributeKey.values;
|
|
3616
|
+
|
|
3617
|
+
/** @hidden */
|
|
3618
|
+
export declare namespace NodeAttributeKey {
|
|
3619
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3620
|
+
export interface $values extends $keywords<'URL' | 'area' | 'color' | 'colorscheme' | 'comment' | 'distortion' | 'fillcolor' | 'fixedsize' | 'fontcolor' | 'fontname' | 'fontsize' | 'gradientangle' | 'group' | 'height' | 'href' | 'id' | 'image' | 'imagepos' | 'imagescale' | 'label' | 'labelloc' | 'layer' | 'margin' | 'nojustify' | 'ordering' | 'orientation' | 'penwidth' | 'peripheries' | 'pin' | 'pos' | 'rects' | 'regular' | 'root' | 'samplepoints' | 'shape' | 'shapefile' | 'showboxes' | 'sides' | 'skew' | 'sortv' | 'style' | 'target' | 'tooltip' | 'vertices' | 'width' | 'xlabel' | 'xlp' | 'z' | 'class'> {
|
|
3621
|
+
}
|
|
3622
|
+
export interface $exclude extends $keywordsValidation {
|
|
3623
|
+
}
|
|
3624
|
+
}
|
|
3625
|
+
|
|
3626
|
+
/**
|
|
3627
|
+
* Attribute object that can be set to Node.
|
|
3628
|
+
* @group Models
|
|
3629
|
+
*/
|
|
3630
|
+
export declare type NodeAttributesObject = AttributesObject<NodeAttributeKey>;
|
|
3631
|
+
|
|
3632
|
+
/**
|
|
3633
|
+
* @group Models
|
|
3634
|
+
*/
|
|
3635
|
+
export declare interface NodeConstructor {
|
|
3636
|
+
new (id: string, attributes?: NodeAttributesObject): NodeModel;
|
|
3637
|
+
new (...args: any[]): NodeModel;
|
|
3638
|
+
}
|
|
3639
|
+
|
|
3640
|
+
/**
|
|
3641
|
+
* Model that can be converted to Node in DOT language.
|
|
3642
|
+
* @group Models
|
|
3643
|
+
*/
|
|
3644
|
+
export declare interface NodeModel extends HasComment, HasAttributes<NodeAttributeKey>, DotObjectModel<'Node'> {
|
|
3645
|
+
/** ID of the node */
|
|
3646
|
+
readonly id: string;
|
|
3647
|
+
/** Returns ForwardRefNode with port and compass specified. */
|
|
3648
|
+
port(port: string | Partial<Port>): ForwardRefNode;
|
|
3649
|
+
}
|
|
3650
|
+
|
|
3651
|
+
/**
|
|
3652
|
+
* Objects that can be Edge destinations satisfy this interface.
|
|
3653
|
+
* @group Models
|
|
3654
|
+
*/
|
|
3655
|
+
export declare type NodeRef = NodeModel | ForwardRefNode;
|
|
3656
|
+
|
|
3657
|
+
/**
|
|
3658
|
+
* @group Models
|
|
3659
|
+
*/
|
|
3660
|
+
export declare type NodeRefGroup = NodeRef[];
|
|
3661
|
+
|
|
3662
|
+
/**
|
|
3663
|
+
* @group Models
|
|
3664
|
+
*/
|
|
3665
|
+
export declare type NodeRefGroupLike = NodeRefLike[];
|
|
3666
|
+
|
|
3667
|
+
/**
|
|
3668
|
+
* string or an object implementing EdgeTarget.
|
|
3669
|
+
* @group Models
|
|
3670
|
+
*/
|
|
3671
|
+
export declare type NodeRefLike = NodeRef | string;
|
|
3672
|
+
|
|
3673
|
+
/**
|
|
3674
|
+
* These specify the order in which nodes and edges are drawn in concrete output.
|
|
3675
|
+
*
|
|
3676
|
+
* - The default `"breadthfirst"` is the simplest, but when the graph layout does not avoid edge-node overlap, this mode will sometimes have edges drawn over nodes and sometimes on top of nodes.
|
|
3677
|
+
* - If the mode `"nodesfirst"` is chosen, all nodes are drawn first, followed by the edges. This guarantees an edge-node overlap will not be mistaken for an edge ending at a node.
|
|
3678
|
+
* - On the other hand, usually for aesthetic reasons, it may be desirable that all edges appear beneath nodes, even if the resulting drawing is ambiguous. This can be achieved by choosing `"edgesfirst"`.
|
|
3679
|
+
*
|
|
3680
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/outputMode/ outputMode}
|
|
3681
|
+
* @group Attribute Types
|
|
3682
|
+
*/
|
|
3683
|
+
export declare type OutputMode = OutputMode.values;
|
|
3684
|
+
|
|
3685
|
+
/** @hidden */
|
|
3686
|
+
export declare namespace OutputMode {
|
|
3687
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3688
|
+
export interface $values extends $keywords<'breadthfirst' | 'nodesfirst' | 'edgesfirst'> {
|
|
3689
|
+
}
|
|
3690
|
+
export interface $exclude extends $keywordsValidation {
|
|
3691
|
+
}
|
|
3692
|
+
}
|
|
3693
|
+
|
|
3694
|
+
/**
|
|
3695
|
+
* @see {@link https://graphviz.org/docs/attr-types/packMode/ packMode}
|
|
3696
|
+
* @group Attribute Types
|
|
3697
|
+
*/
|
|
3698
|
+
export declare type PackMode = keyof PickMode.$values | `array${string}`;
|
|
3699
|
+
|
|
3700
|
+
/**
|
|
3701
|
+
* Page Direction
|
|
3702
|
+
*
|
|
3703
|
+
* @see {@link https://graphviz.org/docs/attr-types/pagedir/ pagedir}
|
|
3704
|
+
* @group Attribute Types
|
|
3705
|
+
*/
|
|
3706
|
+
export declare type Pagedir = `${Pagedir.TB}${Pagedir.RL}`;
|
|
3707
|
+
|
|
3708
|
+
/** @hidden */
|
|
3709
|
+
export declare namespace Pagedir {
|
|
3710
|
+
export type TB = Side.T | Side.B;
|
|
3711
|
+
export type RL = Side.R | Side.L;
|
|
3712
|
+
}
|
|
3713
|
+
|
|
3714
|
+
/** @hidden */
|
|
3715
|
+
export declare namespace PickMode {
|
|
3716
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3717
|
+
export interface $values extends $keywords<'node' | 'clust' | 'graph'> {
|
|
3718
|
+
}
|
|
3719
|
+
export interface $exclude extends $keywordsValidation {
|
|
3720
|
+
}
|
|
3721
|
+
}
|
|
3722
|
+
|
|
3723
|
+
export declare function pipe<I extends any[], O>(f0: F<I, O>): F<I, O>;
|
|
3724
|
+
|
|
3725
|
+
export declare function pipe<I extends any[], T1, O>(f0: F<I, T1>, f1: IO<T1, O>): F<I, O>;
|
|
3726
|
+
|
|
3727
|
+
export declare function pipe<I extends any[], T1, T2, O>(f0: F<I, T1>, f1: IO<T1, T2>, f2: IO<T2, O>): F<I, O>;
|
|
3728
|
+
|
|
3729
|
+
export declare function pipe<I extends any[], T1, T2, T3, O>(f0: F<I, T1>, f1: IO<T1, T2>, f2: IO<T2, T3>, f3: IO<T3, O>): F<I, O>;
|
|
3730
|
+
|
|
3731
|
+
export declare function pipe<I extends any[], T1, T2, T3, T4, O>(f0: F<I, T1>, f1: IO<T1, T2>, f2: IO<T2, T3>, f3: IO<T3, T4>, f4: IO<T4, O>): F<I, O>;
|
|
3732
|
+
|
|
3733
|
+
/**
|
|
3734
|
+
* `"%f,%f('!')?"` representing the point (x,y).
|
|
3735
|
+
*
|
|
3736
|
+
* The optional `'!'` indicates the node position should not change (input-only).
|
|
3737
|
+
*
|
|
3738
|
+
* If dim=3, point may also have the format `"%f,%f,%f('!')?"` to represent the point (x,y,z).
|
|
3739
|
+
* @group Attribute Types
|
|
3740
|
+
*/
|
|
3741
|
+
export declare type Point = Point.position | `${Point.position}!`;
|
|
3742
|
+
|
|
3743
|
+
/** @hidden */
|
|
3744
|
+
export declare namespace Point {
|
|
3745
|
+
export type position = `${Double},${Double}` | `${Double},${Double},${Double}` | `${Double},${Double},${Double},${Double},${Double}` | `${Double},${Double},${Double},${Double},${Double},${Double}` | `${Double},${Double},${Double},${Double},${Double},${Double},${Double}` | `${Double},${Double},${Double},${Double},${Double},${Double},${Double},${Double}` | `${Double},${Double},${Double},${Double},${Double},${Double},${Double},${Double},${Double}` | `${Double},${Double},${Double},${Double},${Double},${Double},${Double},${Double},${Double},${number}`;
|
|
3746
|
+
}
|
|
3747
|
+
|
|
3748
|
+
/**
|
|
3749
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/pointList/ pointList}
|
|
3750
|
+
* @group Attribute Types
|
|
3751
|
+
*/
|
|
3752
|
+
export declare type PointList = Point | `${Point} ${Point}` | `${Point} ${Point} ${Point}` | `${Point} ${Point} ${Point} ${Point}`;
|
|
3753
|
+
|
|
3754
|
+
/**
|
|
3755
|
+
* Port on an edge node.
|
|
3756
|
+
* @group Models
|
|
3757
|
+
*/
|
|
3758
|
+
export declare interface Port {
|
|
3759
|
+
port: string;
|
|
3760
|
+
compass: Compass;
|
|
3761
|
+
}
|
|
3762
|
+
|
|
3763
|
+
/**
|
|
3764
|
+
* Port Position
|
|
3765
|
+
*
|
|
3766
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/portPos/ portPos}
|
|
3767
|
+
* @group Attribute Types
|
|
3768
|
+
*/
|
|
3769
|
+
export declare type PortPos = `${string}:${Compass}` | Compass;
|
|
3770
|
+
|
|
3771
|
+
/**
|
|
3772
|
+
* Using `"fast"` gives about a 2-4 times overall speedup compared with `"normal"`,
|
|
3773
|
+
* though layout quality can suffer a little.
|
|
3774
|
+
*
|
|
3775
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/quadType/ quadType}
|
|
3776
|
+
* @group Attribute Types
|
|
3777
|
+
*/
|
|
3778
|
+
export declare type QuadType = QuadType.values;
|
|
3779
|
+
|
|
3780
|
+
/** @hidden */
|
|
3781
|
+
export declare namespace QuadType {
|
|
3782
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3783
|
+
export interface $values extends $keywords<'normal' | 'fast' | 'none'> {
|
|
3784
|
+
}
|
|
3785
|
+
export interface $exclude extends $keywordsValidation {
|
|
3786
|
+
}
|
|
3787
|
+
}
|
|
3788
|
+
|
|
3789
|
+
/**
|
|
3790
|
+
* Rank Direction
|
|
3791
|
+
*
|
|
3792
|
+
* Corresponding to directed graphs drawn from top to bottom,
|
|
3793
|
+
* from left to right, from bottom to top, and from right to left, respectively.
|
|
3794
|
+
*
|
|
3795
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/rankdir/ rankdir}
|
|
3796
|
+
* @group Attribute Types
|
|
3797
|
+
*/
|
|
3798
|
+
export declare type Rankdir = 'TB' | 'BT' | 'LR' | 'RL';
|
|
3799
|
+
|
|
3800
|
+
/**
|
|
3801
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/rankType/ rankType}
|
|
3802
|
+
* @group Attribute Types
|
|
3803
|
+
*/
|
|
3804
|
+
export declare type RankType = RankType.values;
|
|
3805
|
+
|
|
3806
|
+
/** @hidden */
|
|
3807
|
+
export declare namespace RankType {
|
|
3808
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3809
|
+
export interface $values extends $keywords<'same' | 'min' | 'source' | 'max' | 'sink'> {
|
|
3810
|
+
}
|
|
3811
|
+
export interface $exclude extends $keywordsValidation {
|
|
3812
|
+
}
|
|
3813
|
+
}
|
|
3814
|
+
|
|
3815
|
+
/**
|
|
3816
|
+
* `"%f,%f,%f,%f"`
|
|
3817
|
+
*
|
|
3818
|
+
* The rectangle `llx,lly,urx,ury` gives the coordinates, in points,
|
|
3819
|
+
* of the lower-left corner `(llx,lly)` and the upper-right corner `(urx,ury)`.
|
|
3820
|
+
*
|
|
3821
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/rect/ rect}
|
|
3822
|
+
* @group Attribute Types
|
|
3823
|
+
*/
|
|
3824
|
+
export declare type Rect = `${Double},${Double},${Double},${Double}`;
|
|
3825
|
+
|
|
3826
|
+
/**
|
|
3827
|
+
* @group Models
|
|
3828
|
+
*/
|
|
3829
|
+
export declare interface RootGraphConstructor {
|
|
3830
|
+
new (id?: string, attributes?: GraphAttributesObject): RootGraphModel;
|
|
3831
|
+
new (id?: string, strict?: boolean, attributes?: GraphAttributesObject): RootGraphModel;
|
|
3832
|
+
new (strict?: boolean, attributes?: GraphAttributesObject): RootGraphModel;
|
|
3833
|
+
new (attributes?: GraphAttributesObject): RootGraphModel;
|
|
3834
|
+
new (...args: any[]): RootGraphModel;
|
|
3835
|
+
}
|
|
3836
|
+
|
|
3837
|
+
/**
|
|
3838
|
+
* DOT model representing a root graphs(digraph and graph).
|
|
3839
|
+
* @group Models
|
|
3840
|
+
*/
|
|
3841
|
+
export declare interface RootGraphModel extends GraphBaseModel<GraphAttributeKey>, DotObjectModel<'Graph'> {
|
|
3842
|
+
directed: boolean;
|
|
3843
|
+
/**
|
|
3844
|
+
* Strict mode.
|
|
3845
|
+
*
|
|
3846
|
+
* @description
|
|
3847
|
+
* A graph may also be described as strict.
|
|
3848
|
+
* This forbids the creation of multi-edges, i.e., there can be at most one edge with a given tail node and head node in the directed case.
|
|
3849
|
+
* For undirected graphs, there can be at most one edge connected to the same two nodes.
|
|
3850
|
+
* Subsequent edge statements using the same two nodes will identify the edge with the previously defined one and apply any attributes given in the edge statement.
|
|
3851
|
+
*/
|
|
3852
|
+
strict: boolean;
|
|
3853
|
+
}
|
|
3854
|
+
|
|
3855
|
+
/**
|
|
3856
|
+
* @group Models Context
|
|
3857
|
+
*/
|
|
3858
|
+
export declare const RootModelsContext: ModelsContext;
|
|
3859
|
+
|
|
3860
|
+
/**
|
|
3861
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/shape/ shape}
|
|
3862
|
+
* @group Attribute Types
|
|
3863
|
+
*/
|
|
3864
|
+
export declare type Shape = string;
|
|
3865
|
+
|
|
3866
|
+
export declare namespace Side {
|
|
3867
|
+
export type T = 'T';
|
|
3868
|
+
export type B = 'B';
|
|
3869
|
+
export type R = 'R';
|
|
3870
|
+
export type L = 'L';
|
|
3871
|
+
export type Combinations = T | B | R | L | `${T}${B}` | `${T}${R}` | `${T}${L}` | `${B}${R}` | `${B}${L}` | `${R}${L}` | `${T}${B}${R}` | `${T}${B}${L}` | `${T}${R}${L}` | `${B}${R}${L}` | `${T}${B}${R}${L}`;
|
|
3872
|
+
}
|
|
3873
|
+
|
|
3874
|
+
/**
|
|
3875
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/smoothType/ smoothType}
|
|
3876
|
+
* @group Attribute Types
|
|
3877
|
+
*/
|
|
3878
|
+
export declare type SmoothType = SmoothType.values;
|
|
3879
|
+
|
|
3880
|
+
/** @hidden */
|
|
3881
|
+
export declare namespace SmoothType {
|
|
3882
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3883
|
+
export interface $values extends $keywords<'none' | 'avg_dist' | 'graph_dist' | 'power_dist' | 'rng' | 'spring' | 'triangle'> {
|
|
3884
|
+
}
|
|
3885
|
+
export interface $exclude extends $keywordsValidation {
|
|
3886
|
+
}
|
|
3887
|
+
}
|
|
3888
|
+
|
|
3889
|
+
/**
|
|
3890
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/splineType/ splineType}
|
|
3891
|
+
* @group Attribute Types
|
|
3892
|
+
*/
|
|
3893
|
+
export declare type SplineType = SplineType.spline | string;
|
|
3894
|
+
|
|
3895
|
+
/** @hidden */
|
|
3896
|
+
export declare namespace SplineType {
|
|
3897
|
+
export type prefix = endp | startp | `${endp}${startp}` | '';
|
|
3898
|
+
export type spline = `${prefix}point ${triple}`;
|
|
3899
|
+
export type triple = `${Point} ${Point} ${Point}`;
|
|
3900
|
+
export type endp = `e,${Double},${Double} `;
|
|
3901
|
+
export type startp = `s,${Double},${Double} `;
|
|
3902
|
+
}
|
|
3903
|
+
|
|
3904
|
+
/**
|
|
3905
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/startType/ startType}
|
|
3906
|
+
* @group Attribute Types
|
|
3907
|
+
*/
|
|
3908
|
+
export declare type StartType = `${StartType.style}${StartType.seed}`;
|
|
3909
|
+
|
|
3910
|
+
/** @hidden */
|
|
3911
|
+
export declare namespace StartType {
|
|
3912
|
+
export type style = Exclude<keyof $style, keyof $exclude>;
|
|
3913
|
+
export interface $style extends $keywords<'regular' | 'self' | 'random'> {
|
|
3914
|
+
}
|
|
3915
|
+
export type seed = number;
|
|
3916
|
+
export interface $exclude extends $keywordsValidation {
|
|
3917
|
+
}
|
|
3918
|
+
}
|
|
3919
|
+
|
|
3920
|
+
/**
|
|
3921
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/style/ style}
|
|
3922
|
+
* @group Attribute Types
|
|
3923
|
+
*/
|
|
3924
|
+
export declare type Style = Style.styleItem | `${Style.styleItem},${Style.styleItem}` | `${Style.styleItem},${Style.styleItem},${Style.styleItem}` | `${Style.styleItem},${Style.styleItem},${Style.styleItem},${Style.styleItem}`;
|
|
3925
|
+
|
|
3926
|
+
/** @hidden */
|
|
3927
|
+
export declare namespace Style {
|
|
3928
|
+
export type styleItem = Exclude<keyof $styleItem, keyof $exclude>;
|
|
3929
|
+
export interface $styleItem extends $keywords<'dashed' | 'dotted' | 'solid' | 'invis' | 'bold' | 'tapered' | 'filled' | 'striped' | 'wedged' | 'diagonals' | 'rounded' | 'filled' | 'striped' | 'rounded' | 'radial'> {
|
|
3930
|
+
}
|
|
3931
|
+
export interface $exclude extends $keywordsValidation {
|
|
3932
|
+
}
|
|
3933
|
+
}
|
|
3934
|
+
|
|
3935
|
+
/**
|
|
3936
|
+
* Attribute types available for subgraph.
|
|
3937
|
+
* @group Attribute
|
|
3938
|
+
*/
|
|
3939
|
+
export declare type SubgraphAttributeKey = SubgraphAttributeKey.values;
|
|
3940
|
+
|
|
3941
|
+
/** @hidden */
|
|
3942
|
+
export declare namespace SubgraphAttributeKey {
|
|
3943
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3944
|
+
export interface $values extends $keywords<'rank'> {
|
|
3945
|
+
}
|
|
3946
|
+
export interface $exclude extends $keywordsValidation {
|
|
3947
|
+
}
|
|
3948
|
+
}
|
|
3949
|
+
|
|
3950
|
+
/**
|
|
3951
|
+
* Attribute object that can be set to Subgraph.
|
|
3952
|
+
* @group Models
|
|
3953
|
+
*/
|
|
3954
|
+
export declare type SubgraphAttributesObject = AttributesObject<ClusterSubgraphAttributeKey | SubgraphAttributeKey>;
|
|
3955
|
+
|
|
3956
|
+
/**
|
|
3957
|
+
* @group Models
|
|
3958
|
+
*/
|
|
3959
|
+
export declare interface SubgraphConstructor {
|
|
3960
|
+
new (id?: string, attributes?: SubgraphAttributesObject): SubgraphModel;
|
|
3961
|
+
new (attributes?: SubgraphAttributesObject): SubgraphModel;
|
|
3962
|
+
new (...args: any[]): SubgraphModel;
|
|
3963
|
+
}
|
|
3964
|
+
|
|
3965
|
+
/**
|
|
3966
|
+
* DOT model representing a subgraph.
|
|
3967
|
+
* @group Models
|
|
3968
|
+
*/
|
|
3969
|
+
export declare interface SubgraphModel extends GraphBaseModel<SubgraphAttributeKey | ClusterSubgraphAttributeKey>, DotObjectModel<'Subgraph'> {
|
|
3970
|
+
/** Determines whether the Subgraph is a SubgraphCluster. */
|
|
3971
|
+
isSubgraphCluster(): boolean;
|
|
3972
|
+
}
|
|
3973
|
+
|
|
3974
|
+
/**
|
|
3975
|
+
* Which rank to move floating (loose) nodes to
|
|
3976
|
+
*
|
|
3977
|
+
* Valid options:
|
|
3978
|
+
* - "min": Move floating (loose) nodes to minimum rank.
|
|
3979
|
+
* - "max": Move floating (loose) nodes to maximum rank.
|
|
3980
|
+
* - Otherwise, floating nodes are placed anywhere.
|
|
3981
|
+
*
|
|
3982
|
+
* Despite the name TBbalance ("Top-Bottom Balance"), this also works with left-right ranks, e.g. rankdir=LR.
|
|
3983
|
+
*
|
|
3984
|
+
* @see {@link https://graphviz.org/docs/attrs/TBbalance/ TBbalance}
|
|
3985
|
+
* @group Attribute Types
|
|
3986
|
+
*/
|
|
3987
|
+
export declare type TBbalanceType = TBbalanceType.values;
|
|
3988
|
+
|
|
3989
|
+
/** @hidden */
|
|
3990
|
+
export declare namespace TBbalanceType {
|
|
3991
|
+
export type values = Exclude<keyof $values, keyof $exclude | symbol | number>;
|
|
3992
|
+
export interface $values extends $keywords<'min' | 'max'> {
|
|
3993
|
+
}
|
|
3994
|
+
export interface $exclude extends $keywordsValidation {
|
|
3995
|
+
}
|
|
3996
|
+
}
|
|
3997
|
+
|
|
3998
|
+
/** @hidden */
|
|
3999
|
+
export declare function toNodeRef(target: NodeRefLike): NodeRef;
|
|
4000
|
+
|
|
4001
|
+
/** @hidden */
|
|
4002
|
+
export declare function toNodeRefGroup(targets: NodeRefGroupLike): NodeRefGroup;
|
|
4003
|
+
|
|
4004
|
+
/**
|
|
4005
|
+
* @see {@link https://graphviz.gitlab.io/docs/attr-types/viewPort/ viewPort}
|
|
4006
|
+
* @group Attribute Types
|
|
4007
|
+
*/
|
|
4008
|
+
export declare type ViewPort = `${Double},${Double},${Double},${Double},${Double}` | `${Double},${Double},${Double},${string}`;
|
|
4009
|
+
|
|
4010
|
+
export { }
|