@ts-graphviz/common 2.1.5 → 3.0.0

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/lib/common.d.ts CHANGED
@@ -79,12 +79,18 @@ export declare namespace Attribute {
79
79
  * On each iteration, a nodes movement is limited to this factor of its potential motion.
80
80
  * By being less than 1.0, the system tends to ``cool'', thereby preventing cycling.
81
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
82
+ * @see {@link https://graphviz.org/docs/attrs/Damping/ Node, Edge and Graph Attributes#Damping} * | Key | Value |
83
+ * | --- | --- |
84
+
85
+ *
86
+ * | Key | Value |
87
+ * | --- | --- |
88
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
89
+ * | default | 0.99 |
90
+ * | minimum | 0 |
91
+ * | notes | neato only |
92
+ * | used by | G |
93
+ *
88
94
  * @category Attribute
89
95
  */
90
96
  Damping: 'Damping';
@@ -93,12 +99,18 @@ export declare namespace Attribute {
93
99
  * It roughly corresponds to an ideal edge length (in inches), in that increasing K tends to increase the distance between nodes.
94
100
  * Note that the edge attribute {@link len} can be used to override this value for adjacent nodes.
95
101
  *
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
+ * @see {@link https://graphviz.org/docs/attrs/K/ Node, Edge and Graph Attributes#K} * | Key | Value |
103
+ * | --- | --- |
104
+
105
+ *
106
+ * | Key | Value |
107
+ * | --- | --- |
108
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
109
+ * | default | 0.3 |
110
+ * | minimum | 0 |
111
+ * | used by | GC |
112
+ * | notes | sfdp, fdp only |
113
+ *
102
114
  * @category Attribute
103
115
  */
104
116
  K: 'K';
@@ -121,11 +133,17 @@ export declare namespace Attribute {
121
133
  * Note that, for edges, the attributes {@link headURL}, {@link tailURL}, {@link labelURL} and {@link edgeURL} allow control of various parts of an edge.
122
134
  * Also note that, if active areas of two edges overlap, it is unspecified which area dominates.
123
135
  *
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
136
+ * @see {@link https://graphviz.org/docs/attrs/URL/ Node, Edge and Graph Attributes#URL} * | Key | Value |
137
+ * | --- | --- |
138
+
139
+ *
140
+ * | Key | Value |
141
+ * | --- | --- |
142
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
143
+ * | default | <none> |
144
+ * | used by | ENGC |
145
+ * | notes | svg, postscript, map only |
146
+ *
129
147
  * @category Attribute
130
148
  */
131
149
  URL: 'URL';
@@ -134,22 +152,35 @@ export declare namespace Attribute {
134
152
  * During rendering, the canvas is first filled as described in the {@link bgcolor} attribute.
135
153
  * Then, if _background is defined, the graphics operations described in the string are performed on the canvas.
136
154
  *
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
155
+ * @see {@link https://graphviz.org/docs/attrs/_background/ Node, Edge and Graph Attributes#_background} * | Key | Value |
156
+ * | --- | --- |
157
+
158
+ *
159
+ * | Key | Value |
160
+ * | --- | --- |
161
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
162
+ * | default | <none> |
163
+ * | used by | G |
164
+ * | notes | xdot only |
165
+ *
141
166
  * @category Attribute
142
167
  */
143
168
  _background: '_background';
144
169
  /**
145
170
  * Indicates the preferred area for a node or empty cluster when laid out by patchwork.
146
171
  *
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
172
+ * @see {@link https://graphviz.org/docs/attrs/area/ Node, Edge and Graph Attributes#area} * | Key | Value |
173
+ * | --- | --- |
174
+
175
+ *
176
+ * | Key | Value |
177
+ * | --- | --- |
178
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
179
+ * | default | 1 |
180
+ * | minimum | >0 |
181
+ * | used by | NC |
182
+ * | notes | patchwork only |
183
+ *
153
184
  * @category Attribute
154
185
  */
155
186
  area: 'area';
@@ -159,21 +190,33 @@ export declare namespace Attribute {
159
190
  *
160
191
  * See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
161
192
  *
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
193
+ * @see {@link https://graphviz.org/docs/attrs/arrowhead/ Node, Edge and Graph Attributes#arrowhead} * | Key | Value |
194
+ * | --- | --- |
195
+
196
+ *
197
+ * | Key | Value |
198
+ * | --- | --- |
199
+ * | type | {@link https://graphviz.org/docs/attr-types/arrowType/ arrowType} |
200
+ * | default | normal |
201
+ * | used by | E |
202
+ *
166
203
  * @category Attribute
167
204
  */
168
205
  arrowhead: 'arrowhead';
169
206
  /**
170
207
  * Multiplicative scale factor for arrowheads.
171
208
  *
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
209
+ * @see {@link https://graphviz.org/docs/attrs/arrowsize/ Node, Edge and Graph Attributes#arrowsize} * | Key | Value |
210
+ * | --- | --- |
211
+
212
+ *
213
+ * | Key | Value |
214
+ * | --- | --- |
215
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
216
+ * | default | 1 |
217
+ * | minimum | 0 |
218
+ * | used by | E |
219
+ *
177
220
  * @category Attribute
178
221
  */
179
222
  arrowsize: 'arrowsize';
@@ -184,18 +227,25 @@ export declare namespace Attribute {
184
227
  * See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
185
228
  *
186
229
  * @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
230
+ *
231
+ * | Key | Value |
232
+ * | --- | --- |
233
+ * | type | {@link https://graphviz.org/docs/attr-types/arrowType/ arrowType} |
234
+ * | default | normal |
235
+ * | used by | E |
236
+ *
190
237
  * @category Attribute
191
238
  */
192
239
  arrowtail: 'arrowtail';
193
240
  /**
194
241
  * Bounding box of drawing in points.
195
242
  *
196
- * @graphvizType {@link https://graphviz.org/docs/attr-types/rect/ rect}
197
- * @graphvizNotes write only
198
- * @graphvizUsedBy G
243
+ * | Key | Value |
244
+ * | --- | --- |
245
+ * | type | {@link https://graphviz.org/docs/attr-types/rect/ rect} |
246
+ * | used by | G |
247
+ * | notes | write only |
248
+ *
199
249
  * @category Attribute
200
250
  */
201
251
  bb: 'bb';
@@ -205,9 +255,13 @@ export declare namespace Attribute {
205
255
  * If a cluster has a filled {@link style}, the cluster's {@link fillcolor} will overlay the background color.
206
256
  *
207
257
  * @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
258
+ *
259
+ * | Key | Value |
260
+ * | --- | --- |
261
+ * | type | {@link https://graphviz.org/docs/attr-types/color/ color}/{@link https://graphviz.org/docs/attr-types/color/List colorList} |
262
+ * | default | <none> |
263
+ * | used by | G |
264
+ *
211
265
  * @category Attribute
212
266
  */
213
267
  bgcolor: 'bgcolor';
@@ -215,9 +269,13 @@ export declare namespace Attribute {
215
269
  * If true, the drawing is centered in the output canvas.
216
270
  *
217
271
  * @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
272
+ *
273
+ * | Key | Value |
274
+ * | --- | --- |
275
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
276
+ * | default | FALSE |
277
+ * | used by | G |
278
+ *
221
279
  * @category Attribute
222
280
  */
223
281
  center: 'center';
@@ -228,9 +286,12 @@ export declare namespace Attribute {
228
286
  * Note that if the character encoding used in the input does not match the charset value, the resulting output may be very strange.
229
287
  *
230
288
  * @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
289
+ *
290
+ * | Key | Value |
291
+ * | --- | --- |
292
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
293
+ * | default | "UTF-8" |
294
+ * | used by | G |
234
295
  *
235
296
  * @category Attribute
236
297
  */
@@ -240,9 +301,14 @@ export declare namespace Attribute {
240
301
  * Combine with stylesheet for styling SVG output using CSS classnames.
241
302
  *
242
303
  * @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
304
+ *
305
+ * | Key | Value |
306
+ * | --- | --- |
307
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
308
+ * | default | "" |
309
+ * | used by | ENCG |
310
+ *
311
+ * @category Attribute
246
312
  */
247
313
  class: 'class';
248
314
  /**
@@ -254,10 +320,14 @@ export declare namespace Attribute {
254
320
  * At present, the modes "global" and "none" appear to be identical, both turning off the special cluster processing.
255
321
  *
256
322
  * @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
323
+ *
324
+ * | Key | Value |
325
+ * | --- | --- |
326
+ * | type | {@link https://graphviz.org/docs/attr-types/clusterMode/ clusterMode} |
327
+ * | default | local |
328
+ * | used by | G |
329
+ * | notes | dot only |
330
+ *
261
331
  * @category Attribute
262
332
  */
263
333
  clusterrank: 'clusterrank';
@@ -284,9 +354,13 @@ export declare namespace Attribute {
284
354
  * ![colorlist](https://graphviz.org/_pages/doc/info/colorlist.gif)
285
355
  *
286
356
  * @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
357
+ *
358
+ * | Key | Value |
359
+ * | --- | --- |
360
+ * | type | {@link https://graphviz.org/docs/attr-types/color/ color}/{@link https://graphviz.org/docs/attr-types/color/List colorList} |
361
+ * | default | black |
362
+ * | used by | ENC |
363
+ *
290
364
  * @category Attribute
291
365
  */
292
366
  color: 'color';
@@ -298,9 +372,13 @@ export declare namespace Attribute {
298
372
  * For example, if colorscheme=bugn9, then color=7 is interpreted as "/bugn9/7".
299
373
  *
300
374
  * @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
375
+ *
376
+ * | Key | Value |
377
+ * | --- | --- |
378
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
379
+ * | default | "" |
380
+ * | used by | ENCG |
381
+ *
304
382
  * @category Attribute
305
383
  */
306
384
  colorscheme: 'colorscheme';
@@ -309,9 +387,13 @@ export declare namespace Attribute {
309
387
  * Device-dependent
310
388
  *
311
389
  * @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
390
+ *
391
+ * | Key | Value |
392
+ * | --- | --- |
393
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
394
+ * | default | "" |
395
+ * | used by | ENCG |
396
+ *
315
397
  * @category Attribute
316
398
  */
317
399
  comment: 'comment';
@@ -319,10 +401,14 @@ export declare namespace Attribute {
319
401
  * If true, allow edges between clusters. (See {@link lhead} and {@link ltail} below.)
320
402
  *
321
403
  * @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
404
+ *
405
+ * | Key | Value |
406
+ * | --- | --- |
407
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
408
+ * | default | FALSE |
409
+ * | used by | G |
410
+ * | notes | dot only |
411
+ *
326
412
  * @category Attribute
327
413
  */
328
414
  compound: 'compound';
@@ -332,9 +418,13 @@ export declare namespace Attribute {
332
418
  * The latter feature is not yet available outside of dot.
333
419
  *
334
420
  * @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
421
+ *
422
+ * | Key | Value |
423
+ * | --- | --- |
424
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
425
+ * | default | FALSE |
426
+ * | used by | G |
427
+ *
338
428
  * @category Attribute
339
429
  */
340
430
  concentrate: 'concentrate';
@@ -355,10 +445,14 @@ export declare namespace Attribute {
355
445
  * ![constraint](https://graphviz.org/_pages/doc/info/constraint.gif)
356
446
  *
357
447
  * @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
448
+ *
449
+ * | Key | Value |
450
+ * | --- | --- |
451
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
452
+ * | default | TRUE |
453
+ * | used by | E |
454
+ * | notes | dot only |
455
+ *
362
456
  * @category Attribute
363
457
  */
364
458
  constraint: 'constraint';
@@ -366,9 +460,13 @@ export declare namespace Attribute {
366
460
  * If true, attach edge label to edge by a 2-segment polyline, underlining the label, then going to the closest point of spline.
367
461
  *
368
462
  * @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
463
+ *
464
+ * | Key | Value |
465
+ * | --- | --- |
466
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
467
+ * | default | FALSE |
468
+ * | used by | E |
469
+ *
372
470
  * @category Attribute
373
471
  */
374
472
  decorate: 'decorate';
@@ -377,11 +475,15 @@ export declare namespace Attribute {
377
475
  * If set too small, connected components may overlap. Only applicable if {@link pack}=false.
378
476
  *
379
477
  * @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
478
+ *
479
+ * | Key | Value |
480
+ * | --- | --- |
481
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
482
+ * | default | 1+(avg. len)*sqrt(|V|) |
483
+ * | minimum | epsilon |
484
+ * | notes | neato only |
485
+ * | used by | G |
486
+ *
385
487
  * @category Attribute
386
488
  */
387
489
  defaultdist: 'defaultdist';
@@ -390,11 +492,15 @@ export declare namespace Attribute {
390
492
  * The maximum value allowed is 10.
391
493
  *
392
494
  * @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
495
+ *
496
+ * | Key | Value |
497
+ * | --- | --- |
498
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
499
+ * | default | 2 |
500
+ * | minimum | 2 |
501
+ * | notes | sfdp, fdp, neato only |
502
+ * | used by | G |
503
+ *
398
504
  * @category Attribute
399
505
  */
400
506
  dim: 'dim';
@@ -410,11 +516,15 @@ export declare namespace Attribute {
410
516
  * All other coordinates will be 2D and, at best, will reflect a projection of a higher-dimensional point onto the plane.
411
517
  *
412
518
  * @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
519
+ *
520
+ * | Key | Value |
521
+ * | --- | --- |
522
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
523
+ * | default | 2 |
524
+ * | minimum | 2 |
525
+ * | used by | G |
526
+ * | notes | sfdp, fdp, neato only |
527
+ *
418
528
  * @category Attribute
419
529
  */
420
530
  dimen: 'dimen';
@@ -425,9 +535,13 @@ export declare namespace Attribute {
425
535
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
426
536
  *
427
537
  * @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
538
+ *
539
+ * | Key | Value |
540
+ * | --- | --- |
541
+ * | type | {@link https://graphviz.org/docs/attr-types/dirType/ dirType} |
542
+ * | default | forward(directed) none(undirected) |
543
+ * | used by | E |
544
+ *
431
545
  * @category Attribute
432
546
  */
433
547
  dir: 'dir';
@@ -438,10 +552,14 @@ export declare namespace Attribute {
438
552
  * The main difference is that, in the latter case, only these constraints are involved, so a faster solver can be used.
439
553
  *
440
554
  * @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
555
+ *
556
+ * | Key | Value |
557
+ * | --- | --- |
558
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string}/{@link https://graphviz.org/docs/attr-types/bool bool} |
559
+ * | default | FALSE |
560
+ * | used by | G |
561
+ * | notes | neato only |
562
+ *
445
563
  * @category Attribute
446
564
  */
447
565
  diredgeconstraints: 'diredgeconstraints';
@@ -450,9 +568,13 @@ export declare namespace Attribute {
450
568
  * Positive values cause top part to be larger than bottom; negative values do the opposite.
451
569
  *
452
570
  * @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
571
+ *
572
+ * | Key | Value |
573
+ * | --- | --- |
574
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
575
+ * | default | -100 |
576
+ * | used by | N |
577
+ *
456
578
  * @category Attribute
457
579
  */
458
580
  distortion: 'distortion';
@@ -462,10 +584,14 @@ export declare namespace Attribute {
462
584
  * For SVG output, it is used to guarantee that the dimensions in the output correspond to the correct number of points or inches.
463
585
  *
464
586
  * @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
587
+ *
588
+ * | Key | Value |
589
+ * | --- | --- |
590
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
591
+ * | default | 96.0 0.0 |
592
+ * | used by | G |
593
+ * | notes | svg, bitmap output only |
594
+ *
469
595
  * @category Attribute
470
596
  */
471
597
  dpi: 'dpi';
@@ -476,10 +602,14 @@ export declare namespace Attribute {
476
602
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
477
603
  *
478
604
  * @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
605
+ *
606
+ * | Key | Value |
607
+ * | --- | --- |
608
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
609
+ * | default | "" |
610
+ * | used by | E |
611
+ * | notes | svg, map only |
612
+ *
483
613
  * @category Attribute
484
614
  */
485
615
  edgeURL: 'edgeURL';
@@ -487,10 +617,14 @@ export declare namespace Attribute {
487
617
  * Synonym for {@link edgeURL}.
488
618
  *
489
619
  * @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
620
+ *
621
+ * | Key | Value |
622
+ * | --- | --- |
623
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
624
+ * | default | "" |
625
+ * | used by | E |
626
+ * | notes | svg, map only |
627
+ *
494
628
  * @category Attribute
495
629
  */
496
630
  edgehref: 'edgehref';
@@ -500,10 +634,14 @@ export declare namespace Attribute {
500
634
  * If undefined, the value of the {@link target} is used.
501
635
  *
502
636
  * @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
637
+ *
638
+ * | Key | Value |
639
+ * | --- | --- |
640
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
641
+ * | default | <none> |
642
+ * | used by | E |
643
+ * | notes | svg, map only |
644
+ *
507
645
  * @category Attribute
508
646
  */
509
647
  edgetarget: 'edgetarget';
@@ -512,10 +650,14 @@ export declare namespace Attribute {
512
650
  * This is used only if the edge has a {@link URL} or {@link edgeURL} attribute.
513
651
  *
514
652
  * @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
653
+ *
654
+ * | Key | Value |
655
+ * | --- | --- |
656
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
657
+ * | default | "" |
658
+ * | used by | E |
659
+ * | notes | svg, cmap only |
660
+ *
519
661
  * @category Attribute
520
662
  */
521
663
  edgetooltip: 'edgetooltip';
@@ -523,10 +665,15 @@ export declare namespace Attribute {
523
665
  * Terminating condition. If the length squared of all energy gradients are < **epsilon**, the algorithm stops.
524
666
  *
525
667
  * @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
668
+ *
669
+ * | Key | Value |
670
+ * | --- | --- |
671
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
672
+ * | default | .0001 |
673
+ * | minimum | 0 |
674
+ * | used by | G |
675
+ * | notes | neato only |
676
+ *
530
677
  * @category Attribute
531
678
  */
532
679
  epsilon: 'epsilon';
@@ -536,10 +683,14 @@ export declare namespace Attribute {
536
683
  * This should normally be strictly less than {@link sep}.
537
684
  *
538
685
  * @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
686
+ *
687
+ * | Key | Value |
688
+ * | --- | --- |\
689
+ * | type | {@link https://graphviz.org/docs/attr-types/addDouble/ addDouble}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:addPoint addPoint} |
690
+ * | default | 3 |
691
+ * | used by | G |
692
+ * | notes | not dot |
693
+ *
543
694
  * @category Attribute
544
695
  */
545
696
  esep: 'esep';
@@ -557,9 +708,13 @@ export declare namespace Attribute {
557
708
  * Thus, if the root graph has defined a **fillcolor**, this will override a **color** or **bgcolor** attribute set for the cluster.
558
709
  *
559
710
  * @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
711
+ *
712
+ * | Key | Value |
713
+ * | --- | --- |
714
+ * | type | {@link https://graphviz.org/docs/attr-types/color/ color}/{@link https://graphviz.org/docs/attr-types/color/List colorList} |
715
+ * | default | lightgrey(nodes) black(clusters) |
716
+ * | used by | NEC |
717
+ *
563
718
  * @category Attribute
564
719
  */
565
720
  fillcolor: 'fillcolor';
@@ -577,9 +732,13 @@ export declare namespace Attribute {
577
732
  * 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
733
  *
579
734
  * @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
735
+ *
736
+ * | Key | Value |
737
+ * | --- | --- |
738
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
739
+ * | default | FALSE |
740
+ * | used by | N |
741
+ *
583
742
  * @category Attribute
584
743
  */
585
744
  fixedsize: 'fixedsize';
@@ -587,9 +746,13 @@ export declare namespace Attribute {
587
746
  * Color used for text.
588
747
  *
589
748
  * @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
749
+ *
750
+ * | Key | Value |
751
+ * | --- | --- |
752
+ * | type | {@link https://graphviz.org/docs/attr-types/color/ color} |
753
+ * | default | black |
754
+ * | used by | ENGC |
755
+ *
593
756
  * @category Attribute
594
757
  */
595
758
  fontcolor: 'fontcolor';
@@ -615,9 +778,12 @@ export declare namespace Attribute {
615
778
  * The lookup does support various aliases for the common fonts.
616
779
  *
617
780
  * @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
781
+ * | Key | Value |
782
+ * | --- | --- |
783
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
784
+ * | default | "Times-Roman" |
785
+ * | used by | ENGC |
786
+ *
621
787
  * @category Attribute
622
788
  */
623
789
  fontname: 'fontname';
@@ -630,10 +796,13 @@ export declare namespace Attribute {
630
796
  * These last two options are useful with SVG viewers that support these richer fontname spaces.
631
797
  *
632
798
  * @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
799
+ * | Key | Value |
800
+ * | --- | --- |
801
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
802
+ * | default | "" |
803
+ * | used by | G |
804
+ * | notes | svg only |
805
+ *
637
806
  * @category Attribute
638
807
  */
639
808
  fontnames: 'fontnames';
@@ -645,9 +814,13 @@ export declare namespace Attribute {
645
814
  * Note that fontpath is an attribute of the root graph.
646
815
  *
647
816
  * @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
817
+ *
818
+ * | Key | Value |
819
+ * | --- | --- |
820
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
821
+ * | default | system-dependent |
822
+ * | used by | G |
823
+ *
651
824
  * @category Attribute
652
825
  */
653
826
  fontpath: 'fontpath';
@@ -655,10 +828,14 @@ export declare namespace Attribute {
655
828
  * Font size, {@link https://graphviz.org/doc/info/attrs.html in points}, used for text.
656
829
  *
657
830
  * @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
831
+ *
832
+ * | Key | Value |
833
+ * | --- | --- |\
834
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
835
+ * | default | 14 |
836
+ * | minimum | 1 |
837
+ * | used by | ENGC |
838
+ *
662
839
  * @category Attribute
663
840
  */
664
841
  fontsize: 'fontsize';
@@ -667,9 +844,13 @@ export declare namespace Attribute {
667
844
  * even if there is some overlap with nodes or other labels.
668
845
  *
669
846
  * @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
847
+ *
848
+ * | Key | Value |
849
+ * | --- | --- |
850
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
851
+ * | default | TRUE |
852
+ * | used by | G |
853
+ *
673
854
  * @category Attribute
674
855
  */
675
856
  forcelabels: 'forcelabels';
@@ -682,9 +863,12 @@ export declare namespace Attribute {
682
863
  * If unset, the default angle is 0.
683
864
  *
684
865
  * @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
866
+ * | Key | Value |
867
+ * | --- | --- |
868
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
869
+ * | default | "" |
870
+ * | used by | NCG |
871
+ *
688
872
  * @category Attribute
689
873
  */
690
874
  gradientangle: 'gradientangle';
@@ -693,10 +877,14 @@ export declare namespace Attribute {
693
877
  * have the same group attribute, parameters are set to avoid crossings and keep the edges straight.
694
878
  *
695
879
  * @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
880
+ *
881
+ * | Key | Value |
882
+ * | --- | --- |
883
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
884
+ * | default | "" |
885
+ * | used by | N |
886
+ * | notes | dot only |
887
+ *
700
888
  * @category Attribute
701
889
  */
702
890
  group: 'group';
@@ -706,10 +894,14 @@ export declare namespace Attribute {
706
894
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
707
895
  *
708
896
  * @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
897
+ *
898
+ * | Key | Value |
899
+ * | --- | --- |
900
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
901
+ * | default | "" |
902
+ * | used by | E |
903
+ * | notes | svg, map only |
904
+ *
713
905
  * @category Attribute
714
906
  */
715
907
  headURL: 'headURL';
@@ -717,10 +909,14 @@ export declare namespace Attribute {
717
909
  * Position of an edge's head label, {@link https://graphviz.org/doc/info/attrs.html in points}.
718
910
  * The position indicates the center of the label.
719
911
  *
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
912
+ * @see {@link https://graphviz.org/docs/attrs/head_lp/ Node, Edge and Graph Attributes#head_lp}\
913
+ *
914
+ * | Key | Value |
915
+ * | --- | --- |
916
+ * | type | {@link https://graphviz.org/docs/attr-types/point/ point} |
917
+ * | used by | E |
918
+ * | notes | write only |
919
+ *
724
920
  * @category Attribute
725
921
  */
726
922
  head_lp: 'head_lp';
@@ -729,9 +925,13 @@ export declare namespace Attribute {
729
925
  * the end of the edge goes to the center of the node, or the center of a port, if applicable.
730
926
  *
731
927
  * @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
928
+ *
929
+ * | Key | Value |
930
+ * | --- | --- |
931
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
932
+ * | default | TRUE |
933
+ * | used by | E |
934
+ *
735
935
  * @category Attribute
736
936
  */
737
937
  headclip: 'headclip';
@@ -739,10 +939,14 @@ export declare namespace Attribute {
739
939
  * Synonym for {@link headURL}.
740
940
  *
741
941
  * @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
942
+ *
943
+ * | Key | Value |
944
+ * | --- | --- |
945
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
946
+ * | default | "" |
947
+ * | used by | E |
948
+ * | notes | svg, map only |
949
+ *
746
950
  * @category Attribute
747
951
  */
748
952
  headhref: 'headhref';
@@ -751,9 +955,13 @@ export declare namespace Attribute {
751
955
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
752
956
  *
753
957
  * @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
958
+ *
959
+ * | Key | Value |
960
+ * | --- | --- |
961
+ * | type | {@link https://graphviz.org/docs/attr-types/lblString/ lblString} |
962
+ * | default | center |
963
+ * | used by | E |
964
+ *
757
965
  * @category Attribute
758
966
  */
759
967
  headlabel: 'headlabel';
@@ -763,10 +971,14 @@ export declare namespace Attribute {
763
971
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
764
972
  *
765
973
  * @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
974
+ *
975
+ * | Key | Value |
976
+ * | --- | --- |
977
+ * | type | {@link https://graphviz.org/docs/attr-types/portPos/ portPos} |
978
+ * | default | <none> |
979
+ * | used by | E |
980
+ * | notes | svg, map only |
981
+ *
770
982
  * @category Attribute
771
983
  */
772
984
  headport: 'headport';
@@ -776,10 +988,14 @@ export declare namespace Attribute {
776
988
  * If undefined, the value of the {@link target} is used.
777
989
  *
778
990
  * @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
991
+ *
992
+ * | Key | Value |
993
+ * | --- | --- |
994
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
995
+ * | default | "" |
996
+ * | used by | E |
997
+ * | notes | svg, cmap only |
998
+ *
783
999
  * @category Attribute
784
1000
  */
785
1001
  headtarget: 'headtarget';
@@ -788,10 +1004,14 @@ export declare namespace Attribute {
788
1004
  * This is used only if the edge has a {@link headURL} attribute.
789
1005
  *
790
1006
  * @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
1007
+ *
1008
+ * | Key | Value |
1009
+ * | --- | --- |
1010
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1011
+ * | default | 0.5 |
1012
+ * | minimum | 0.02 |
1013
+ * | used by | N |
1014
+ *
795
1015
  * @category Attribute
796
1016
  */
797
1017
  headtooltip: 'headtooltip';
@@ -808,10 +1028,15 @@ export declare namespace Attribute {
808
1028
  * If neither is set explicitly, the minimum of the two default values is used.
809
1029
  *
810
1030
  * @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
1031
+ *
1032
+ * | Key | Value |
1033
+ * | --- | --- |
1034
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1035
+ * | default | 0.5 |
1036
+ * | minimum | 0.02 |
1037
+ * | used by | N |
1038
+ * | notes | svg, postscript, map only |
1039
+ *
815
1040
  * @category Attribute
816
1041
  */
817
1042
  height: 'height';
@@ -819,10 +1044,14 @@ export declare namespace Attribute {
819
1044
  * Synonym for {@link URL}.
820
1045
  *
821
1046
  * @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
1047
+ *
1048
+ * | Key | Value |
1049
+ * | --- | --- |
1050
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1051
+ * | default | "" |
1052
+ * | used by | GCNE |
1053
+ * | notes | svg, postscript, map only |
1054
+ *
826
1055
  * @category Attribute
827
1056
  */
828
1057
  href: 'href';
@@ -839,9 +1068,14 @@ export declare namespace Attribute {
839
1068
  * By making these distinct, the user can include multiple image maps in the same document.
840
1069
  *
841
1070
  * @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
1071
+ *
1072
+ * | Key | Value |
1073
+ * | --- | --- |
1074
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1075
+ * | default | "" |
1076
+ * | used by | GCNE |
1077
+ * | notes | svg, postscript, map only |
1078
+ *
845
1079
  * @category Attribute
846
1080
  */
847
1081
  id: 'id';
@@ -861,9 +1095,13 @@ export declare namespace Attribute {
861
1095
  * 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
1096
  *
863
1097
  * @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
1098
+ *
1099
+ * | Key | Value |
1100
+ * | --- | --- |
1101
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1102
+ * | default | "" |
1103
+ * | used by | N |
1104
+ *
867
1105
  * @category Attribute
868
1106
  */
869
1107
  image: 'image';
@@ -874,9 +1112,13 @@ export declare namespace Attribute {
874
1112
  * If imagepath is not set, relative pathnames for the image file will be interpreted with respect to the current working directory.
875
1113
  *
876
1114
  * @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
1115
+ *
1116
+ * | Key | Value |
1117
+ * | --- | --- |
1118
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1119
+ * | default | "" |
1120
+ * | used by | G |
1121
+ *
880
1122
  * @category Attribute
881
1123
  */
882
1124
  imagepath: 'imagepath';
@@ -899,9 +1141,13 @@ export declare namespace Attribute {
899
1141
  * | br | Bottom Right |
900
1142
  *
901
1143
  * @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
1144
+ *
1145
+ * | Key | Value |
1146
+ * | --- | --- |
1147
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1148
+ * | default | mc |
1149
+ * | used by | N |
1150
+ *
905
1151
  * @category Attribute
906
1152
  */
907
1153
  imagepos: 'imagepos';
@@ -918,9 +1164,13 @@ export declare namespace Attribute {
918
1164
  * As with the case of expansion, if imagescale=true, width and height are scaled uniformly.
919
1165
  *
920
1166
  * @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
1167
+ *
1168
+ * | Key | Value |
1169
+ * | --- | --- |
1170
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool}/ {@link https://graphviz.org/docs/attr-types/string/ string} |
1171
+ * | default | FALSE |
1172
+ * | used by | N |
1173
+ *
924
1174
  * @category Attribute
925
1175
  */
926
1176
  imagescale: 'imagescale';
@@ -936,10 +1186,14 @@ export declare namespace Attribute {
936
1186
  * A value of 0 is equivalent to inputscale=72.
937
1187
  *
938
1188
  * @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
1189
+ *
1190
+ * | Key | Value |
1191
+ * | --- | --- |
1192
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1193
+ * | default | <none> |
1194
+ * | used by | G |
1195
+ * | notes | fdp, neato only |
1196
+ *
943
1197
  * @category Attribute
944
1198
  */
945
1199
  inputscale: 'inputscale';
@@ -953,11 +1207,13 @@ export declare namespace Attribute {
953
1207
  * To get an HTML-like label, the label attribute value itself must be an HTML string.
954
1208
  *
955
1209
  * @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
1210
+ *
1211
+ * | Key | Value |
1212
+ * | --- | --- |
1213
+ * | type | {@link https://graphviz.org/docs/attr-types/lblString/ lblString} |
1214
+ * | default | "\N" (nodes) "" (otherwise) |
1215
+ * | used by | ENGC |
1216
+ *
961
1217
  * @category Attribute
962
1218
  */
963
1219
  label: 'label';
@@ -966,10 +1222,14 @@ export declare namespace Attribute {
966
1222
  * This value overrides any {@link URL} defined for the edge.
967
1223
  *
968
1224
  * @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
1225
+ *
1226
+ * | Key | Value |
1227
+ * | --- | --- |
1228
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1229
+ * | default | "" |
1230
+ * | used by | E |
1231
+ * | notes | svg, map only |
1232
+ *
973
1233
  * @category Attribute
974
1234
  */
975
1235
  labelURL: 'labelURL';
@@ -981,11 +1241,15 @@ export declare namespace Attribute {
981
1241
  * Finally, a value of 3 invokes a two-step process of overlap removal and straightening.
982
1242
  *
983
1243
  * @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
1244
+ *
1245
+ * | Key | Value |
1246
+ * | --- | --- |
1247
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
1248
+ * | default | 0 |
1249
+ * | minimum | 0 |
1250
+ * | used by | G |
1251
+ * | notes | sfdp only |
1252
+ *
989
1253
  * @category Attribute
990
1254
  */
991
1255
  label_scheme: 'label_scheme';
@@ -997,10 +1261,14 @@ export declare namespace Attribute {
997
1261
  * The angle, in degrees, specifies the rotation from the 0 degree ray, with positive angles moving counterclockwise and negative angles moving clockwise.
998
1262
  *
999
1263
  * @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
1264
+ *
1265
+ * | Key | Value |
1266
+ * | --- | --- |
1267
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1268
+ * | default | -25 |
1269
+ * | minimum | -180 |
1270
+ * | used by | E |
1271
+ *
1004
1272
  * @category Attribute
1005
1273
  */
1006
1274
  labelangle: 'labelangle';
@@ -1010,10 +1278,14 @@ export declare namespace Attribute {
1010
1278
  * See {@link labelangle} for more details.
1011
1279
  *
1012
1280
  * @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
1281
+ *
1282
+ * | Key | Value |
1283
+ * | --- | --- |
1284
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1285
+ * | default | 1 |
1286
+ * | minimum | 0 |
1287
+ * | used by | E |
1288
+ *
1017
1289
  * @category Attribute
1018
1290
  */
1019
1291
  labeldistance: 'labeldistance';
@@ -1022,9 +1294,13 @@ export declare namespace Attribute {
1022
1294
  * In particular, it may appear on top of other edges.
1023
1295
  *
1024
1296
  * @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
1297
+ *
1298
+ * | Key | Value |
1299
+ * | --- | --- |
1300
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
1301
+ * | default | FALSE |
1302
+ * | used by | E |
1303
+ *
1028
1304
  * @category Attribute
1029
1305
  */
1030
1306
  labelfloat: 'labelfloat';
@@ -1033,9 +1309,13 @@ export declare namespace Attribute {
1033
1309
  * If not set, defaults to edge's fontcolor.
1034
1310
  *
1035
1311
  * @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
1312
+ *
1313
+ * | Key | Value |
1314
+ * | --- | --- |
1315
+ * | type | {@link https://graphviz.org/docs/attr-types/color/ color} |
1316
+ * | default | black |
1317
+ * | used by | E |
1318
+ *
1039
1319
  * @category Attribute
1040
1320
  */
1041
1321
  labelfontcolor: 'labelfontcolor';
@@ -1044,9 +1324,13 @@ export declare namespace Attribute {
1044
1324
  * If not set, defaults to edge's fontname.
1045
1325
  *
1046
1326
  * @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
1327
+ *
1328
+ * | Key | Value |
1329
+ * | --- | --- |
1330
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1331
+ * | default | "Times-Roman" |
1332
+ * | used by | E |
1333
+ *
1050
1334
  * @category Attribute
1051
1335
  */
1052
1336
  labelfontname: 'labelfontname';
@@ -1055,10 +1339,14 @@ export declare namespace Attribute {
1055
1339
  * If not set, defaults to edge's fontsize.
1056
1340
  *
1057
1341
  * @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
1342
+ *
1343
+ * | Key | Value |
1344
+ * | --- | --- |
1345
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1346
+ * | default | 14 |
1347
+ * | minimum | 1 |
1348
+ * | used by | E |
1349
+ *
1062
1350
  * @category Attribute
1063
1351
  */
1064
1352
  labelfontsize: 'labelfontsize';
@@ -1066,10 +1354,14 @@ export declare namespace Attribute {
1066
1354
  * Synonym for {@link labelURL}.
1067
1355
  *
1068
1356
  * @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
1357
+ *
1358
+ * | Key | Value |
1359
+ * | --- | --- |
1360
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1361
+ * | default | "" |
1362
+ * | used by | E |
1363
+ * | notes | svg, map only |
1364
+ *
1073
1365
  * @category Attribute
1074
1366
  */
1075
1367
  labelhref: 'labelhref';
@@ -1080,9 +1372,13 @@ export declare namespace Attribute {
1080
1372
  * Thus, if the root graph sets **labeljust** to "l", the subgraph inherits this value.
1081
1373
  *
1082
1374
  * @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
1375
+ *
1376
+ * | Key | Value |
1377
+ * | --- | --- |
1378
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1379
+ * | default | "c" |
1380
+ * | used by | GC |
1381
+ *
1086
1382
  * @category Attribute
1087
1383
  */
1088
1384
  labeljust: 'labeljust';
@@ -1099,12 +1395,13 @@ export declare namespace Attribute {
1099
1395
  * In the default case, the label is vertically centered.
1100
1396
  *
1101
1397
  * @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
1398
+ *
1399
+ * | Key | Value |
1400
+ * | --- | --- |
1401
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1402
+ * | default | "t" (clusters) "b" (root graphs) "c" (nodes) |
1403
+ * | used by | NGC |
1404
+ *
1108
1405
  * @category Attribute
1109
1406
  */
1110
1407
  labelloc: 'labelloc';
@@ -1114,10 +1411,14 @@ export declare namespace Attribute {
1114
1411
  * If undefined, the value of the {@link target} is used.
1115
1412
  *
1116
1413
  * @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
1414
+ *
1415
+ * | Key | Value |
1416
+ * | --- | --- |
1417
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1418
+ * | default | <none> |
1419
+ * | used by | E |
1420
+ * | notes | svg, cmap only |
1421
+ *
1121
1422
  * @category Attribute
1122
1423
  */
1123
1424
  labeltarget: 'labeltarget';
@@ -1126,10 +1427,14 @@ export declare namespace Attribute {
1126
1427
  * This is used only if the edge has a {@link URL} or {@link labelURL} attribute.
1127
1428
  *
1128
1429
  * @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
1430
+ *
1431
+ * | Key | Value |
1432
+ * | --- | --- |
1433
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
1434
+ * | default | "" |
1435
+ * | used by | E |
1436
+ * | notes | svg, cmap only |
1437
+ *
1133
1438
  * @category Attribute
1134
1439
  */
1135
1440
  labeltooltip: 'labeltooltip';
@@ -1138,9 +1443,13 @@ export declare namespace Attribute {
1138
1443
  * Synonymous with {@link rotate rotate=90} or {@link orientation orientation=landscape}.
1139
1444
  *
1140
1445
  * @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
1446
+ *
1447
+ * | Key | Value |
1448
+ * | --- | --- |
1449
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
1450
+ * | default | FALSE |
1451
+ * | used by | G |
1452
+ *
1144
1453
  * @category Attribute
1145
1454
  */
1146
1455
  landscape: 'landscape';
@@ -1148,9 +1457,13 @@ export declare namespace Attribute {
1148
1457
  * Specifies layers in which the node, edge or cluster is present.
1149
1458
  *
1150
1459
  * @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
1460
+ *
1461
+ * | Key | Value |
1462
+ * | --- | --- |
1463
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:layerRange layerRange} |
1464
+ * | default | "" |
1465
+ * | used by | ENC |
1466
+ *
1154
1467
  * @category Attribute
1155
1468
  */
1156
1469
  layer: 'layer';
@@ -1158,9 +1471,13 @@ export declare namespace Attribute {
1158
1471
  * Specifies the separator characters used to split an attribute of type {@link layerRange} into a list of ranges.
1159
1472
  *
1160
1473
  * @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
1474
+ *
1475
+ * | Key | Value |
1476
+ * | --- | --- |
1477
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1478
+ * | default | "" |
1479
+ * | used by | G |
1480
+ *
1164
1481
  * @category Attribute
1165
1482
  */
1166
1483
  layerlistsep: 'layerlistsep';
@@ -1170,9 +1487,13 @@ export declare namespace Attribute {
1170
1487
  * For more information, see the page {@link https://graphviz.org/faq/#FaqOverlays How to use drawing layers (overlays)}.
1171
1488
  *
1172
1489
  * @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
1490
+ *
1491
+ * | Key | Value |
1492
+ * | --- | --- |
1493
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:layerList layerList} |
1494
+ * | default | "" |
1495
+ * | used by | G |
1496
+ *
1176
1497
  * @category Attribute
1177
1498
  */
1178
1499
  layers: 'layers';
@@ -1180,9 +1501,13 @@ export declare namespace Attribute {
1180
1501
  * Selects a list of layers to be emitted.
1181
1502
  *
1182
1503
  * @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
1504
+ *
1505
+ * | Key | Value |
1506
+ * | --- | --- |
1507
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:layerRange layerRange} |
1508
+ * | default | "" |
1509
+ * | used by | G |
1510
+ *
1186
1511
  * @category Attribute
1187
1512
  */
1188
1513
  layerselect: 'layerselect';
@@ -1190,9 +1515,13 @@ export declare namespace Attribute {
1190
1515
  * Specifies the separator characters used to split the {@link layers} attribute into a list of layer names.
1191
1516
  *
1192
1517
  * @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
1518
+ *
1519
+ * | Key | Value |
1520
+ * | --- | --- |
1521
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1522
+ * | default | " :\t" |
1523
+ * | used by | G |
1524
+ *
1196
1525
  * @category Attribute
1197
1526
  */
1198
1527
  layersep: 'layersep';
@@ -1203,9 +1532,13 @@ export declare namespace Attribute {
1203
1532
  * For example, a graph containing position information from a layout might want to record what the associated layout algorithm was.
1204
1533
  *
1205
1534
  * @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
1535
+ *
1536
+ * | Key | Value |
1537
+ * | --- | --- |
1538
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1539
+ * | default | "" |
1540
+ * | used by | G |
1541
+ *
1209
1542
  * @category Attribute
1210
1543
  */
1211
1544
  layout: 'layout';
@@ -1213,12 +1546,15 @@ export declare namespace Attribute {
1213
1546
  * Preferred edge length, in inches.
1214
1547
  *
1215
1548
  * @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
1549
+ *
1550
+ * | Key | Value |
1551
+ * | --- | --- |
1552
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1553
+ * | default | 1.0 (neato) 0.3 (fdp) |
1554
+ * | minimum | 0.0 |
1555
+ * | used by | E |
1556
+ * | notes | fdp, neato only |
1557
+ *
1222
1558
  * @category Attribute
1223
1559
  */
1224
1560
  len: 'len';
@@ -1226,11 +1562,15 @@ export declare namespace Attribute {
1226
1562
  * Number of levels allowed in the multilevel scheme.
1227
1563
  *
1228
1564
  * @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
1565
+ *
1566
+ * | Key | Value |
1567
+ * | --- | --- |
1568
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
1569
+ * | default | MAXINT |
1570
+ * | minimum | 0 |
1571
+ * | used by | G |
1572
+ * | notes | sfdp only |
1573
+ *
1234
1574
  * @category Attribute
1235
1575
  */
1236
1576
  levels: 'levels';
@@ -1240,10 +1580,14 @@ export declare namespace Attribute {
1240
1580
  * On the other hand, negative values will relax the constraints by allowing some overlap between the levels.
1241
1581
  *
1242
1582
  * @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
1583
+ *
1584
+ * | Key | Value |
1585
+ * | --- | --- |
1586
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1587
+ * | default | 0 |
1588
+ * | used by | G |
1589
+ * | notes | neato only |
1590
+ *
1247
1591
  * @category Attribute
1248
1592
  */
1249
1593
  levelsgap: 'levelsgap';
@@ -1254,10 +1598,14 @@ export declare namespace Attribute {
1254
1598
  * See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
1255
1599
  *
1256
1600
  * @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
1601
+ *
1602
+ * | Key | Value |
1603
+ * | --- | --- |
1604
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1605
+ * | default | "" |
1606
+ * | used by | E |
1607
+ * | notes | dot only |
1608
+ *
1261
1609
  * @category Attribute
1262
1610
  */
1263
1611
  lhead: 'lhead';
@@ -1265,9 +1613,13 @@ export declare namespace Attribute {
1265
1613
  * Height of graph or cluster label, in inches.
1266
1614
  *
1267
1615
  * @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
1616
+ *
1617
+ * | Key | Value |
1618
+ * | --- | --- |
1619
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1620
+ * | used by | GC |
1621
+ * | notes | write only |
1622
+ *
1271
1623
  * @category Attribute
1272
1624
  */
1273
1625
  lheight: 'lheight';
@@ -1276,9 +1628,13 @@ export declare namespace Attribute {
1276
1628
  * The position indicates the center of the label.
1277
1629
  *
1278
1630
  * @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
1631
+ *
1632
+ * | Key | Value |
1633
+ * | --- | --- |
1634
+ * | type | {@link https://graphviz.org/docs/attr-types/point/ point} |
1635
+ * | used by | EGC |
1636
+ * | notes | write only |
1637
+ *
1282
1638
  * @category Attribute
1283
1639
  */
1284
1640
  lp: 'lp';
@@ -1288,10 +1644,14 @@ export declare namespace Attribute {
1288
1644
  * See the {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
1289
1645
  *
1290
1646
  * @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
1647
+ *
1648
+ * | Key | Value |
1649
+ * | --- | --- |
1650
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1651
+ * | default | "" |
1652
+ * | used by | E |
1653
+ * | notes | dot only |
1654
+ *
1295
1655
  * @category Attribute
1296
1656
  */
1297
1657
  ltail: 'ltail';
@@ -1299,9 +1659,13 @@ export declare namespace Attribute {
1299
1659
  * Width of graph or cluster label, in inches.
1300
1660
  *
1301
1661
  * @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
1662
+ *
1663
+ * | Key | Value |
1664
+ * | --- | --- |
1665
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1666
+ * | used by | GC |
1667
+ * | notes | write only |
1668
+ *
1305
1669
  * @category Attribute
1306
1670
  */
1307
1671
  lwidth: 'lwidth';
@@ -1321,9 +1685,13 @@ export declare namespace Attribute {
1321
1685
  * By default, the value is 0.11,0.055.
1322
1686
  *
1323
1687
  * @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
1688
+ *
1689
+ * | Key | Value |
1690
+ * | --- | --- |
1691
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point} |
1692
+ * | default | <device-dependent> |
1693
+ * | used by | NCG |
1694
+ *
1327
1695
  * @category Attribute
1328
1696
  */
1329
1697
  margin: 'margin';
@@ -1331,13 +1699,14 @@ export declare namespace Attribute {
1331
1699
  * Sets the number of iterations used.
1332
1700
  *
1333
1701
  * @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
1702
+ *
1703
+ * | Key | Value |
1704
+ * | --- | --- |
1705
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
1706
+ * | default | 100 * # nodes(mode == KK) 200(mode == major) 600(fdp) |
1707
+ * | used by | G |
1708
+ * | notes | fdp, neato only |
1709
+ *
1341
1710
  * @category Attribute
1342
1711
  */
1343
1712
  maxiter: 'maxiter';
@@ -1346,10 +1715,14 @@ export declare namespace Attribute {
1346
1715
  * These correspond to the number of tries without improvement before quitting and the maximum number of iterations in each pass.
1347
1716
  *
1348
1717
  * @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
1718
+ *
1719
+ * | Key | Value |
1720
+ * | --- | --- |
1721
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1722
+ * | default | 1 |
1723
+ * | used by | G |
1724
+ * | notes | dot only |
1725
+ *
1353
1726
  * @category Attribute
1354
1727
  */
1355
1728
  mclimit: 'mclimit';
@@ -1357,11 +1730,15 @@ export declare namespace Attribute {
1357
1730
  * Specifies the minimum separation between all nodes.
1358
1731
  *
1359
1732
  * @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
1733
+ *
1734
+ * | Key | Value |
1735
+ * | --- | --- |
1736
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1737
+ * | default | 1 |
1738
+ * | minimum | 0 |
1739
+ * | used by | G |
1740
+ * | notes | circo only |
1741
+ *
1365
1742
  * @category Attribute
1366
1743
  */
1367
1744
  mindist: 'mindist';
@@ -1369,11 +1746,15 @@ export declare namespace Attribute {
1369
1746
  * Minimum edge length (rank difference between head and tail).
1370
1747
  *
1371
1748
  * @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
1749
+ *
1750
+ * | Key | Value |
1751
+ * | --- | --- |
1752
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
1753
+ * | default | 1 |
1754
+ * | minimum | 0 |
1755
+ * | used by | E |
1756
+ * | notes | dot only |
1757
+ *
1377
1758
  * @category Attribute
1378
1759
  */
1379
1760
  minlen: 'minlen';
@@ -1391,10 +1772,14 @@ export declare namespace Attribute {
1391
1772
  * 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
1773
  *
1393
1774
  * @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
1775
+ *
1776
+ * | Key | Value |
1777
+ * | --- | --- |
1778
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1779
+ * | default | major |
1780
+ * | used by | G |
1781
+ * | notes | neato only |
1782
+ *
1398
1783
  * @category Attribute
1399
1784
  */
1400
1785
  mode: 'mode';
@@ -1415,10 +1800,14 @@ export declare namespace Attribute {
1415
1800
  * Thus, by supplying a complete graph, the input can specify all of the relevant distances.
1416
1801
  *
1417
1802
  * @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
1803
+ *
1804
+ * | Key | Value |
1805
+ * | --- | --- |
1806
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1807
+ * | default | shortpath |
1808
+ * | used by | G |
1809
+ * | notes | neato only |
1810
+ *
1422
1811
  * @category Attribute
1423
1812
  */
1424
1813
  model: 'model';
@@ -1426,10 +1815,14 @@ export declare namespace Attribute {
1426
1815
  * 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
1816
  *
1428
1817
  * @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
1818
+ *
1819
+ * | Key | Value |
1820
+ * | --- | --- |
1821
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
1822
+ * | default | FALSE |
1823
+ * | used by | G |
1824
+ * | notes | neato only |
1825
+ *
1433
1826
  * @category Attribute
1434
1827
  */
1435
1828
  mosek: 'mosek';
@@ -1444,10 +1837,14 @@ export declare namespace Attribute {
1444
1837
  * Rank constraints will usually take precedence over edge constraints.
1445
1838
  *
1446
1839
  * @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
1840
+ *
1841
+ * | Key | Value |
1842
+ * | --- | --- |
1843
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
1844
+ * | default | FALSE |
1845
+ * | used by | G |
1846
+ * | notes | dot only |
1847
+ *
1451
1848
  * @category Attribute
1452
1849
  */
1453
1850
  newrank: 'newrank';
@@ -1457,10 +1854,14 @@ export declare namespace Attribute {
1457
1854
  * For other layouts, this affects the spacing between loops on a single node, or multiedges between a pair of nodes.
1458
1855
  *
1459
1856
  * @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
1857
+ *
1858
+ * | Key | Value |
1859
+ * | --- | --- |
1860
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1861
+ * | default | 0.25 |
1862
+ * | minimum | 0.02 |
1863
+ * | used by | G |
1864
+ *
1464
1865
  * @category Attribute
1465
1866
  */
1466
1867
  nodesep: 'nodesep';
@@ -1472,9 +1873,13 @@ export declare namespace Attribute {
1472
1873
  * 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
1874
  *
1474
1875
  * @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
1876
+ *
1877
+ * | Key | Value |
1878
+ * | --- | --- |
1879
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
1880
+ * | default | FALSE |
1881
+ * | used by | GCNE |
1882
+ *
1478
1883
  * @category Attribute
1479
1884
  */
1480
1885
  nojustify: 'nojustify';
@@ -1484,10 +1889,14 @@ export declare namespace Attribute {
1484
1889
  * **NOTE**: Since the attribute is evaluated first as a number, 0 and 1 cannot be used for false and true.
1485
1890
  *
1486
1891
  * @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
1892
+ *
1893
+ * | Key | Value |
1894
+ * | --- | --- |
1895
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/bool/ bool} |
1896
+ * | default | FALSE |
1897
+ * | used by | G |
1898
+ * | notes | not dot |
1899
+ *
1491
1900
  * @category Attribute
1492
1901
  */
1493
1902
  normalize: 'normalize';
@@ -1497,10 +1906,14 @@ export declare namespace Attribute {
1497
1906
  * To avoid this translation, set notranslate to true.
1498
1907
  *
1499
1908
  * @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
1909
+ *
1910
+ * | Key | Value |
1911
+ * | --- | --- |
1912
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
1913
+ * | default | FALSE |
1914
+ * | used by | G |
1915
+ * | notes | neato only |
1916
+ *
1504
1917
  * @category Attribute
1505
1918
  */
1506
1919
  notranslate: 'notranslate';
@@ -1510,9 +1923,13 @@ export declare namespace Attribute {
1510
1923
  * If defined, # iterations = **nslimit(1)** * # nodes; otherwise, # iterations = MAXINT.
1511
1924
  *
1512
1925
  * @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
1926
+ *
1927
+ * | Key | Value |
1928
+ * | --- | --- |
1929
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1930
+ * | used by | G |
1931
+ * | notes | dot only |
1932
+ *
1516
1933
  * @category Attribute
1517
1934
  */
1518
1935
  nslimit: 'nslimit';
@@ -1522,9 +1939,13 @@ export declare namespace Attribute {
1522
1939
  * If defined, # iterations = **nslimit(1)** * # nodes; otherwise, # iterations = MAXINT.
1523
1940
  *
1524
1941
  * @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
1942
+ *
1943
+ * | Key | Value |
1944
+ * | --- | --- |
1945
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
1946
+ * | used by | G |
1947
+ * | notes | dot only |
1948
+ *
1528
1949
  * @category Attribute
1529
1950
  */
1530
1951
  nslimit1: 'nslimit1';
@@ -1532,10 +1953,14 @@ export declare namespace Attribute {
1532
1953
  * Angle, in degrees, used to rotate polygon node shapes. For any number of polygon sides, 0 degrees rotation results in a flat base.
1533
1954
  *
1534
1955
  * @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
1956
+ *
1957
+ * | Key | Value |
1958
+ * | --- | --- |
1959
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1960
+ * | default | "" |
1961
+ * | used by | GN |
1962
+ * | notes | dot only |
1963
+ *
1539
1964
  * @category Attribute
1540
1965
  */
1541
1966
  ordering: 'ordering';
@@ -1543,9 +1968,13 @@ export declare namespace Attribute {
1543
1968
  * If "[lL]*", set graph orientation to landscape Used only if {@link rotate} is not defined.
1544
1969
  *
1545
1970
  * @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
1971
+ *
1972
+ * | Key | Value |
1973
+ * | --- | --- |
1974
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
1975
+ * | default | "" |
1976
+ * | used by | G |
1977
+ *
1549
1978
  * @category Attribute
1550
1979
  */
1551
1980
  orientation: 'orientation';
@@ -1553,9 +1982,13 @@ export declare namespace Attribute {
1553
1982
  * Specify order in which nodes and edges are drawn.
1554
1983
  *
1555
1984
  * @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
1985
+ *
1986
+ * | Key | Value |
1987
+ * | --- | --- |
1988
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:outputMode outputMode} |
1989
+ * | default | breadthfirst |
1990
+ * | used by | G |
1991
+ *
1559
1992
  * @category Attribute
1560
1993
  */
1561
1994
  outputorder: 'outputorder';
@@ -1610,10 +2043,14 @@ export declare namespace Attribute {
1610
2043
  * For these, orthogonal ordering is only preserved among nodes related by an edge.
1611
2044
  *
1612
2045
  * @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
2046
+ *
2047
+ * | Key | Value |
2048
+ * | --- | --- |
2049
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string}/{@link https://graphviz.org/docs/attr-types/bool/ bool} |
2050
+ * | default | TRUE |
2051
+ * | used by | G |
2052
+ * | notes | not dot |
2053
+ *
1617
2054
  * @category Attribute
1618
2055
  */
1619
2056
  overlap: 'overlap';
@@ -1626,11 +2063,15 @@ export declare namespace Attribute {
1626
2063
  * If overlap_scaling is zero, no scaling is done.
1627
2064
  *
1628
2065
  * @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
2066
+ *
2067
+ * | Key | Value |
2068
+ * | --- | --- |
2069
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2070
+ * | default | -4 |
2071
+ * | minimum | -1.00E+10 |
2072
+ * | used by | G |
2073
+ * | notes | prism only |
2074
+ *
1634
2075
  * @category Attribute
1635
2076
  */
1636
2077
  overlap_scaling: 'overlap_scaling';
@@ -1638,10 +2079,14 @@ export declare namespace Attribute {
1638
2079
  * If true, the overlap removal algorithm will perform a compression pass to reduce the size of the layout.
1639
2080
  *
1640
2081
  * @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
2082
+ *
2083
+ * | Key | Value |
2084
+ * | --- | --- |
2085
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
2086
+ * | default | TRUE |
2087
+ * | used by | G |
2088
+ * | notes | prism only |
2089
+ *
1645
2090
  * @category Attribute
1646
2091
  */
1647
2092
  overlap_shrink: 'overlap_shrink';
@@ -1655,9 +2100,13 @@ export declare namespace Attribute {
1655
2100
  * For layouts which always do packing, such a twopi, the **pack** attribute is just used to set the margin.
1656
2101
  *
1657
2102
  * @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
2103
+ *
2104
+ * | Key | Value |
2105
+ * | --- | --- |
2106
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool}/{@link https://graphviz.org/docs/attr-types/int/ int} |
2107
+ * | default | FALSE |
2108
+ * | used by | G |
2109
+ *
1661
2110
  * @category Attribute
1662
2111
  */
1663
2112
  pack: 'pack';
@@ -1666,9 +2115,13 @@ export declare namespace Attribute {
1666
2115
  * Note that defining {@link packmode} will automatically turn on packing as though one had set `pack=true`.
1667
2116
  *
1668
2117
  * @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
2118
+ *
2119
+ * | Key | Value |
2120
+ * | --- | --- |
2121
+ * | type | {@link https://graphviz.org/docs/attrs/packmode/ packMode} |
2122
+ * | default | node |
2123
+ * | used by | G |
2124
+ *
1672
2125
  * @category Attribute
1673
2126
  */
1674
2127
  packmode: 'packmode';
@@ -1681,9 +2134,13 @@ export declare namespace Attribute {
1681
2134
  * to avoid having nodes and edges abutting the boundary of the drawn region.
1682
2135
  *
1683
2136
  * @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
2137
+ *
2138
+ * | Key | Value |
2139
+ * | --- | --- |
2140
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point} |
2141
+ * | default | 0.0555(4 points) |
2142
+ * | used by | G |
2143
+ *
1687
2144
  * @category Attribute
1688
2145
  */
1689
2146
  pad: 'pad';
@@ -1701,8 +2158,12 @@ export declare namespace Attribute {
1701
2158
  * Or use the {@link viewport} to generate multiple files.
1702
2159
  *
1703
2160
  * @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
2161
+ *
2162
+ * | Key | Value |
2163
+ * | --- | --- |
2164
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point} |
2165
+ * | used by | G |
2166
+ *
1706
2167
  * @category Attribute
1707
2168
  */
1708
2169
  page: 'page';
@@ -1710,9 +2171,13 @@ export declare namespace Attribute {
1710
2171
  * 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
2172
  *
1712
2173
  * @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
2174
+ *
2175
+ * | Key | Value |
2176
+ * | --- | --- |
2177
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:pagedir pagedir} |
2178
+ * | default | BL |
2179
+ * | used by | G |
2180
+ *
1716
2181
  * @category Attribute
1717
2182
  */
1718
2183
  pagedir: 'pagedir';
@@ -1726,9 +2191,13 @@ export declare namespace Attribute {
1726
2191
  * Thus, if the root graph has defined a **pencolor**, this will override a **color** or **bgcolor** attribute set for the cluster.
1727
2192
  *
1728
2193
  * @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
2194
+ *
2195
+ * | Key | Value |
2196
+ * | --- | --- |
2197
+ * | type | {@link https://graphviz.org/docs/attr-types/color/ color} |
2198
+ * | default | black |
2199
+ * | used by | C |
2200
+ *
1732
2201
  * @category Attribute
1733
2202
  */
1734
2203
  pencolor: 'pencolor';
@@ -1741,10 +2210,14 @@ export declare namespace Attribute {
1741
2210
  * If both are used, penwidth will be used.
1742
2211
  *
1743
2212
  * @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
2213
+ *
2214
+ * | Key | Value |
2215
+ * | --- | --- |
2216
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2217
+ * | default | 1 |
2218
+ * | minimum | 0 |
2219
+ * | used by | CNE |
2220
+ *
1748
2221
  * @category Attribute
1749
2222
  */
1750
2223
  penwidth: 'penwidth';
@@ -1755,12 +2228,14 @@ export declare namespace Attribute {
1755
2228
  * Also, 1 is the maximum peripheries value for clusters.
1756
2229
  *
1757
2230
  * @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
2231
+ *
2232
+ * | Key | Value |
2233
+ * | --- | --- |
2234
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2235
+ * | default | shape default(nodes) 1(clusters) |
2236
+ * | minimum | 0 |
2237
+ * | used by | NC |
2238
+ *
1764
2239
  * @category Attribute
1765
2240
  */
1766
2241
  peripheries: 'peripheries';
@@ -1777,10 +2252,14 @@ export declare namespace Attribute {
1777
2252
  * However, if the graph specifies {@link overlap node overlap removal} or a change in {@link ratio aspect ratio}, node coordinates may still change.
1778
2253
  *
1779
2254
  * @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
2255
+ *
2256
+ * | Key | Value |
2257
+ * | --- | --- |
2258
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
2259
+ * | default | FALSE |
2260
+ * | used by | N |
2261
+ * | notes | neato, fdp only |
2262
+ *
1784
2263
  * @category Attribute
1785
2264
  */
1786
2265
  pin: 'pin';
@@ -1799,8 +2278,12 @@ export declare namespace Attribute {
1799
2278
  * Thus, neato -n can accept input correctly without requiring a -s flag and, in fact, ignores any such flag.
1800
2279
  *
1801
2280
  * @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
2281
+ *
2282
+ * | Key | Value |
2283
+ * | --- | --- |
2284
+ * | type | {@link https://graphviz.org/docs/attr-types/point/ point}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:smoothType splineType} |
2285
+ * | used by | EN |
2286
+ *
1804
2287
  * @category Attribute
1805
2288
  */
1806
2289
  pos: 'pos';
@@ -1811,10 +2294,14 @@ export declare namespace Attribute {
1811
2294
  * As a slight exception to the normal interpretation of bool, a value of "2" corresponds to "fast".
1812
2295
  *
1813
2296
  * @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
2297
+ *
2298
+ * | Key | Value |
2299
+ * | --- | --- |
2300
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:quadType quadType} |
2301
+ * | default | normal |
2302
+ * | used by | G |
2303
+ * | notes | sfdp only |
2304
+ *
1818
2305
  * @category Attribute
1819
2306
  */
1820
2307
  quadtree: 'quadtree';
@@ -1822,10 +2309,14 @@ export declare namespace Attribute {
1822
2309
  * If **quantum** > 0.0, node label dimensions will be rounded to integral multiples of the quantum.
1823
2310
  *
1824
2311
  * @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
2312
+ *
2313
+ * | Key | Value |
2314
+ * | --- | --- |
2315
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2316
+ * | default | 0 |
2317
+ * | minimum | 0 |
2318
+ * | used by | G |
2319
+ *
1829
2320
  * @category Attribute
1830
2321
  */
1831
2322
  quantum: 'quantum';
@@ -1838,9 +2329,13 @@ export declare namespace Attribute {
1838
2329
  * (Note: the minimum rank is topmost or leftmost, and the maximum rank is bottommost or rightmost.)
1839
2330
  *
1840
2331
  * @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
2332
+ *
2333
+ * | Key | Value |
2334
+ * | --- | --- |
2335
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:rankType rankType} |
2336
+ * | used by | S |
2337
+ * | notes | dot only |
2338
+ *
1844
2339
  * @category Attribute
1845
2340
  */
1846
2341
  rank: 'rank';
@@ -1853,10 +2348,14 @@ export declare namespace Attribute {
1853
2348
  * See {@link https://graphviz.org/doc/info/shapes.html record shapes}.
1854
2349
  *
1855
2350
  * @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
2351
+ *
2352
+ * | Key | Value |
2353
+ * | --- | --- |
2354
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:rankdir rankdir} |
2355
+ * | default | TB |
2356
+ * | used by | G |
2357
+ * | notes | dot only |
2358
+ *
1860
2359
  * @category Attribute
1861
2360
  */
1862
2361
  rankdir: 'rankdir';
@@ -1872,13 +2371,15 @@ export declare namespace Attribute {
1872
2371
  * If there are more circles than numbers, the last number is used as the increment for the remainder.
1873
2372
  *
1874
2373
  * @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
2374
+ *
2375
+ * | Key | Value |
2376
+ * | --- | --- |
2377
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:doubleList doubleList} |
2378
+ * | default | 0.5(dot) 1.0(twopi) |
2379
+ * | minimum | 0.02 |
2380
+ * | used by | G |
2381
+ * | notes | twopi, dot only |
2382
+ *
1882
2383
  * @category Attribute
1883
2384
  */
1884
2385
  ranksep: 'ranksep';
@@ -1911,8 +2412,12 @@ export declare namespace Attribute {
1911
2412
  * This feature only works in dot.
1912
2413
  *
1913
2414
  * @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
2415
+ *
2416
+ * | Key | Value |
2417
+ * | --- | --- |
2418
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/string/ string} |
2419
+ * | used by | G |
2420
+ *
1916
2421
  * @category Attribute
1917
2422
  */
1918
2423
  ratio: 'ratio';
@@ -1921,9 +2426,13 @@ export declare namespace Attribute {
1921
2426
  * {@link https://graphviz.org/doc/info/attrs.html in points}.
1922
2427
  *
1923
2428
  * @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
2429
+ *
2430
+ * | Key | Value |
2431
+ * | --- | --- |
2432
+ * | type | {@link https://graphviz.org/docs/attr-types/rect/ rect} |
2433
+ * | used by | N |
2434
+ * | notes | write only |
2435
+ *
1927
2436
  * @category Attribute
1928
2437
  */
1929
2438
  rects: 'rects';
@@ -1932,9 +2441,13 @@ export declare namespace Attribute {
1932
2441
  * the vertices of the polygon will lie on a circle whose center is the center of the node.
1933
2442
  *
1934
2443
  * @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
2444
+ *
2445
+ * | Key | Value |
2446
+ * | --- | --- |
2447
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
2448
+ * | default | FALSE |
2449
+ * | used by | N |
2450
+ *
1938
2451
  * @category Attribute
1939
2452
  */
1940
2453
  regular: 'regular';
@@ -1942,10 +2455,14 @@ export declare namespace Attribute {
1942
2455
  * If true and there are multiple clusters, run crossing minimization a second time.
1943
2456
  *
1944
2457
  * @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
2458
+ *
2459
+ * | Key | Value |
2460
+ * | --- | --- |
2461
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
2462
+ * | default | TRUE |
2463
+ * | used by | G |
2464
+ * | notes | dot only |
2465
+ *
1949
2466
  * @category Attribute
1950
2467
  */
1951
2468
  remincross: 'remincross';
@@ -1954,11 +2471,15 @@ export declare namespace Attribute {
1954
2471
  * Values larger than 1 tend to reduce the warping effect at the expense of less clustering.
1955
2472
  *
1956
2473
  * @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
2474
+ *
2475
+ * | Key | Value |
2476
+ * | --- | --- |
2477
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2478
+ * | default | 1 |
2479
+ * | minimum | 0 |
2480
+ * | used by | G |
2481
+ * | notes | sfdp only |
2482
+ *
1962
2483
  * @category Attribute
1963
2484
  */
1964
2485
  repulsiveforce: 'repulsiveforce';
@@ -1966,12 +2487,14 @@ export declare namespace Attribute {
1966
2487
  * This is a synonym for the {@link dpi} attribute.
1967
2488
  *
1968
2489
  * @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
2490
+ *
2491
+ * | Key | Value |
2492
+ * | --- | --- |
2493
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2494
+ * | default | 96.0 0.0 |
2495
+ * | used by | G |
2496
+ * | notes | svg, bitmap output only |
2497
+ *
1975
2498
  * @category Attribute
1976
2499
  */
1977
2500
  resolution: 'resolution';
@@ -1989,13 +2512,14 @@ export declare namespace Attribute {
1989
2512
  * If more than one node in a component is marked as the root, twopi will pick one.
1990
2513
  *
1991
2514
  * @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
2515
+ *
2516
+ * | Key | Value |
2517
+ * | --- | --- |
2518
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string}/{@link https://graphviz.org/docs/attr-types/bool/ bool} |
2519
+ * | default | <none>(graphs) false(nodes) |
2520
+ * | used by | GN |
2521
+ * | notes | circo, twopi only |
2522
+ *
1999
2523
  * @category Attribute
2000
2524
  */
2001
2525
  root: 'root';
@@ -2003,9 +2527,13 @@ export declare namespace Attribute {
2003
2527
  * If 90, set drawing orientation to landscape.
2004
2528
  *
2005
2529
  * @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
2530
+ *
2531
+ * | Key | Value |
2532
+ * | --- | --- |
2533
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2534
+ * | default | 0 |
2535
+ * | used by | G |
2536
+ *
2009
2537
  * @category Attribute
2010
2538
  */
2011
2539
  rotate: 'rotate';
@@ -2013,10 +2541,14 @@ export declare namespace Attribute {
2013
2541
  * Causes the final layout to be rotated counter-clockwise by the specified number of degrees.
2014
2542
  *
2015
2543
  * @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
2544
+ *
2545
+ * | Key | Value |
2546
+ * | --- | --- |
2547
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2548
+ * | default | 0 |
2549
+ * | used by | G |
2550
+ * | notes | sfdp only |
2551
+ *
2020
2552
  * @category Attribute
2021
2553
  */
2022
2554
  rotation: 'rotation';
@@ -2027,10 +2559,14 @@ export declare namespace Attribute {
2027
2559
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
2028
2560
  *
2029
2561
  * @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
2562
+ *
2563
+ * | Key | Value |
2564
+ * | --- | --- |
2565
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
2566
+ * | default | "" |
2567
+ * | used by | E |
2568
+ * | notes | dot only |
2569
+ *
2034
2570
  * @category Attribute
2035
2571
  */
2036
2572
  samehead: 'samehead';
@@ -2041,10 +2577,14 @@ export declare namespace Attribute {
2041
2577
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
2042
2578
  *
2043
2579
  * @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
2580
+ *
2581
+ * | Key | Value |
2582
+ * | --- | --- |
2583
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
2584
+ * | default | "" |
2585
+ * | used by | E |
2586
+ * | notes | dot only |
2587
+ *
2048
2588
  * @category Attribute
2049
2589
  */
2050
2590
  sametail: 'sametail';
@@ -2053,11 +2593,13 @@ export declare namespace Attribute {
2053
2593
  * It plays the same role in neato, when adjusting the layout to avoid overlapping nodes, and in image maps.
2054
2594
  *
2055
2595
  * @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
2596
+ *
2597
+ * | Key | Value |
2598
+ * | --- | --- |
2599
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2600
+ * | default | 8(output) 20(overlap and image maps) |
2601
+ * | used by | N |
2602
+ *
2061
2603
  * @category Attribute
2062
2604
  */
2063
2605
  samplepoints: 'samplepoints';
@@ -2066,9 +2608,12 @@ export declare namespace Attribute {
2066
2608
  * If only a single number is given, this is used for both factors.
2067
2609
  *
2068
2610
  * @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
2611
+ *
2612
+ * | Key | Value |
2613
+ * | --- | --- |
2614
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point} |
2615
+ * | used by | G |
2616
+ *
2072
2617
  * @category Attribute
2073
2618
  */
2074
2619
  scale: 'scale';
@@ -2076,10 +2621,14 @@ export declare namespace Attribute {
2076
2621
  * During network simplex, maximum number of edges with negative cut values to search when looking for one with minimum cut value.
2077
2622
  *
2078
2623
  * @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
2624
+ *
2625
+ * | Key | Value |
2626
+ * | --- | --- |
2627
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2628
+ * | default | 30 |
2629
+ * | used by | G |
2630
+ * | notes | dot only |
2631
+ *
2083
2632
  * @category Attribute
2084
2633
  */
2085
2634
  searchsize: 'searchsize';
@@ -2096,10 +2645,14 @@ export declare namespace Attribute {
2096
2645
  * 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
2646
  *
2098
2647
  * @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
2648
+ *
2649
+ * | Key | Value |
2650
+ * | --- | --- |
2651
+ * | type | {@link https://graphviz.org/docs/attr-types/addDouble/ addDouble}/{@link https://graphviz.org/_pages/doc/info/attrs.html#k:addPoint addPoint} |
2652
+ * | default | +4 |
2653
+ * | used by | G |
2654
+ * | notes | fdp, neato, sfdp, osage, circo, twopi only. |
2655
+ *
2103
2656
  * @category Attribute
2104
2657
  */
2105
2658
  sep: 'sep';
@@ -2107,9 +2660,13 @@ export declare namespace Attribute {
2107
2660
  * Set the shape of a node.
2108
2661
  *
2109
2662
  * @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
2663
+ *
2664
+ * | Key | Value |
2665
+ * | --- | --- |
2666
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:shape shape} |
2667
+ * | default | ellipse |
2668
+ * | used by | N |
2669
+ *
2113
2670
  * @category Attribute
2114
2671
  */
2115
2672
  shape: 'shape';
@@ -2121,9 +2678,13 @@ export declare namespace Attribute {
2121
2678
  * For further details, see {@link https://graphviz.org/docs/outputs/ Image Formats} and {@link https://graphviz.org/faq/#ext_image External PostScript files}.
2122
2679
  *
2123
2680
  * @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
2681
+ *
2682
+ * | Key | Value |
2683
+ * | --- | --- |
2684
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
2685
+ * | default | "" |
2686
+ * | used by | N |
2687
+ *
2127
2688
  * @deprecated
2128
2689
  * @category Attribute
2129
2690
  */
@@ -2132,11 +2693,15 @@ export declare namespace Attribute {
2132
2693
  * Print guide boxes in PostScript at the beginning of routesplines if 1, or at the end if 2. (Debugging)
2133
2694
  *
2134
2695
  * @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
2696
+ *
2697
+ * | Key | Value |
2698
+ * | --- | --- |
2699
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2700
+ * | default | 0 |
2701
+ * | minimum | 0 |
2702
+ * | used by | ENG |
2703
+ * | notes | dot only |
2704
+ *
2140
2705
  * @category Attribute
2141
2706
  */
2142
2707
  showboxes: 'showboxes';
@@ -2144,10 +2709,13 @@ export declare namespace Attribute {
2144
2709
  * Number of sides if {@link shape}=polygon.
2145
2710
  *
2146
2711
  * @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
2712
+ * | Key | Value |
2713
+ * | --- | --- |
2714
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2715
+ * | default | 4 |
2716
+ * | minimum | 0 |
2717
+ * | used by | N |
2718
+ *
2151
2719
  * @category Attribute
2152
2720
  */
2153
2721
  sides: 'sides';
@@ -2162,8 +2730,11 @@ export declare namespace Attribute {
2162
2730
  * Note that there is some interaction between the **size** and {@link ratio} attributes.
2163
2731
  *
2164
2732
  * @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
2733
+ * | Key | Value |
2734
+ * | --- | --- |
2735
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double}/{@link https://graphviz.org/docs/attr-types/point/ point} |
2736
+ * | used by | G |
2737
+ *
2167
2738
  * @category Attribute
2168
2739
  */
2169
2740
  size: 'size';
@@ -2171,10 +2742,13 @@ export declare namespace Attribute {
2171
2742
  * Skew factor for {@link shape}=polygon. Positive values skew top of polygon to right; negative to left.
2172
2743
  *
2173
2744
  * @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
2745
+ * | Key | Value |
2746
+ * | --- | --- |
2747
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
2748
+ * | default | 0 |
2749
+ * | minimum | -100 |
2750
+ * | used by | N |
2751
+ *
2178
2752
  * @category Attribute
2179
2753
  */
2180
2754
  skew: 'skew';
@@ -2182,10 +2756,13 @@ export declare namespace Attribute {
2182
2756
  * Specifies a post-processing step used to smooth out an uneven distribution of nodes.
2183
2757
  *
2184
2758
  * @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
2759
+ * | Key | Value |
2760
+ * | --- | --- |
2761
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:smoothType smoothType} |
2762
+ * | default | none |
2763
+ * | used by | G |
2764
+ * | notes | sfdp only |
2765
+ *
2189
2766
  * @category Attribute
2190
2767
  */
2191
2768
  smoothing: 'smoothing';
@@ -2194,10 +2771,13 @@ export declare namespace Attribute {
2194
2771
  * with smaller values inserted first.
2195
2772
  *
2196
2773
  * @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
2774
+ * | Key | Value |
2775
+ * | --- | --- |
2776
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int} |
2777
+ * | default | 0 |
2778
+ * | minimum | 0 |
2779
+ * | used by | GCN |
2780
+ *
2201
2781
  * @category Attribute
2202
2782
  */
2203
2783
  sortv: 'sortv';
@@ -2230,8 +2810,11 @@ export declare namespace Attribute {
2230
2810
  * then the edges are drawn to avoid clusters as well as nodes.
2231
2811
  *
2232
2812
  * @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
2813
+ * | Key | Value |
2814
+ * | --- | --- |
2815
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
2816
+ * | used by | G |
2817
+ *
2235
2818
  * @category Attribute
2236
2819
  */
2237
2820
  splines: 'splines';
@@ -2240,10 +2823,13 @@ export declare namespace Attribute {
2240
2823
  * 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
2824
  *
2242
2825
  * @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
2826
+ * | Key | Value |
2827
+ * | --- | --- |
2828
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:startType startType} |
2829
+ * | default | "" |
2830
+ * | used by | G |
2831
+ * | notes | fdp, neato only |
2832
+ *
2247
2833
  * @category Attribute
2248
2834
  */
2249
2835
  start: 'start';
@@ -2267,9 +2853,12 @@ export declare namespace Attribute {
2267
2853
  * Of course, the component can also explicitly set its style attribute to the desired value.
2268
2854
  *
2269
2855
  * @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
2856
+ * | Key | Value |
2857
+ * | --- | --- |
2858
+ * | type | {@link https://graphviz.org/_pages/doc/info/attrs.html#k:style style} |
2859
+ * | default | "" |
2860
+ * | used by | ENCG |
2861
+ *
2273
2862
  * @category Attribute
2274
2863
  */
2275
2864
  style: 'style';
@@ -2277,10 +2866,13 @@ export declare namespace Attribute {
2277
2866
  * A URL or pathname specifying an XML style sheet, used in SVG output.
2278
2867
  *
2279
2868
  * @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
2869
+ * | Key | Value |
2870
+ * | --- | --- |
2871
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
2872
+ * | default | "" |
2873
+ * | used by | G |
2874
+ * | notes | svg only |
2875
+ *
2284
2876
  * @category Attribute
2285
2877
  */
2286
2878
  stylesheet: 'stylesheet';
@@ -2290,10 +2882,13 @@ export declare namespace Attribute {
2290
2882
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
2291
2883
  *
2292
2884
  * @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
2885
+ * | Key | Value |
2886
+ * | --- | --- |
2887
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
2888
+ * | default | "" |
2889
+ * | used by | E |
2890
+ * | notes | svg, map only |
2891
+ *
2297
2892
  * @category Attribute
2298
2893
  */
2299
2894
  tailURL: 'tailURL';
@@ -2302,9 +2897,12 @@ export declare namespace Attribute {
2302
2897
  * The position indicates the center of the label.
2303
2898
  *
2304
2899
  * @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
2900
+ * | Key | Value |
2901
+ * | --- | --- |
2902
+ * | type | {@link https://graphviz.org/docs/attr-types/point/ point} |
2903
+ * | used by | E |
2904
+ * | notes | write only |
2905
+ *
2308
2906
  * @category Attribute
2309
2907
  */
2310
2908
  tail_lp: 'tail_lp';
@@ -2313,9 +2911,12 @@ export declare namespace Attribute {
2313
2911
  * the end of the edge goes to the center of the node, or the center of a port, if applicable.
2314
2912
  *
2315
2913
  * @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
2914
+ * | Key | Value |
2915
+ * | --- | --- |
2916
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
2917
+ * | default | TRUE |
2918
+ * | used by | E |
2919
+ *
2319
2920
  * @category Attribute
2320
2921
  */
2321
2922
  tailclip: 'tailclip';
@@ -2323,10 +2924,13 @@ export declare namespace Attribute {
2323
2924
  * Synonym for {@link tailURL}.
2324
2925
  *
2325
2926
  * @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
2927
+ * | Key | Value |
2928
+ * | --- | --- |
2929
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
2930
+ * | default | "" |
2931
+ * | used by | E |
2932
+ * | notes | svg, map only |
2933
+ *
2330
2934
  * @category Attribute
2331
2935
  */
2332
2936
  tailhref: 'tailhref';
@@ -2335,9 +2939,12 @@ export declare namespace Attribute {
2335
2939
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
2336
2940
  *
2337
2941
  * @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
2942
+ * | Key | Value |
2943
+ * | --- | --- |
2944
+ * | type | {@link https://graphviz.org/docs/attr-types/lblString/ lblString} |
2945
+ * | default | "" |
2946
+ * | used by | E |
2947
+ *
2341
2948
  * @category Attribute
2342
2949
  */
2343
2950
  taillabel: 'taillabel';
@@ -2346,9 +2953,12 @@ export declare namespace Attribute {
2346
2953
  * See {@link https://graphviz.org/doc/info/attrs.html#undir_note limitation}.
2347
2954
  *
2348
2955
  * @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
2956
+ * | Key | Value |
2957
+ * | --- | --- |
2958
+ * | type | {@link https://graphviz.org/docs/attr-types/portPos/ portPos} |
2959
+ * | default | center |
2960
+ * | used by | E |
2961
+ *
2352
2962
  * @category Attribute
2353
2963
  */
2354
2964
  tailport: 'tailport';
@@ -2358,10 +2968,13 @@ export declare namespace Attribute {
2358
2968
  * If undefined, the value of the {@link target} is used.
2359
2969
  *
2360
2970
  * @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
2971
+ * | Key | Value |
2972
+ * | --- | --- |
2973
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
2974
+ * | default | <none> |
2975
+ * | used by | E |
2976
+ * | notes | svg, map only |
2977
+ *
2365
2978
  * @category Attribute
2366
2979
  */
2367
2980
  tailtarget: 'tailtarget';
@@ -2370,10 +2983,13 @@ export declare namespace Attribute {
2370
2983
  * This is used only if the edge has a {@link tailURL} attribute.
2371
2984
  *
2372
2985
  * @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
2986
+ * | Key | Value |
2987
+ * | --- | --- |
2988
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
2989
+ * | default | "" |
2990
+ * | used by | E |
2991
+ * | notes | svg, cmap only |
2992
+ *
2377
2993
  * @category Attribute
2378
2994
  */
2379
2995
  tailtooltip: 'tailtooltip';
@@ -2382,10 +2998,13 @@ export declare namespace Attribute {
2382
2998
  * See {@link http://www.w3.org/TR/html401/present/frames.html#adef-target W3C documentation}.
2383
2999
  *
2384
3000
  * @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
3001
+ * | Key | Value |
3002
+ * | --- | --- |
3003
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString}/{@link https://graphviz.org/docs/attr-types/string/ string} |
3004
+ * | default | <none> |
3005
+ * | used by | ENGC |
3006
+ * | notes | svg, map only |
3007
+ *
2389
3008
  * @category Attribute
2390
3009
  */
2391
3010
  target: 'target';
@@ -2396,10 +3015,13 @@ export declare namespace Attribute {
2396
3015
  * In this case, if tooltips will be generated, the user should set a tooltip attribute explicitly.
2397
3016
  *
2398
3017
  * @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
3018
+ * | Key | Value |
3019
+ * | --- | --- |
3020
+ * | type | {@link https://graphviz.org/docs/attr-types/escString/ escString} |
3021
+ * | default | "" |
3022
+ * | used by | NEC |
3023
+ * | notes | svg, cmap only |
3024
+ *
2403
3025
  * @category Attribute
2404
3026
  */
2405
3027
  tooltip: 'tooltip';
@@ -2415,9 +3037,12 @@ export declare namespace Attribute {
2415
3037
  * Using **truecolor**=true avoids this problem.
2416
3038
  *
2417
3039
  * @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
3040
+ * | Key | Value |
3041
+ * | --- | --- |
3042
+ * | type | {@link https://graphviz.org/docs/attr-types/bool/ bool} |
3043
+ * | used by | G |
3044
+ * | notes | bitmap output only |
3045
+ *
2421
3046
  * @category Attribute
2422
3047
  */
2423
3048
  truecolor: 'truecolor';
@@ -2426,9 +3051,12 @@ export declare namespace Attribute {
2426
3051
  * If the node is an ellipse or circle, the {@link samplepoints} attribute affects the output.
2427
3052
  *
2428
3053
  * @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
3054
+ * | Key | Value |
3055
+ * | --- | --- |
3056
+ * | type | {@link https://graphviz.org/docs/attr-types/pointList/ pointList} |
3057
+ * | used by | N |
3058
+ * | notes | write only |
3059
+ *
2432
3060
  * @category Attribute
2433
3061
  */
2434
3062
  vertices: 'vertices';
@@ -2438,9 +3066,12 @@ export declare namespace Attribute {
2438
3066
  * The width and height of the viewport specify precisely the final size of the output.
2439
3067
  *
2440
3068
  * @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
3069
+ * | Key | Value |
3070
+ * | --- | --- |
3071
+ * | type | {@link https://graphviz.org/docs/attr-types/viewPort/ viewPort} |
3072
+ * | default | "" |
3073
+ * | used by | G |
3074
+ *
2444
3075
  * @category Attribute
2445
3076
  */
2446
3077
  viewport: 'viewport';
@@ -2449,11 +3080,14 @@ export declare namespace Attribute {
2449
3080
  * dim' = (1+2*margin)*dim.
2450
3081
  *
2451
3082
  * @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
3083
+ * | Key | Value |
3084
+ * | --- | --- |
3085
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
3086
+ * | default | 0.05 |
3087
+ * | minimum | 0 |
3088
+ * | used by | G |
3089
+ * | notes | not dot |
3090
+ *
2457
3091
  * @category Attribute
2458
3092
  */
2459
3093
  voro_margin: 'voro_margin';
@@ -2464,12 +3098,13 @@ export declare namespace Attribute {
2464
3098
  * For other layouts, a larger weight encourages the layout to make the edge length closer to that specified by the len attribute.
2465
3099
  *
2466
3100
  * @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
3101
+ * | Key | Value |
3102
+ * | --- | --- |
3103
+ * | type | {@link https://graphviz.org/docs/attr-types/int/ int}/{@link https://graphviz.org/docs/attr-types/double/ double} |
3104
+ * | default | 1 |
3105
+ * | minimum | 0(dot,twopi) 1(neato,fdp) |
3106
+ * | used by | E |
3107
+ *
2473
3108
  * @category Attribute
2474
3109
  */
2475
3110
  weight: 'weight';
@@ -2481,10 +3116,13 @@ export declare namespace Attribute {
2481
3116
  * Note also that, if the output format is dot, the value given to width will be the final value.
2482
3117
  *
2483
3118
  * @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
3119
+ * | Key | Value |
3120
+ * | --- | --- |
3121
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
3122
+ * | default | 0.75 |
3123
+ * | minimum | 0.01 |
3124
+ * | used by | N |
3125
+ *
2488
3126
  * @category Attribute
2489
3127
  */
2490
3128
  width: 'width';
@@ -2493,9 +3131,12 @@ export declare namespace Attribute {
2493
3131
  * If not set, the attribute will be set to the xdot version used for output.
2494
3132
  *
2495
3133
  * @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
3134
+ * | Key | Value |
3135
+ * | --- | --- |
3136
+ * | type | {@link https://graphviz.org/docs/attr-types/string/ string} |
3137
+ * | used by | G |
3138
+ * | notes | xdot only |
3139
+ *
2499
3140
  * @category Attribute
2500
3141
  */
2501
3142
  xdotversion: 'xdotversion';
@@ -2512,9 +3153,12 @@ export declare namespace Attribute {
2512
3153
  * To force placing all of them, use the {@link forcelabels} attribute.
2513
3154
  *
2514
3155
  * @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
3156
+ * | Key | Value |
3157
+ * | --- | --- |
3158
+ * | type | {@link https://graphviz.org/docs/attr-types/lblString/ lblString} |
3159
+ * | default | "" |
3160
+ * | used by | EN |
3161
+ *
2518
3162
  * @category Attribute
2519
3163
  */
2520
3164
  xlabel: 'xlabel';
@@ -2523,9 +3167,12 @@ export declare namespace Attribute {
2523
3167
  * The position indicates the center of the label.
2524
3168
  *
2525
3169
  * @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
3170
+ * | Key | Value |
3171
+ * | --- | --- |
3172
+ * | type | {@link https://graphviz.org/docs/attr-types/point/ point} |
3173
+ * | used by | NE |
3174
+ * | notes | write only |
3175
+ *
2529
3176
  * @category Attribute
2530
3177
  */
2531
3178
  xlp: 'xlp';
@@ -2542,12 +3189,13 @@ export declare namespace Attribute {
2542
3189
  *
2543
3190
  *
2544
3191
  * @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
3192
+ * | Key | Value |
3193
+ * | --- | --- |
3194
+ * | type | {@link https://graphviz.org/docs/attr-types/double/ double} |
3195
+ * | default | 0 |
3196
+ * | minimum | -MAXFLOAT, -1000 |
3197
+ * | used by | N |
3198
+ *
2551
3199
  * @deprecated
2552
3200
  * @category Attribute
2553
3201
  */
@@ -2863,7 +3511,7 @@ export declare namespace Color {
2863
3511
  * `"#%2x%2x%2x"` Red-Green-Blue (RGB)
2864
3512
  *
2865
3513
  * `"#%2x%2x%2x%2x"` Red-Green-Blue-Alpha (RGBA)
2866
- * @note A type that is too complicated to express in TypeScript.
3514
+ * @privateRemarks A type that is too complicated to express in TypeScript.
2867
3515
  */
2868
3516
  export type RGB_RGBA = `#${string}`;
2869
3517
  /**
@@ -2888,7 +3536,7 @@ export declare namespace Color {
2888
3536
  *
2889
3537
  * The sum of the floating-point numbers in a colorList must sum to at most 1.
2890
3538
  *
2891
- * @note A type that is too complicated to express in TypeScript.
3539
+ * @privateRemarks A type that is too complicated to express in TypeScript.
2892
3540
  *
2893
3541
  * @see {@link https://graphviz.gitlab.io/docs/attr-types/colorList/}
2894
3542
  * @group Attribute Types
@@ -3054,6 +3702,11 @@ to: EdgeTarget,
3054
3702
  */
3055
3703
  export declare type EscString = string;
3056
3704
 
3705
+ /**
3706
+ * Union type of all possible model types that can be filtered using type guards
3707
+ */
3708
+ export declare type FilterableModel = NodeModel | EdgeModel | SubgraphModel | RootGraphModel | AttributeListModel;
3709
+
3057
3710
  /**
3058
3711
  * @group Models
3059
3712
  */
@@ -3086,7 +3739,7 @@ export declare type GraphAttributesObject = AttributesObject<GraphAttributeKey>;
3086
3739
  * DOT model representing a graph/digraph/subgraph.
3087
3740
  * @group Models
3088
3741
  */
3089
- export declare interface GraphBaseModel<T extends AttributeKey = AttributeKey> extends HasComment, Attributes<T> {
3742
+ export declare interface GraphBaseModel<T extends DotObjectType = DotObjectType, K extends AttributeKey = AttributeKey> extends HasComment, Attributes<K>, DotObjectModel<T> {
3090
3743
  readonly id?: string;
3091
3744
  readonly attributes: Readonly<GraphCommonAttributes>;
3092
3745
  /** Node objects in the graph. */
@@ -3153,7 +3806,6 @@ export declare interface GraphBaseModel<T extends AttributeKey = AttributeKey> e
3153
3806
  /**
3154
3807
  * Get Node in cluster by specifying id.
3155
3808
  *
3156
- * @description
3157
3809
  * If there is no Node with the specified id in the graph, return undefined.
3158
3810
  */
3159
3811
  getNode(id: string): NodeModel | undefined;
@@ -3546,24 +4198,92 @@ export declare namespace Insensitive {
3546
4198
  */
3547
4199
  export declare type Int = number;
3548
4200
 
3549
- /** @hidden */
4201
+ /**
4202
+ * Type guard to check if an object is an AttributeListModel
4203
+ * @param object - Object to check (can be unknown or DotObjectModel)
4204
+ * @returns True if the object is an AttributeListModel
4205
+ */
4206
+ export declare function isAttributeListModel(object: unknown): object is AttributeListModel;
4207
+
4208
+ export declare function isAttributeListModel(model: DotObjectModel): model is AttributeListModel;
4209
+
4210
+ /**
4211
+ * Type guard to check if a string is a valid Compass direction
4212
+ * @param c - String to check
4213
+ * @returns True if the string is a valid Compass direction
4214
+ * @example
4215
+ * ```typescript
4216
+ * isCompass('n') // true
4217
+ * isCompass('northeast') // false
4218
+ * isCompass('invalid') // false
4219
+ * ```
4220
+ */
3550
4221
  export declare function isCompass(c: string): c is Compass;
3551
4222
 
3552
- /** @hidden */
4223
+ /**
4224
+ * Type guard to check if an object is an EdgeModel
4225
+ * @param object - Object to check (can be unknown or DotObjectModel)
4226
+ * @returns True if the object is an EdgeModel
4227
+ */
4228
+ export declare function isEdgeModel(object: unknown): object is EdgeModel;
4229
+
4230
+ export declare function isEdgeModel(model: DotObjectModel): model is EdgeModel;
4231
+
4232
+ /**
4233
+ * Type guard to check if an object is a ForwardRefNode
4234
+ * @param object - Object to check
4235
+ * @returns True if the object is a ForwardRefNode
4236
+ */
3553
4237
  export declare function isForwardRefNode(object: unknown): object is ForwardRefNode;
3554
4238
 
3555
- /** @hidden */
4239
+ /**
4240
+ * Type guard to check if an object is a NodeModel
4241
+ * @param object - Object to check (can be unknown or DotObjectModel)
4242
+ * @returns True if the object is a NodeModel
4243
+ */
3556
4244
  export declare function isNodeModel(object: unknown): object is NodeModel;
3557
4245
 
3558
- /** @hidden */
4246
+ export declare function isNodeModel(model: DotObjectModel): model is NodeModel;
4247
+
4248
+ /**
4249
+ * Type guard to check if an object is a NodeRef (either NodeModel or ForwardRefNode)
4250
+ * @param node - Object to check
4251
+ * @returns True if the object is a NodeRef
4252
+ */
3559
4253
  export declare function isNodeRef(node: unknown): node is NodeRef;
3560
4254
 
3561
- /** @hidden */
4255
+ /**
4256
+ * Type guard to check if an object is NodeRefGroupLike (array of NodeRefLike)
4257
+ * @param target - Object to check
4258
+ * @returns True if the object is NodeRefGroupLike
4259
+ */
3562
4260
  export declare function isNodeRefGroupLike(target: NodeRefLike | NodeRefGroupLike): target is NodeRefGroupLike;
3563
4261
 
3564
- /** @hidden */
4262
+ /**
4263
+ * Type guard to check if an object is NodeRefLike (string or NodeRef)
4264
+ * @param node - Object to check
4265
+ * @returns True if the object is NodeRefLike
4266
+ */
3565
4267
  export declare function isNodeRefLike(node: unknown): node is NodeRefLike;
3566
4268
 
4269
+ /**
4270
+ * Type guard to check if an object is a RootGraphModel
4271
+ * @param object - Object to check (can be unknown or DotObjectModel)
4272
+ * @returns True if the object is a RootGraphModel
4273
+ */
4274
+ export declare function isRootGraphModel(object: unknown): object is RootGraphModel;
4275
+
4276
+ export declare function isRootGraphModel(model: DotObjectModel): model is RootGraphModel;
4277
+
4278
+ /**
4279
+ * Type guard to check if an object is a SubgraphModel
4280
+ * @param object - Object to check (can be unknown or DotObjectModel)
4281
+ * @returns True if the object is a SubgraphModel
4282
+ */
4283
+ export declare function isSubgraphModel(object: unknown): object is SubgraphModel;
4284
+
4285
+ export declare function isSubgraphModel(model: DotObjectModel): model is SubgraphModel;
4286
+
3567
4287
  /**
3568
4288
  * list of strings separated by characters from the layersep attribute (by default, colons, tabs or spaces),
3569
4289
  * defining layer names and implicitly numbered 1,2,…
@@ -3820,12 +4540,11 @@ export declare interface RootGraphConstructor {
3820
4540
  * DOT model representing a root graphs(digraph and graph).
3821
4541
  * @group Models
3822
4542
  */
3823
- export declare interface RootGraphModel extends GraphBaseModel<GraphAttributeKey>, DotObjectModel<'Graph'> {
4543
+ export declare interface RootGraphModel extends GraphBaseModel<'Graph', GraphAttributeKey> {
3824
4544
  directed: boolean;
3825
4545
  /**
3826
4546
  * Strict mode.
3827
4547
  *
3828
- * @description
3829
4548
  * A graph may also be described as strict.
3830
4549
  * 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.
3831
4550
  * For undirected graphs, there can be at most one edge connected to the same two nodes.
@@ -3948,7 +4667,7 @@ export declare interface SubgraphConstructor {
3948
4667
  * DOT model representing a subgraph.
3949
4668
  * @group Models
3950
4669
  */
3951
- export declare interface SubgraphModel extends GraphBaseModel<SubgraphAttributeKey | ClusterSubgraphAttributeKey>, DotObjectModel<'Subgraph'> {
4670
+ export declare interface SubgraphModel extends GraphBaseModel<'Subgraph', SubgraphAttributeKey | ClusterSubgraphAttributeKey> {
3952
4671
  /** Determines whether the Subgraph is a SubgraphCluster. */
3953
4672
  isSubgraphCluster(): boolean;
3954
4673
  }
@@ -3977,10 +4696,30 @@ export declare namespace TBbalanceType {
3977
4696
  }
3978
4697
  }
3979
4698
 
3980
- /** @hidden */
4699
+ /**
4700
+ * Converts a NodeRefLike object to a NodeRef
4701
+ * @param target - NodeRefLike to convert (string or NodeRef)
4702
+ * @returns Converted NodeRef object
4703
+ * @example
4704
+ * ```typescript
4705
+ * toNodeRef('node1') // { id: 'node1' }
4706
+ * toNodeRef('node1:port1') // { id: 'node1', port: 'port1' }
4707
+ * toNodeRef('node1:port1:n') // { id: 'node1', port: 'port1', compass: 'n' }
4708
+ * ```
4709
+ */
3981
4710
  export declare function toNodeRef(target: NodeRefLike): NodeRef;
3982
4711
 
3983
- /** @hidden */
4712
+ /**
4713
+ * Converts a NodeRefGroupLike array to a NodeRefGroup
4714
+ * @param targets - Array of NodeRefLike objects to convert
4715
+ * @returns Array of NodeRef objects
4716
+ * @throws Error if targets array is empty or contains invalid elements
4717
+ * @example
4718
+ * ```typescript
4719
+ * toNodeRefGroup(['node1', 'node2:port'])
4720
+ * // [{ id: 'node1' }, { id: 'node2', port: 'port' }]
4721
+ * ```
4722
+ */
3984
4723
  export declare function toNodeRefGroup(targets: NodeRefGroupLike): NodeRefGroup;
3985
4724
 
3986
4725
  /**