Daniel@0: All Graphviz attributes are specified by name-value pairs. Thus, to
Daniel@0: set the fillcolor of a node abc, one would use
Daniel@0:
Daniel@0: At present, most device-independent units are either inches or
Daniel@0:
Daniel@0: points,
Daniel@0: which we take as 72 points per inch.
Daniel@0:
Daniel@0: - Damping
Daniel@0:
- Factor damping force motions. On each iteration, a nodes movement
Daniel@0: is limited to this factor of its potential motion. By being less than
Daniel@0: 1.0, the system tends to ``cool'', thereby preventing cycling.
Daniel@0:
Daniel@0:
- K
Daniel@0:
- Spring constant used in virtual physical model. It roughly corresponds
Daniel@0: to an ideal edge length (in inches), in that increasing K tends to
Daniel@0: increase the distance between nodes.
Daniel@0: Note that the edge attribute len can be used to
Daniel@0: override this value for adjacent nodes.
Daniel@0:
Daniel@0:
- URL
Daniel@0:
- Hyperlinks incorporated into device-dependent output.
Daniel@0: At present, used in ps2, cmap, i*map and svg formats.
Daniel@0: For all these formats, URLs can be attached to nodes, edges and
Daniel@0: clusters. URL attributes can also be attached to the root graph in ps2,
Daniel@0: cmap and i*map formats. This serves as the base URL for relative URLs in the
Daniel@0: former, and as the default image map file in the latter.
Daniel@0:
Daniel@0: For svg, cmapx and imap output, the active area for a node is its
Daniel@0: visible image.
Daniel@0: For example, an unfilled
Daniel@0: node with no drawn boundary will only be active on its label.
Daniel@0: For other output, the active area is its bounding box.
Daniel@0: The active area for a cluster is its bounding box.
Daniel@0: For edges, the active areas are small circles where the edge contacts its head
Daniel@0: and tail nodes. In addition, for svg, cmapx and imap, the active area
Daniel@0: includes a thin polygon approximating the edge. The circles may
Daniel@0: overlap the related node, and the edge URL dominates.
Daniel@0: If the edge has a label, this will also be active.
Daniel@0: Finally, if the edge has a head or tail label, this will also be active.
Daniel@0:
Daniel@0: Note that, for edges, the attributes headURL,
Daniel@0: tailURL, labelURL and
Daniel@0: edgeURL allow control of various parts of an
Daniel@0: edge.
Daniel@0: Also note that, if active areas of two edges overlap, it is unspecified
Daniel@0: which area dominates.
Daniel@0:
Daniel@0:
- arrowhead
Daniel@0:
- Style of arrowhead on the head node of an edge.
Daniel@0: See also the dir attribute,
Daniel@0: and a limitation.
Daniel@0:
Daniel@0:
- arrowsize
Daniel@0:
- Multiplicative scale factor for arrowheads.
Daniel@0:
Daniel@0:
- arrowtail
Daniel@0:
- Style of arrowhead on the tail node of an edge.
Daniel@0: See also the dir attribute,
Daniel@0: and a limitation.
Daniel@0:
Daniel@0:
- aspect
Daniel@0:
- Target aspect ratio (width of the layout divided by the height)
Daniel@0: of the graph drawing. If unset, dot minimizes the total edge length.
Daniel@0: For certain graphs, like those with large fan-in or fan-out, this can
Daniel@0: lead to very wide layouts. Setting aspect will cause dot to try
Daniel@0: to adjust the layout to get an aspect ratio close to that specified
Daniel@0: by aspect.
Daniel@0:
Daniel@0: By default, dot will do 5 passes attempting to achieve the desired
Daniel@0: aspect ratio. For certain graphs, more passes will be needed to get
Daniel@0: close enough. The aspect attribute can also be used to
Daniel@0: specify the maximum number of passes to try.
Daniel@0:
Daniel@0: At present, there is no mechanism for widening a very tall layout.
Daniel@0: Also, the algorithm doesn't handle clusters, nor disconnected graphs.
Daniel@0: For the latter case, one can split the pipeline
Daniel@0: ccomps -x | dot | gvpack | neato -n2
Daniel@0: to get a similar effect.
Daniel@0:
Daniel@0:
- bb
Daniel@0:
- Bounding box of drawing in points.
Daniel@0:
Daniel@0:
- bgcolor
Daniel@0:
- When attached to the root graph, this color is used as the background for
Daniel@0: entire canvas. When a cluster attribute, it is used as the initial
Daniel@0: background for the cluster. If a cluster has a filled
Daniel@0: style, the
Daniel@0: cluster's fillcolor will overlay the
Daniel@0: background color.
Daniel@0:
Daniel@0: If no background color is specified for the root graph, no graphics
Daniel@0: operation are performed on the background. This works fine for
Daniel@0: PostScript but for bitmap output, all bits are initialized to something.
Daniel@0: This means that when the bitmap output is included in some other
Daniel@0: document, all of the bits within the bitmap's bounding box will be
Daniel@0: set, overwriting whatever color or graphics where already on the page.
Daniel@0: If this effect is not desired, and you only want to set bits explicitly
Daniel@0: assigned in drawing the graph, set bgcolor="transparent".
Daniel@0:
Daniel@0:
- center
Daniel@0:
- If true, the drawing is centered in the output canvas.
Daniel@0:
Daniel@0:
- charset
Daniel@0:
- Specifies the character encoding used when interpreting string input
Daniel@0: as a text label. The default value is "UTF-8".
Daniel@0: The other legal value is "iso-8859-1" or,
Daniel@0: equivalently,
Daniel@0: "Latin1". The charset attribute is case-insensitive.
Daniel@0: Note that if the character encoding used in the input does not
Daniel@0: match the charset value, the resulting output may be very strange.
Daniel@0:
Daniel@0:
- clusterrank
Daniel@0:
- Mode used for handling clusters. If clusterrank is "local", a
Daniel@0: subgraph whose name begins with "cluster" is given special treatment.
Daniel@0: The subgraph is laid out separately, and then integrated as a unit into
Daniel@0: its parent graph, with a bounding rectangle drawn about it.
Daniel@0: If the cluster has a label parameter, this label
Daniel@0: is displayed within the rectangle.
Daniel@0: Note also that there can be clusters within clusters.
Daniel@0: At present, the modes "global" and "none"
Daniel@0: appear to be identical, both turning off the special cluster processing.
Daniel@0:
Daniel@0:
- color
Daniel@0:
- Basic drawing color for graphics, not text. For the latter, use the
Daniel@0: fontcolor attribute.
Daniel@0:
Daniel@0: For edges, the value
Daniel@0: can either be a single color or a colorList.
Daniel@0: In the latter case, the edge is drawn using parallel splines or lines,
Daniel@0: one for each color in the list, in the order given.
Daniel@0: The head arrow, if any, is drawn using the first color in the list,
Daniel@0: and the tail arrow, if any, the second color. This supports the common
Daniel@0: case of drawing opposing edges, but using parallel splines instead of
Daniel@0: separately routed multiedges. For example, the graph
Daniel@0:
Daniel@0: digraph G {
Daniel@0: a -> b [dir=both color="red:blue"]
Daniel@0: }
Daniel@0:
Daniel@0: yields
Daniel@0: 
Daniel@0:
Daniel@0: - colorscheme
Daniel@0:
- This attribute specifies a color scheme namespace. If defined, it specifies
Daniel@0: the context for interpreting color names. In particular, if a
Daniel@0: color value has form "xxx" or "//xxx",
Daniel@0: then the
Daniel@0: color xxx will be evaluated according to the current color scheme.
Daniel@0: If no color scheme is set, the standard X11 naming is used.
Daniel@0: For example, if colorscheme=bugn9, then color=7
Daniel@0: is interpreted as "/bugn9/7".
Daniel@0:
Daniel@0:
- comment
Daniel@0:
- Comments are inserted into output. Device-dependent
Daniel@0:
Daniel@0:
- compound
Daniel@0:
- If true, allow edges between clusters. (See lhead
Daniel@0: and ltail below.)
Daniel@0:
Daniel@0:
- concentrate
Daniel@0:
- If true, use edge concentrators.
Daniel@0: This merges multiedges into a single edge and causes partially parallel
Daniel@0: edges to share part of their paths. The latter feature is not yet available
Daniel@0: outside of dot.
Daniel@0:
Daniel@0:
- constraint
Daniel@0:
- If false, the edge is not used in ranking the nodes. For example,
Daniel@0: in the graph
Daniel@0:
Daniel@0: digraph G {
Daniel@0: a -> c;
Daniel@0: a -> b;
Daniel@0: b -> c [constraint=false];
Daniel@0: }
Daniel@0:
Daniel@0: the edge b -> c does not add a constraint during rank
Daniel@0: assignment, so the only constraints are that a be above b and c,
Daniel@0: yielding the graph:
Daniel@0: 
Daniel@0:
Daniel@0: - decorate
Daniel@0:
- If true, attach edge label to edge by a 2-segment
Daniel@0: polyline, underlining the label, then going to the closest point of spline.
Daniel@0:
Daniel@0:
- defaultdist
Daniel@0:
- This specifies the distance between nodes in separate connected
Daniel@0: components. If set too small, connected components may overlap.
Daniel@0: Only applicable if pack=false.
Daniel@0:
Daniel@0:
- dim
Daniel@0:
- Set the number of dimensions used for the layout. The maximum value
Daniel@0: allowed is 10.
Daniel@0:
Daniel@0:
- dimen
Daniel@0:
- Set the number of dimensions used for rendering.
Daniel@0: The maximum value allowed is 10.
Daniel@0: If both dimen and dim are set, the latter specifies
Daniel@0: the dimension used for layout, and the former for rendering.
Daniel@0: If only dimen is set, this is used for both layout and rendering
Daniel@0: dimensions.
Daniel@0:
Daniel@0:
- dir
Daniel@0:
- Set edge type for drawing arrowheads. This indicates which ends of the
Daniel@0: edge should be decorated with an arrowhead. The actual style of the
Daniel@0: arrowhead can be specified using the arrowhead
Daniel@0: and arrowtail attributes.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- diredgeconstraints
Daniel@0:
- Only valid when mode="ipsep".
Daniel@0: If true, constraints are generated for each edge in the largest (heuristic)
Daniel@0: directed acyclic subgraph such that the edge must point downwards.
Daniel@0: If "hier", generates level constraints similar to those used with
Daniel@0: mode="hier". The main difference is that, in the latter
Daniel@0: case, only these constraints are involved, so a faster solver can be used.
Daniel@0:
Daniel@0:
- distortion
Daniel@0:
- Distortion factor for shape=polygon.
Daniel@0: Positive values cause top part to
Daniel@0: be larger than bottom; negative values do the opposite.
Daniel@0:
Daniel@0:
- dpi
Daniel@0:
- This specifies the expected number of pixels per inch on a display device.
Daniel@0: For bitmap output, this guarantees that text rendering will be
Daniel@0: done more accurately, both in size and in placement. For SVG output,
Daniel@0: it is used to guarantee that the dimensions in the output correspond to
Daniel@0: the correct number of points or inches.
Daniel@0:
Daniel@0:
- edgeURL
Daniel@0:
- If edgeURL is defined, this is the link used for the non-label
Daniel@0: parts of an edge. This value overrides any URL
Daniel@0: defined for the edge.
Daniel@0: Also, this value is used near the head or tail node unless overridden
Daniel@0: by a headURL or tailURL value,
Daniel@0: respectively.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- edgehref
Daniel@0:
- Synonym for edgeURL.
Daniel@0:
Daniel@0:
- edgetarget
Daniel@0:
- If the edge has a URL or edgeURL
Daniel@0: attribute, this attribute determines which window of the
Daniel@0: browser is used
Daniel@0: for the URL attached to the non-label part of the edge.
Daniel@0: Setting it to "_graphviz" will open a new window if it
Daniel@0: doesn't already exist, or reuse it if it does.
Daniel@0: If undefined, the value of the target is used.
Daniel@0:
Daniel@0:
- edgetooltip
Daniel@0:
- Tooltip annotation attached to the non-label part of an edge.
Daniel@0: This is used only if the edge has a URL
Daniel@0: or edgeURL attribute.
Daniel@0:
Daniel@0:
- epsilon
Daniel@0:
- Terminating condition. If the length squared of all energy gradients are
Daniel@0: < epsilon, the algorithm stops.
Daniel@0:
Daniel@0:
- esep
Daniel@0:
- Margin used around polygons for purposes of spline edge routing.
Daniel@0: The interpretation is the same as given for sep.
Daniel@0: This should normally be strictly less than sep.
Daniel@0:
Daniel@0:
- fillcolor
Daniel@0:
- Color used to fill the background of a node or cluster
Daniel@0: assuming style=filled.
Daniel@0: If fillcolor is not defined, color is
Daniel@0: used. (For clusters, if color is not defined,
Daniel@0: bgcolor is used.) If this is not defined,
Daniel@0: the default is used, except for
Daniel@0: shape=point or when the output
Daniel@0: format is MIF,
Daniel@0: which use black by default.
Daniel@0:
Daniel@0: Note that a cluster inherits the root graph's attributes if defined.
Daniel@0: Thus, if the root graph has defined a fillcolor, this will override a
Daniel@0: color or bgcolor attribute set for the cluster.
Daniel@0:
Daniel@0:
- fixedsize
Daniel@0:
- If true, the node size is specified by the values of the
Daniel@0: width
Daniel@0: and height attributes only
Daniel@0: and is not expanded to contain the text label.
Daniel@0:
Daniel@0:
- fontcolor
Daniel@0:
- Color used for text.
Daniel@0:
Daniel@0:
- fontname
Daniel@0:
- Font used for text. This very much depends on the output format and, for
Daniel@0: non-bitmap output such as PostScript or SVG, the availability of the font
Daniel@0: when the graph is displayed or printed. As such, it is best to rely on
Daniel@0: font faces that are generally available, such as Times-Roman, Helvetica or
Daniel@0: Courier.
Daniel@0:
Daniel@0: If Graphviz was built using the
Daniel@0: fontconfig library, the latter library
Daniel@0: will be used to search for the font. However, if the fontname string
Daniel@0: contains a slash character "/", it is treated as a pathname for the font
Daniel@0: file, though font lookup will append the usual font suffixes.
Daniel@0:
Daniel@0: If Graphviz does not use fontconfig, fontname will be
Daniel@0: considered the name of a Type 1 or True Type font file.
Daniel@0: If you specify fontname=schlbk, the tool will look for a
Daniel@0: file named schlbk.ttf or schlbk.pfa or schlbk.pfb
Daniel@0: in one of the directories specified by
Daniel@0: the fontpath attribute.
Daniel@0: The lookup does support various aliases for the common fonts.
Daniel@0:
Daniel@0:
- fontnames
Daniel@0:
- Allows user control of how basic fontnames are represented in SVG output.
Daniel@0: If fontnames is undefined or "svg",
Daniel@0: the output will try to use known SVG fontnames. For example, the
Daniel@0: default font "Times-Roman" will be mapped to the
Daniel@0: basic SVG font "serif". This can be overridden by setting
Daniel@0: fontnames to "ps" or "gd".
Daniel@0: In the former case, known PostScript font names such as
Daniel@0: "Times-Roman" will be used in the output.
Daniel@0: In the latter case, the fontconfig font conventions
Daniel@0: are used. Thus, "Times-Roman" would be treated as
Daniel@0: "Nimbus Roman No9 L". These last two options are useful
Daniel@0: with SVG viewers that support these richer fontname spaces.
Daniel@0:
Daniel@0:
- fontpath
Daniel@0:
- Directory list used by libgd to search for bitmap fonts if Graphviz
Daniel@0: was not built with the fontconfig library.
Daniel@0: If fontpath is not set, the environment
Daniel@0: variable DOTFONTPATH is checked.
Daniel@0: If that is not set, GDFONTPATH is checked.
Daniel@0: If not set, libgd uses its compiled-in font path.
Daniel@0: Note that fontpath is an attribute of the root graph.
Daniel@0:
Daniel@0:
- fontsize
Daniel@0:
- Font size, in points, used for text.
Daniel@0:
Daniel@0:
- group
Daniel@0:
- If the end points of an edge belong to the same group, i.e., have the
Daniel@0: same group attribute, parameters are set to avoid crossings and keep
Daniel@0: the edges straight.
Daniel@0:
Daniel@0:
- headURL
Daniel@0:
- If headURL is defined, it is
Daniel@0: output as part of the head label of the edge.
Daniel@0: Also, this value is used near the head node, overriding any
Daniel@0: URL value.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- headclip
Daniel@0:
- If true, the head of an edge is clipped to the boundary of the head node;
Daniel@0: otherwise, the end of the edge goes to the center of the node, or the
Daniel@0: center of a port, if applicable.
Daniel@0:
Daniel@0:
- headhref
Daniel@0:
- Synonym for headURL.
Daniel@0:
Daniel@0:
- headlabel
Daniel@0:
- Text label to be placed near head of edge.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- headport
Daniel@0:
- Indicates where on the head node to attach the head of the edge.
Daniel@0: In the default case, the edge is aimed towards the center of the node,
Daniel@0: and then clipped at the node boundary.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- headtarget
Daniel@0:
- If the edge has a headURL,
Daniel@0: this attribute determines which window of the
Daniel@0: browser is used
Daniel@0: for the URL. Setting it to "_graphviz" will open a new window if it
Daniel@0: doesn't already exist, or reuse it if it does.
Daniel@0: If undefined, the value of the target is used.
Daniel@0:
Daniel@0:
- headtooltip
Daniel@0:
- Tooltip annotation attached to the head of an edge. This is used only
Daniel@0: if the edge has a headURL attribute.
Daniel@0:
Daniel@0:
- height
Daniel@0:
- Height of node, in inches. This is taken as the initial, minimum height
Daniel@0: of the node. If fixedsize is true, this
Daniel@0: will be the final height of the node. Otherwise, if the node label
Daniel@0: requires more height to fit, the node's height will be increased to
Daniel@0: contain the label. Note also that, if the output format is dot, the
Daniel@0: value given to height will be the final value.
Daniel@0:
Daniel@0:
- href
Daniel@0:
- Synonym for URL.
Daniel@0:
Daniel@0:
- id
Daniel@0:
- Allows the graph author to provide an id for graph objects which is to be included in the output.
Daniel@0: Normal "N", "E", "G" substitutions are applied.
Daniel@0: If provided, it is the reponsiblity of the provider to keep
Daniel@0: its values sufficiently unique for its intended downstream use.
Daniel@0: Note, in particular, that "E" does not provide a unique id for multi-edges.
Daniel@0: If no id attribute is provided, then a unique internal id is used, however this value is unpredictable by the graph writer.
Daniel@0: An externally provided id is not used internally.
Daniel@0:
Daniel@0:
- image
Daniel@0:
- Gives the name of a file containing an image to be displayed inside
Daniel@0: a node. The image file must be in one of the recognized
Daniel@0: formats,
Daniel@0: typically JPEG, PNG, GIF or Postscript, and be able to be converted
Daniel@0: into the desired output format.
Daniel@0:
Daniel@0: Unlike with the shapefile attribute,
Daniel@0: the image is treated as node
Daniel@0: content rather than the entire node. In particular, an image can
Daniel@0: be contained in a node of any shape, not just a rectangle.
Daniel@0:
Daniel@0:
- imagescale
Daniel@0:
- Attribute controlling how an image fills its
Daniel@0: containing node. In general, the image is given its natural size,
Daniel@0: (cf. dpi),
Daniel@0: and the node size is made large enough to contain its image, its
Daniel@0: label, its margin, and its peripheries.
Daniel@0: Its width and height will also be at least as large as its
Daniel@0: minimum width and height.
Daniel@0: If, however, fixedsize=true,
Daniel@0: the width and height attributes specify the exact size of the node.
Daniel@0:
Daniel@0: During rendering, in the default case (imagescale=false),
Daniel@0: the image retains its natural size.
Daniel@0: If imagescale=true,
Daniel@0: the image is uniformly scaled (i.e., its aspect ratio is
Daniel@0: preserved) to fit inside the node.
Daniel@0: At least one dimension of the image will be as large as possible
Daniel@0: given the size of the node.
Daniel@0: When imagescale=width,
Daniel@0: the width of the image is scaled to fill the node width.
Daniel@0: The corresponding property holds when imagescale=height.
Daniel@0: When imagescale=both,
Daniel@0: both the height and the width are scaled separately to fill the node.
Daniel@0:
Daniel@0: In all cases, if a dimension of the image is larger than the
Daniel@0: corresponding dimension of the node, that dimension of the
Daniel@0: image is scaled down to fit the node. As with the case of
Daniel@0: expansion, if imagescale=true, width and height are
Daniel@0: scaled uniformly.
Daniel@0:
Daniel@0:
- label
Daniel@0:
- Text label attached to objects.
Daniel@0: If a node's shape is record, then the label can
Daniel@0: have a special format
Daniel@0: which describes the record layout.
Daniel@0:
Daniel@0:
- labelURL
Daniel@0:
- If labelURL is defined, this is the link used for the label
Daniel@0: of an edge. This value overrides any URL
Daniel@0: defined for the edge.
Daniel@0:
Daniel@0:
- labelangle
Daniel@0:
- This, along with labeldistance, determine
Daniel@0: where the
Daniel@0: headlabel (taillabel) are placed with respect to the head (tail)
Daniel@0: in polar coordinates. The origin in the coordinate system is
Daniel@0: the point where the edge touches the node. The ray of 0 degrees
Daniel@0: goes from the origin back along the edge, parallel to the edge
Daniel@0: at the origin.
Daniel@0:
Daniel@0: The angle, in degrees, specifies the rotation from the 0 degree ray,
Daniel@0: with positive angles moving counterclockwise and negative angles
Daniel@0: moving clockwise.
Daniel@0:
Daniel@0:
- labeldistance
Daniel@0:
- Multiplicative scaling factor adjusting the distance that
Daniel@0: the headlabel(taillabel) is from the head(tail) node.
Daniel@0: The default distance is 10 points. See labelangle
Daniel@0: for more details.
Daniel@0:
Daniel@0:
- labelfloat
Daniel@0:
- If true, allows edge labels to be less constrained in position.
Daniel@0: In particular, it may appear on top of other edges.
Daniel@0:
Daniel@0:
- labelfontcolor
Daniel@0:
- Color used for headlabel and taillabel.
Daniel@0: If not set, defaults to edge's fontcolor.
Daniel@0:
Daniel@0:
- labelfontname
Daniel@0:
- Font used for headlabel and taillabel.
Daniel@0: If not set, defaults to edge's fontname.
Daniel@0:
Daniel@0:
- labelfontsize
Daniel@0:
- Font size, in points, used for headlabel and taillabel.
Daniel@0: If not set, defaults to edge's fontsize.
Daniel@0:
Daniel@0:
- labelhref
Daniel@0:
- Synonym for labelURL.
Daniel@0:
Daniel@0:
- labeljust
Daniel@0:
- Justification for cluster labels. If "r", the label
Daniel@0: is right-justified within bounding rectangle; if "l", left-justified;
Daniel@0: else the label is centered.
Daniel@0: Note that a subgraph inherits attributes from its parent. Thus, if
Daniel@0: the root graph sets labeljust to "l", the subgraph inherits
Daniel@0: this value.
Daniel@0:
Daniel@0:
- labelloc
Daniel@0:
- Top/bottom placement of graph and cluster labels.
Daniel@0: If the attribute is "t", place label at the top;
Daniel@0: if the attribute is "b", place label at the bottom.
Daniel@0: By default, root
Daniel@0: graph labels go on the bottom and cluster labels go on the top.
Daniel@0: Note that a subgraph inherits attributes from its parent. Thus, if
Daniel@0: the root graph sets labelloc to "b", the subgraph inherits
Daniel@0: this value.
Daniel@0:
Daniel@0:
- labelloc
Daniel@0:
- Vertical placement of node label. By default, if the height of a node
Daniel@0: is larger than the height of its label, the label is vertically centered.
Daniel@0: If labelloc is set to "t", "c", or "b", the label is aligned
Daniel@0: with the top, centered, or aligned with the bottom of the node, respectively.
Daniel@0:
Daniel@0:
- labeltarget
Daniel@0:
- If the edge has a URL or labelURL
Daniel@0: attribute, this attribute determines which window of the
Daniel@0: browser is used
Daniel@0: for the URL attached to the label.
Daniel@0: Setting it to "_graphviz" will open a new window if it
Daniel@0: doesn't already exist, or reuse it if it does.
Daniel@0: If undefined, the value of the target is used.
Daniel@0:
Daniel@0:
- labeltooltip
Daniel@0:
- Tooltip annotation attached to label of an edge.
Daniel@0: This is used only if the edge has a URL
Daniel@0: or labelURL attribute.
Daniel@0:
Daniel@0:
- landscape
Daniel@0:
- If true, the graph is rendered in landscape mode. Synonymous with
Daniel@0: rotate=90 or
Daniel@0: orientation=landscape.
Daniel@0:
Daniel@0:
- layer
Daniel@0:
- Specifies layers in which the node or edge is present.
Daniel@0:
Daniel@0:
- layers
Daniel@0:
- Specifies a linearly ordered list of layer names attached to the graph
Daniel@0: The graph is then output in separate layers. Only those components
Daniel@0: belonging to the current output layer appear. For more information,
Daniel@0: see the page How to use drawing layers (overlays).
Daniel@0:
Daniel@0:
- layersep
Daniel@0:
- Specifies the separator characters used to split the
Daniel@0: layers attribute into a list of layer names.
Daniel@0:
Daniel@0:
- layout
Daniel@0:
- Specifies the name of the layout algorithm to use, such as "dot"
Daniel@0: or "neato". Normally, graphs should be kept independent of a type of
Daniel@0: layout. In some cases, however, it can be convenient to embed the type
Daniel@0: of layout desired within the graph. For example, a graph containing
Daniel@0: position information from a layout might want to record what the
Daniel@0: associated layout algorithm was.
Daniel@0:
Daniel@0: This attribute takes precedence over
Daniel@0: the -K flag
Daniel@0: or the actual command name used.
Daniel@0:
Daniel@0:
- len
Daniel@0:
- Preferred edge length, in inches.
Daniel@0:
Daniel@0:
- levels
Daniel@0:
- Number of levels allowed in the multilevel scheme.
Daniel@0:
Daniel@0:
- levelsgap
Daniel@0:
- Specifies strictness of level constraints in neato
Daniel@0: when mode="ipsep" or "hier".
Daniel@0: Larger positive values mean stricter constraints, which demand more
Daniel@0: separation between levels. On the other hand, negative values will relax
Daniel@0: the constraints by allowing some overlap between the levels.
Daniel@0:
Daniel@0:
- lhead
Daniel@0:
- Logical head of an edge. When compound is true,
Daniel@0: if lhead is defined and is the name of a cluster containing
Daniel@0: the real head,
Daniel@0: the edge is clipped to the boundary of the cluster.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- lp
Daniel@0:
- Label position, in points.
Daniel@0: The position indicates the center of the label.
Daniel@0:
Daniel@0:
- ltail
Daniel@0:
- Logical tail of an edge. When compound is true,
Daniel@0: if ltail is defined and is the name of a cluster
Daniel@0: containing the real tail,
Daniel@0: the edge is clipped to the boundary of the cluster.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- margin
Daniel@0:
- For graphs, this sets x and y margins of canvas, in inches. If the margin
Daniel@0: is a single double, both margins are set equal to the given value.
Daniel@0:
Daniel@0: Note that the margin is not part of the drawing but just empty space
Daniel@0: left around the drawing. It basically corresponds to a translation of
Daniel@0: drawing, as would be necessary to center a drawing on a page. Nothing
Daniel@0: is actually drawn in the margin. To actually extend the background of
Daniel@0: a drawing, see the pad attribute.
Daniel@0:
Daniel@0: For nodes, this attribute specifies space left around the node's label.
Daniel@0: By default, the value is 0.11,0.055.
Daniel@0:
Daniel@0:
- maxiter
Daniel@0:
- Sets the number of iterations used.
Daniel@0:
Daniel@0:
- mclimit
Daniel@0:
- Multiplicative scale factor used to alter the MinQuit (default = 8)
Daniel@0: and MaxIter (default = 24) parameters used during crossing
Daniel@0: minimization. These correspond to the
Daniel@0: number of tries without improvement before quitting and the
Daniel@0: maximum number of iterations in each pass.
Daniel@0:
Daniel@0:
- mindist
Daniel@0:
- Specifies the minimum separation between all nodes.
Daniel@0:
Daniel@0:
- minlen
Daniel@0:
- Minimum edge length (rank difference between head and tail).
Daniel@0:
Daniel@0:
- mode
Daniel@0:
- Technique for optimizing the layout. If mode is "major",
Daniel@0: neato uses stress majorization. If mode is "KK",
Daniel@0: neato uses a version of the gradient descent method. The only advantage
Daniel@0: to the latter technique is that it is sometimes appreciably faster for
Daniel@0: small (number of nodes < 100) graphs. A significant disadvantage is that
Daniel@0: it may cycle.
Daniel@0:
Daniel@0: There are two new, experimental modes in neato, "hier", which adds a top-down
Daniel@0: directionality similar to the layout used in dot, and "ipsep", which
Daniel@0: allows the graph to specify minimum vertical and horizontal distances
Daniel@0: between nodes. (See the sep attribute.)
Daniel@0:
Daniel@0:
- model
Daniel@0:
- This value specifies how the distance matrix is computed for the input
Daniel@0: graph. The distance matrix specifies the ideal distance between every
Daniel@0: pair of nodes. neato attemps to find a layout which best achieves
Daniel@0: these distances. By default, it uses the length of the shortest path,
Daniel@0: where the length of each edge is given by its len
Daniel@0: attribute. If model is "circuit", neato uses the
Daniel@0: circuit resistance
Daniel@0: model to compute the distances. This tends to emphasize clusters. If
Daniel@0: model is "subset", neato uses the subset model. This sets the
Daniel@0: edge length to be the number of nodes that are neighbors of exactly one
Daniel@0: of the end points, and then calculates the shortest paths. This helps
Daniel@0: to separate nodes with high degree.
Daniel@0:
Daniel@0:
- mosek
Daniel@0:
- If Graphviz is built with MOSEK defined, mode=ipsep and mosek=true,
Daniel@0: the Mosek software (www.mosek.com) is use to solve the ipsep constraints.
Daniel@0:
Daniel@0:
- nodesep
Daniel@0:
- Minimum space between two adjacent nodes in the same rank, in inches.
Daniel@0:
Daniel@0:
- nojustify
Daniel@0:
- By default, the justification of multi-line labels is done within the
Daniel@0: largest context that makes sense. Thus, in the label of a polygonal
Daniel@0: node, a left-justified line will align with the left side of the node
Daniel@0: (shifted by the prescribed margin).
Daniel@0: In record nodes, left-justified
Daniel@0: line will line up with the left side of the enclosing column of fields.
Daniel@0: If nojustify is "true", multi-line labels will be justified
Daniel@0: in the context of itself. For example, if the attribute is set,
Daniel@0: the first label line is long, and the second is shorter and left-justified,
Daniel@0: the second will align with the left-most character in the first line,
Daniel@0: regardless of how large the node might be.
Daniel@0:
Daniel@0:
- normalize
Daniel@0:
- If set, normalize coordinates of final
Daniel@0: layout so that the first point is at the origin, and then rotate the
Daniel@0: layout so that the first edge is horizontal.
Daniel@0:
Daniel@0:
- nslimit
Daniel@0: ,
- nslimit1
Daniel@0:
- Used to set number of iterations in
Daniel@0: network simplex applications. nslimit is used in
Daniel@0: computing node x coordinates, nslimit1 for ranking nodes.
Daniel@0: If defined, # iterations = nslimit(1) * # nodes;
Daniel@0: otherwise, # iterations = MAXINT.
Daniel@0:
Daniel@0:
- ordering
Daniel@0:
- If "out" for a graph G, and n is a node in G, then edges n->* appear
Daniel@0: left-to-right in the same order in which they are defined.
Daniel@0: If "in", the edges *->n appear
Daniel@0: left-to-right in the same order in which they are defined for all
Daniel@0: nodes n.
Daniel@0:
Daniel@0:
- orientation
Daniel@0:
- Angle, in degrees, used to rotate polygon node shapes. For any number of polygon sides, 0 degrees rotation results in a flat base.
Daniel@0:
Daniel@0:
- orientation
Daniel@0:
- If "[lL]*", set graph orientation to landscape
Daniel@0: Used only if rotate is not defined.
Daniel@0:
Daniel@0:
- outputorder
Daniel@0:
- Specify order in which nodes and edges are drawn.
Daniel@0:
Daniel@0:
- overlap
Daniel@0:
- Determines if and how node overlaps should be removed. Nodes are first
Daniel@0: enlarged using the sep attribute.
Daniel@0: If "true" , overlaps are retained.
Daniel@0: If the value is "scale", overlaps are removed by uniformly scaling in x and y.
Daniel@0: If the value converts to "false", node overlaps are removed by a
Daniel@0: Voronoi-based technique.
Daniel@0: If the value is "scalexy", x and y are separately
Daniel@0: scaled to remove overlaps.
Daniel@0:
Daniel@0: If sfdp is available, one can set overlap to "prism" to use a
Daniel@0: proximity graph-based algorithm for overlap removal.
Daniel@0: This is the preferred technique,
Daniel@0: though "scale" and "false" can work well with small graphs.
Daniel@0: This technique starts with a
Daniel@0: small scaling up, controlled by the
Daniel@0: overlap_scaling attribute,
Daniel@0: which can remove a significant portion of the overlap.
Daniel@0: The prism option also accepts an optional non-negative integer suffix.
Daniel@0: This can be used to control the number of attempts made at overlap
Daniel@0: removal. By default, overlap="prism" is equivalent to
Daniel@0: overlap="prism1000". Setting overlap="prism0"
Daniel@0: causes only the scaling phase to be run.
Daniel@0:
Daniel@0: If the value is "compress", the layout will be scaled down as much as
Daniel@0: possible without introducing any overlaps, obviously assuming there are
Daniel@0: none to begin with.
Daniel@0:
Daniel@0: N.B.The remaining allowed values of overlap
Daniel@0: correspond to algorithms which, at present, can produce bad aspect ratios.
Daniel@0: In addition, we deprecate the use of the "ortho*" and "portho*".
Daniel@0:
Daniel@0: If the value is "vpsc", overlap removal is done as a
Daniel@0: quadratic optimization to minimize node displacement while removing
Daniel@0: node overlaps.
Daniel@0:
Daniel@0: If the value is "orthoxy" or "orthoyx", overlaps
Daniel@0: are moved by optimizing two constraint problems, one for the x axis and
Daniel@0: one for the y. The suffix indicates which axis is processed first.
Daniel@0: If the value is "ortho", the technique is similar to "orthoxy" except a
Daniel@0: heuristic is used to reduce the bias between the two passes.
Daniel@0: If the value is "ortho_yx", the technique is the same as "ortho", except
Daniel@0: the roles of x and y are reversed.
Daniel@0: The values "portho", "porthoxy", "porthoxy", and "portho_yx" are similar
Daniel@0: to the previous four, except only pseudo-orthogonal ordering is
Daniel@0: enforced.
Daniel@0:
Daniel@0: If the layout is done by neato with mode="ipsep",
Daniel@0: then one can use overlap=ipsep.
Daniel@0: In this case, the overlap removal constraints are
Daniel@0: incorporated into the layout algorithm itself.
Daniel@0: N.B. At present, this only supports one level of clustering.
Daniel@0:
Daniel@0: Except for fdp and sfdp, the layouts assume overlap="true" as the default.
Daniel@0: Fdp first uses a number of passes using built-in, force-directed technique
Daniel@0: to remove overlaps. Thus, fdp accepts overlap with an integer
Daniel@0: prefix followed by a colon, specifying the number of tries. If there is
Daniel@0: no prefix, no initial tries will be performed. If there is nothing following
Daniel@0: a colon, none of the above methods will be attempted. By default, fdp
Daniel@0: uses overlap="9:portho". Note that overlap="true",
Daniel@0: overlap="0:true" and overlap="0:" all turn off all overlap
Daniel@0: removal.
Daniel@0:
Daniel@0: By default, sfdp uses overlap="prism0".
Daniel@0:
Daniel@0: Except for the Voronoi and prism methods, all of these transforms preserve the
Daniel@0: orthogonal ordering of the original layout. That is, if the x coordinates
Daniel@0: of two nodes are originally the same, they will remain the same, and if
Daniel@0: the x coordinate of one node is originally less than the x coordinate of
Daniel@0: another, this relation will still hold in the transformed layout. The
Daniel@0: similar properties hold for the y coordinates.
Daniel@0: This is not quite true for the "porth*" cases. For these, orthogonal
Daniel@0: ordering is only preserved among nodes related by an edge.
Daniel@0:
Daniel@0:
- overlap_scaling
Daniel@0:
- When overlap=prism, the layout is scaled by this factor, thereby
Daniel@0: removing a fair amount of node overlap, and making node overlap removal
Daniel@0: faster and better able to retain the graph's shape.
Daniel@0:
Daniel@0: If overlap_scaling is negative, the layout is scaled by
Daniel@0: -1*overlap_scaling times the average label size.
Daniel@0: If overlap_scaling is positive, the layout is scaled by
Daniel@0: overlap_scaling.
Daniel@0: If overlap_scaling is zero, no scaling is done.
Daniel@0:
Daniel@0:
- pack
Daniel@0:
- This is true if the value of pack is "true" (case-insensitive) or a
Daniel@0: non-negative integer. If true, each connected component of the graph is
Daniel@0: laid out separately, and then the graphs are packed together.
Daniel@0: If pack has an integral value, this is used as the size,
Daniel@0: in points, of
Daniel@0: a margin around each part; otherwise, a default margin of 8 is used.
Daniel@0: If pack is interpreted as false, the entire graph is laid out together.
Daniel@0: The granularity and method of packing is influenced by the
Daniel@0: packmode attribute.
Daniel@0:
Daniel@0: For layouts which always do packing, such a twopi, the pack
Daniel@0: attribute is just used to set the margin.
Daniel@0:
Daniel@0:
- packmode
Daniel@0:
- This indicates how connected components should be packed
Daniel@0: (cf. packMode). Note that defining
Daniel@0: packmode will automatically turn on packing as though one had
Daniel@0: set pack=true.
Daniel@0:
Daniel@0:
- pad
Daniel@0:
- The pad attribute specifies how much, in inches, to extend the
Daniel@0: drawing area around the minimal area needed to draw the graph.
Daniel@0: If the pad is a single double, both the x and y pad values are set
Daniel@0: equal to the given value. This area is part of the
Daniel@0: drawing and will be filled with the background color, if appropriate.
Daniel@0:
Daniel@0: Normally, a small pad is used for aesthetic reasons, especially when
Daniel@0: a background color is used, to avoid having nodes and edges abutting
Daniel@0: the boundary of the drawn region.
Daniel@0:
Daniel@0:
- page
Daniel@0:
- Width and height of output pages, in inches. If this is set and is
Daniel@0: smaller than the size of the layout, a rectangular array of pages of
Daniel@0: the specified page size is overlaid on the layout, with origins
Daniel@0: aligned in the lower-left corner, thereby partitioning the layout
Daniel@0: into pages. The pages are then produced one at a time, in
Daniel@0: pagedir order.
Daniel@0:
Daniel@0: At present, this only works for PostScript output. For other types of
Daniel@0: output, one should use another tool to split the output into multiple
Daniel@0: output files. Or use the viewport to generate
Daniel@0: multiple files.
Daniel@0:
Daniel@0:
- pagedir
Daniel@0:
- If the page attribute is set and applicable,
Daniel@0: this attribute specifies the order in which the pages are emitted.
Daniel@0: This is limited to one of the 8 row or column major orders.
Daniel@0:
Daniel@0:
- pencolor
Daniel@0:
- Color used to draw the bounding box around a cluster.
Daniel@0: If pencolor is not defined, color is
Daniel@0: used. If this is not defined, bgcolor is used.
Daniel@0: If this is not defined, the default is used.
Daniel@0:
Daniel@0: Note that a cluster inherits the root graph's attributes if defined.
Daniel@0: Thus, if the root graph has defined a pencolor, this will override a
Daniel@0: color or bgcolor attribute set for the cluster.
Daniel@0:
Daniel@0:
- penwidth
Daniel@0:
- Specifies the width of the pen, in points, used to draw lines and curves,
Daniel@0: including the boundaries of edges and clusters. The value is inherited
Daniel@0: by subclusters.
Daniel@0: It has no effect on text.
Daniel@0:
Daniel@0: Previous to 31 January 2008, the effect of penwidth=W
Daniel@0: was achieved by including setlinewidth(W)
Daniel@0: as part of a style specification.
Daniel@0: If both are used, penwidth will be used.
Daniel@0:
Daniel@0:
- peripheries
Daniel@0:
- Set number of peripheries used in polygonal shapes and cluster
Daniel@0: boundaries. Note that
Daniel@0: user-defined shapes are treated as a
Daniel@0: form of box shape, so the default
Daniel@0: peripheries value is 1 and the user-defined shape will be drawn in
Daniel@0: a bounding rectangle. Setting peripheries=0 will turn this off.
Daniel@0: Also, 1 is the maximum peripheries value for clusters.
Daniel@0:
Daniel@0:
- pin
Daniel@0:
- If true and the node has a pos attribute on input, neato or fdp prevents the
Daniel@0: node from moving from the input position. This property can also be specified
Daniel@0: in the pos attribute itself (cf. the point type).
Daniel@0:
Daniel@0: Note: Due to an artifact of the implementation, final coordinates
Daniel@0: are translated to the origin. Thus, if you look at the output coordinates
Daniel@0: given in the (x)dot or plain format, pinned nodes will not have the same
Daniel@0: output coordinates as were given on input. If this is important, a
Daniel@0: simple workaround is to maintain the coordinates of a pinned node. The vector
Daniel@0: difference between the old and new coordinates will give the translation,
Daniel@0: which can then be subtracted from all of the appropriate coordinates.
Daniel@0:
Daniel@0:
- pos
Daniel@0:
- Position of node, or spline control points.
Daniel@0: For nodes, the position indicates the center of the node.
Daniel@0: On output, the coordinates are in points.
Daniel@0:
Daniel@0: In neato and fdp, pos can be used to set the initial position of a node.
Daniel@0: By default, the coordinates are assumed to be in inches. However, the
Daniel@0: -s command line flag can be used to specify
Daniel@0: different units. As the output coordinates are in points,
Daniel@0: feeding the output of a graph laid out by a Graphviz program into
Daniel@0: neato or fdp will almost always require the -s flag.
Daniel@0:
Daniel@0: When the -n command line flag is used with
Daniel@0: neato, it is assumed the positions have been set by one of the layout
Daniel@0: programs, and are therefore in points. Thus, neato -n can accept
Daniel@0: input correctly without requiring a -s flag and, in fact,
Daniel@0: ignores any such flag.
Daniel@0:
Daniel@0:
- quadtree
Daniel@0:
- Quadtree scheme to use.
Daniel@0:
Daniel@0: A TRUE bool value corresponds to "normal";
Daniel@0: a FALSE bool value corresponds to "none".
Daniel@0: As a slight exception to the normal interpretation of bool,
Daniel@0: a value of "2" corresponds to "fast".
Daniel@0:
Daniel@0:
- quantum
Daniel@0:
- If quantum > 0.0, node label dimensions
Daniel@0: will be rounded to integral multiples of the quantum.
Daniel@0:
Daniel@0:
- rank
Daniel@0:
- Rank constraints on the nodes in a subgraph.
Daniel@0: If rank="same", all nodes are placed on the same rank.
Daniel@0: If rank="min", all nodes are placed on the minimum rank.
Daniel@0: If rank="source", all nodes are placed on the minimum rank, and
Daniel@0: the only nodes on the minimum rank belong to some subgraph whose
Daniel@0: rank attribute is "source" or "min".
Daniel@0: Analogous criteria hold for rank="max" and rank="sink".
Daniel@0: (Note: the
Daniel@0: minimum rank is topmost or leftmost, and the maximum rank is bottommost
Daniel@0: or rightmost.)
Daniel@0:
Daniel@0:
- rankdir
Daniel@0:
- Sets direction of graph layout. For example, if rankdir="LR",
Daniel@0: and barring cycles, an edge
T -> H; will go
Daniel@0: from left to right. By default, graphs are laid out from top to bottom.
Daniel@0:
Daniel@0: This attribute also has a side-effect in determining how record nodes
Daniel@0: are interpreted. See record shapes.
Daniel@0:
Daniel@0:
- ranksep
Daniel@0:
- In dot, this gives the desired rank separation, in inches. This is
Daniel@0: the minimum vertical distance between the bottom of the nodes in one
Daniel@0: rank and the tops of nodes in the next. If the value
Daniel@0: contains "equally", the centers of all ranks are spaced equally apart.
Daniel@0: Note that both
Daniel@0: settings are possible, e.g., ranksep = "1.2 equally".
Daniel@0: In twopi, specifies radial separation of concentric circles.
Daniel@0:
Daniel@0:
- ratio
Daniel@0:
- Sets the aspect ratio (drawing height/drawing width) for the drawing.
Daniel@0: Note that this is adjusted before
Daniel@0: the size attribute constraints are enforced.
Daniel@0:
Daniel@0: If ratio is numeric, it is taken as the desired aspect ratio.
Daniel@0: Then, if the actual aspect ratio is less than the desired ratio,
Daniel@0: the drawing height is scaled up to achieve the
Daniel@0: desired ratio; if the actual ratio is greater than that desired ratio,
Daniel@0: the drawing width is scaled up.
Daniel@0:
Daniel@0: If ratio = "fill" and the size
Daniel@0: attribute is set, node positions are scaled, separately in both x
Daniel@0: and y, so that the final drawing exactly fills the specified size.
Daniel@0:
Daniel@0: If ratio = "compress" and the size
Daniel@0: attribute is set, dot attempts to compress the initial layout to fit
Daniel@0: in the given size. This achieves a tighter packing of nodes but
Daniel@0: reduces the balance and symmetry. This feature only works in dot.
Daniel@0:
Daniel@0: If ratio = "expand", the size
Daniel@0: attribute is set, and both the width and the height of the graph are
Daniel@0: less than the value in size, node positions are scaled
Daniel@0: uniformly until at least
Daniel@0: one dimension fits size exactly.
Daniel@0: Note that this is distinct from using size as the
Daniel@0: desired size, as here the drawing is expanded before edges are generated and
Daniel@0: all node and text sizes remain unchanged.
Daniel@0:
Daniel@0: If ratio = "auto", the page
Daniel@0: attribute is set and the graph cannot be drawn on a single page,
Daniel@0: then size is set to an ``ideal'' value.
Daniel@0: In particular, the size in a given dimension will be the smallest integral
Daniel@0: multiple of the page size in that dimension which is at least half the
Daniel@0: current size. The two dimensions are then scaled independently to the
Daniel@0: new size. This feature only works in dot.
Daniel@0:
Daniel@0:
- rects
Daniel@0:
- Rectangles for fields of records, in points.
Daniel@0:
Daniel@0:
- regular
Daniel@0:
- If true, force polygon to be regular.
Daniel@0:
Daniel@0:
- remincross
Daniel@0:
- If true and there are multiple clusters, run cross
Daniel@0: minimization a second time.
Daniel@0:
Daniel@0:
- repulsiveforce
Daniel@0:
- The power of the repulsive force used in an extended Fruchterman-Reingold
Daniel@0: force directed model. Values larger than 1 tend to reduce
Daniel@0: the warping effect at the expense of less clustering.
Daniel@0:
Daniel@0:
- resolution
Daniel@0:
- This is a synonym for the dpi attribute.
Daniel@0:
Daniel@0:
- root
Daniel@0:
- This specifies nodes to be used as the center of the
Daniel@0: layout and the root of the generated spanning tree. As a graph attribute,
Daniel@0: this gives the name of the node. As a node attribute (circo only), it
Daniel@0: specifies that the node should be used as a central node. In twopi,
Daniel@0: this will actually be the central node. In circo, the block containing
Daniel@0: the node will be central in the drawing of its connected component.
Daniel@0: If not defined,
Daniel@0: twopi will pick a most central node, and circo will pick a random node.
Daniel@0:
Daniel@0:
- rotate
Daniel@0:
- If 90, set drawing orientation to landscape.
Daniel@0:
Daniel@0:
- samehead
Daniel@0:
- Edges with the same head and the same samehead value are aimed
Daniel@0: at the same point on the head.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- sametail
Daniel@0:
- Edges with the same tail and the same sametail value are aimed
Daniel@0: at the same point on the tail.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- samplepoints
Daniel@0:
- If the input graph defines the vertices
Daniel@0: attribute, and output is dot or xdot, this gives
Daniel@0: the number of points used for a node whose shape is a circle or ellipse.
Daniel@0: It plays the same role in neato, when adjusting the layout to avoid
Daniel@0: overlapping nodes, and in image maps.
Daniel@0:
Daniel@0:
- searchsize
Daniel@0:
- During network simplex, maximum number of edges with negative cut values
Daniel@0: to search when looking for one with minimum cut value.
Daniel@0:
Daniel@0:
- sep
Daniel@0:
- Specifies margin to leave around nodes when removing node overlap.
Daniel@0: This guarantees a minimal non-zero distance between nodes.
Daniel@0:
Daniel@0: If the attribute begins with a plus sign '+', an additive margin is
Daniel@0: specified. That is, "+w,h" causes the node's bounding box to be increased
Daniel@0: by w
Daniel@0: points on the left and right sides, and by h points on the top and bottom.
Daniel@0: Without a plus sign, the node is scaled by 1 + w in the x coordinate
Daniel@0: and 1 + h in the y coordinate.
Daniel@0:
Daniel@0: If only a single number is given, this is used for both dimensions.
Daniel@0:
Daniel@0: If unset but esep is defined, the sep values
Daniel@0: will be set to the esep values divided by 0.8.
Daniel@0: If esep is unset, the default value is used.
Daniel@0:
Daniel@0:
- shape
Daniel@0:
- Set the shape of a node.
Daniel@0:
Daniel@0:
- shapefile
Daniel@0:
- (Deprecated) If defined, shapefile specifies a file containing user-supplied node content.
Daniel@0: The shape of the node is set to box.
Daniel@0: The image in the shapefile must be
Daniel@0: rectangular. The image formats supported as well as the precise semantics of
Daniel@0: how the file is used depends on the
Daniel@0: output format. For further details, see
Daniel@0: Image Formats and
Daniel@0: External PostScript files.
Daniel@0:
Daniel@0: There is one exception to this usage.
Daniel@0: If shape is set to "epsf", shapefile gives
Daniel@0: a filename containing a definition of the node in PostScript.
Daniel@0: The graphics defined must be contain all of the
Daniel@0: node content, including any desired boundaries.
Daniel@0: For further details, see
Daniel@0:
Daniel@0: External PostScript files.
Daniel@0:
Daniel@0:
- showboxes
Daniel@0:
- Print guide boxes in PostScript at the beginning of
Daniel@0: routesplines if 1, or at the end if 2. (Debugging)
Daniel@0:
Daniel@0:
- sides
Daniel@0:
- Number of sides if shape=polygon.
Daniel@0:
Daniel@0:
- size
Daniel@0:
- Maximum width and height of drawing, in inches.
Daniel@0: If defined and the drawing is too large, the drawing is uniformly
Daniel@0: scaled down so that it fits within the given size.
Daniel@0:
Daniel@0: If size ends in an exclamation point (!),
Daniel@0: then it is taken to be
Daniel@0: the desired size. In this case, if both dimensions of the drawing are
Daniel@0: less than size, the drawing is scaled up uniformly until at
Daniel@0: least one dimension equals its dimension in size.
Daniel@0:
Daniel@0: Note that there is some interaction between the size and
Daniel@0: ratio attributes.
Daniel@0:
Daniel@0:
- skew
Daniel@0:
- Skew factor for shape=polygon. Positive values
Daniel@0: skew top of polygon to right; negative to left.
Daniel@0:
Daniel@0:
- smoothing
Daniel@0:
- Specifies a post-processing step used to smooth out an uneven distribution
Daniel@0: of nodes.
Daniel@0:
Daniel@0:
- sortv
Daniel@0:
- If packmode indicates an array packing,
Daniel@0: this attribute specifies an
Daniel@0: insertion order among the components, with smaller values inserted first.
Daniel@0:
Daniel@0:
- splines
Daniel@0:
- Controls how, and if, edges are represented. If true, edges are drawn as
Daniel@0: splines routed around nodes; if false, edges are drawn as line segments.
Daniel@0: If set to "", no edges are drawn at all.
Daniel@0:
Daniel@0: (1 March 2007) The values line and spline can be
Daniel@0: used as synonyms for false and true, respectively.
Daniel@0: In addition, the value polyline specifies that edges should be
Daniel@0: drawn as polylines.
Daniel@0:
Daniel@0: By default, the attribute is unset. How this is interpreted depends on
Daniel@0: the layout. For dot, the default is to draw edges as splines. For all
Daniel@0: other layouts, the default is to draw edges as line segments. Note that
Daniel@0: for these latter layouts, if splines="true", this
Daniel@0: requires non-overlapping nodes (cf. overlap).
Daniel@0: If fdp is used for layout and splines="compound", then the edges are
Daniel@0: drawn to avoid clusters as well as nodes.
Daniel@0:
Daniel@0:
- start
Daniel@0:
- Parameter used to determine the initial layout of nodes. If unset, the
Daniel@0: nodes are randomly placed in a unit square with
Daniel@0: the same seed is always used for the random number generator, so the
Daniel@0: initial placement is repeatable.
Daniel@0:
Daniel@0:
- style
Daniel@0:
- Set style for node or edge. For cluster subgraph, if "filled", the
Daniel@0: cluster box's background is filled.
Daniel@0:
Daniel@0:
- stylesheet
Daniel@0:
- A URL or pathname specifying an XML style sheet, used in SVG output.
Daniel@0:
Daniel@0:
- tailURL
Daniel@0:
- If tailURL is defined, it is
Daniel@0: output as part of the tail label of the edge.
Daniel@0: Also, this value is used near the tail node, overriding any
Daniel@0: URL value.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- tailclip
Daniel@0:
- If true, the tail of an edge is clipped to the boundary of the tail node;
Daniel@0: otherwise, the end of the edge goes to the center of the node, or the
Daniel@0: center of a port, if applicable.
Daniel@0:
Daniel@0:
- tailhref
Daniel@0:
- Synonym for tailURL.
Daniel@0:
Daniel@0:
- taillabel
Daniel@0:
- Text label to be placed near tail of edge.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- tailport
Daniel@0:
- Indicates where on the tail node to attach the tail of the edge.
Daniel@0: See limitation.
Daniel@0:
Daniel@0:
- tailtarget
Daniel@0:
- If the edge has a tailURL,
Daniel@0: this attribute determines which window of the
Daniel@0: browser is used
Daniel@0: for the URL. Setting it to "_graphviz" will open a new window if it
Daniel@0: doesn't already exist, or reuse it if it does.
Daniel@0: If undefined, the value of the target is used.
Daniel@0:
Daniel@0:
- tailtooltip
Daniel@0:
- Tooltip annotation attached to the tail of an edge. This is used only
Daniel@0: if the edge has a tailURL attribute.
Daniel@0:
Daniel@0:
- target
Daniel@0:
- If the object has a URL, this attribute determines which window
Daniel@0: of the browser is used for the URL.
Daniel@0: See W3C documentation.
Daniel@0:
Daniel@0:
- tooltip
Daniel@0:
- Tooltip annotation attached to the node or edge. If unset, Graphviz
Daniel@0: will use the object's label if defined.
Daniel@0: Note that if the label is a record specification or an HTML-like
Daniel@0: label, the resulting tooltip may be unhelpful. In this case, if
Daniel@0: tooltips will be generated, the user should set a tooltip
Daniel@0: attribute explicitly.
Daniel@0:
Daniel@0:
- truecolor
Daniel@0:
- If set explicitly to true or false, the value determines whether or not
Daniel@0: internal bitmap rendering relies on a truecolor color model or uses
Daniel@0: a color palette.
Daniel@0: If the attribute is unset, truecolor is not used
Daniel@0: unless there is a shapefile property
Daniel@0: for some node in the graph.
Daniel@0: The output model will use the input model when possible.
Daniel@0:
Daniel@0: Use of color palettes results in less memory usage during creation of the
Daniel@0: bitmaps and smaller output files.
Daniel@0:
Daniel@0: Usually, the only time it is necessary to specify the truetype model
Daniel@0: is if the graph uses more than 256 colors.
Daniel@0: However, if one uses bgcolor=transparent with
Daniel@0: a color palette, font
Daniel@0: antialiasing can show up as a fuzzy white area around characters.
Daniel@0: Using truecolor=true avoids this problem.
Daniel@0:
Daniel@0:
- vertices
Daniel@0:
- If the input graph defines this attribute, the node is polygonal,
Daniel@0: and output is dot or xdot, this attribute provides the
Daniel@0: coordinates of the vertices of the node's polygon, in inches.
Daniel@0: If the node is an ellipse or circle, the
Daniel@0: samplepoints attribute affects
Daniel@0: the output.
Daniel@0:
Daniel@0:
- viewport
Daniel@0:
- Clipping window on final drawing.
Daniel@0:
Daniel@0:
- voro_margin
Daniel@0:
- Factor to scale up drawing to allow margin for expansion in
Daniel@0: Voronoi technique. dim' = (1+2*margin)*dim.
Daniel@0:
Daniel@0:
- weight
Daniel@0:
- Weight of edge. In dot, the heavier the weight, the shorter,
Daniel@0: straighter and more vertical the edge is.
Daniel@0:
Daniel@0:
- width
Daniel@0:
- Width of node, in inches. This is taken as the initial, minimum width
Daniel@0: of the node. If fixedsize is true, this
Daniel@0: will be the final width of the node. Otherwise, if the node label
Daniel@0: requires more width to fit, the node's width will be increased to
Daniel@0: contain the label. Note also that, if the output format is dot, the
Daniel@0: value given to width will be the final value.
Daniel@0:
Daniel@0:
- z
Daniel@0:
- Deprecated:Use pos attribute, along
Daniel@0: with dimen and/or dim
Daniel@0: to specify dimensions.
Daniel@0:
Daniel@0: Provides z coordinate value for 3D layouts and displays. If the
Daniel@0: graph has dim set to 3 (or more),
Daniel@0: neato will use a node's z value
Daniel@0: for the z coordinate of its initial position if
Daniel@0: its pos attribute is also defined.
Daniel@0:
Daniel@0: Even if no z values are specified in the input, it is necessary to
Daniel@0: declare a z attribute for nodes, e.g, using node[z=""]
Daniel@0: in order to get z values on output.
Daniel@0: Thus, setting dim=3 but not declaring z will
Daniel@0: cause neato -Tvrml to
Daniel@0: layout the graph in 3D but project the layout onto the xy-plane
Daniel@0: for the rendering. If the z attribute is declared, the final rendering
Daniel@0: will be in 3D.
Daniel@0:
Daniel@0:
Daniel@0:
Daniel@0: - arrowType
Daniel@0:
Daniel@0: | "normal" | 
Daniel@0: | "inv" |  |
Daniel@0: | "dot" | 
Daniel@0: | "invdot" |  |
Daniel@0: | "odot" | 
Daniel@0: | "invodot" |  |
Daniel@0: | "none" | 
Daniel@0: | "tee" |  |
Daniel@0: | "empty" | 
Daniel@0: | "invempty" |  |
Daniel@0: | "diamond" | 
Daniel@0: | "odiamond" |  |
Daniel@0: | "ediamond" | 
Daniel@0: | "crow" |  |
Daniel@0: | "box" | 
Daniel@0: | "obox" |  |
Daniel@0: | "open" | 
Daniel@0: | "halfopen" |  |
Daniel@0: | "vee" |
Daniel@0: |
Daniel@0:
Daniel@0: These are the basic set of backward-compatible arrow shapes. In addition,
Daniel@0: there is a grammar of arrow shapes
Daniel@0: which can be used to describe a collection of 1,544,761 arrow combinations of the 36 varations of the primitive set of 9 arrows. The basic arrows shown
Daniel@0: above contain all of the primitive shapes
Daniel@0: (box, crow, diamond,
Daniel@0: dot, inv, none,
Daniel@0: normal, tee, vee)
Daniel@0: plus ones that can be derived from the grammar
Daniel@0: (odot, invdot, invodot,
Daniel@0: obox, odiamond)
Daniel@0: plus some supported as special cases for backward-compatibility
Daniel@0: (ediamond, open, halfopen,
Daniel@0: empty, invempty).
Daniel@0:
Daniel@0:
- aspectType
Daniel@0:
An aspect ratio, double, followed optionally by a ',' and a maximum pass
Daniel@0: count. If the aspect ratio is given, but no maximum pass count, the
Daniel@0: latter defaults to 5.
Daniel@0:
Daniel@0:
- clusterMode
Daniel@0:
- "local","global","none"
Daniel@0:
Daniel@0:
- color
Daniel@0:
- Colors can be specified using one of four formats.
Daniel@0:
| "#%2x%2x%2x" | Red-Green-Blue (RGB) |
Daniel@0: | "#%2x%2x%2x%2x" | Red-Green-Blue-Alpha (RGBA) |
Daniel@0: | H[, ]+S[, ]+V | Hue-Saturation-Value (HSV) 0.0 <= H,S,V <= 1.0 |
Daniel@0: | string | color name |
Daniel@0: The specification for the RGB and RGBA formats are the format strings used by
Daniel@0: sscanf to scan the color value. Thus, these values have the form
Daniel@0: "#RGB" or "#RGBA", where R, G, B, and A each consist of 2 hexidecimal
Daniel@0: digits, and can be separated by whitespace. HSV colors have the form of 3
Daniel@0: numbers between 0 and 1, separated by whitespace or commas.
Daniel@0:
Daniel@0: String-valued color specifications are case-insensitive and interpreted
Daniel@0: in the context of the current color scheme, as specified by the
Daniel@0: colorscheme attribute. If this is undefined,
Daniel@0: the X11 naming scheme will be used.
Daniel@0: An initial "/" character can be used to override the use of
Daniel@0: the colorscheme attribute. In particular, a single initial
Daniel@0: "/" will cause the string to be evaluated using the default
Daniel@0: X11 naming. If the color value has the form "/ssss/yyyy",
Daniel@0: the name yyyy is interpreted using the schema ssss.
Daniel@0: If the color scheme name is empty, i.e., the color has the
Daniel@0: form "//yyyy", the colorscheme attribute is used.
Daniel@0: Thus, the forms "yyyy" and "//yyyy" are
Daniel@0: equivalent.
Daniel@0:
At present, Graphviz recognizes the default color scheme X11,
Daniel@0: and the Brewer color schemes. Please note that Brewer
Daniel@0: color schemes are covered by this license.
Daniel@0:
Daniel@0: Examples:
Daniel@0:
Daniel@0: | Color | RGB | HSV | String |
|---|
Daniel@0: | White | "#ffffff" | "0.000 0.000 1.000" | "white" |
Daniel@0: | Black | "#000000" | "0.000 0.000 0.000" | "black" |
Daniel@0: | Red | "#ff0000" | "0.000 1.000 1.000" | "red" |
Daniel@0: | Turquoise | "#40e0d0" | "0.482 0.714 0.878" | "turquoise" |
Daniel@0: | Sienna | "#a0522d" | "0.051 0.718 0.627" | "sienna" |
Daniel@0:
Daniel@0:
Daniel@0: Note that some output formats, e.g., mif,
Daniel@0: only support a limited number of specific colors.
Daniel@0:
Daniel@0: The string value transparent can be used to indicate no color.
Daniel@0: This is only available in the output formats
Daniel@0: ps, svg, fig, vmrl, and the bitmap formats. It can be used whenever a
Daniel@0: color is needed but is most useful with
Daniel@0: the bgcolor attribute.
Daniel@0: Usually, the same effect can be achieved by setting
Daniel@0: style to invis.
Daniel@0:
Daniel@0:
- colorList
Daniel@0:
- A colon-separated list of color values: C(:C)*
Daniel@0: where each C is a color value.
Daniel@0:
Daniel@0:
- dirType
Daniel@0:
- For an edge
T -> H;
Daniel@0:
Daniel@0: | "forward" | 
Daniel@0: | "back" |  |
Daniel@0: | "both" | 
Daniel@0: | "none" |  |
Daniel@0:
Daniel@0: For undirected edges T -- H;, one of the nodes, usually
Daniel@0: the righthand one, is treated as the head for the purpose of
Daniel@0: interpreting "forward" and "back".
Daniel@0:
Daniel@0: - escString
Daniel@0:
- string allowing escape sequences which are replaced according
Daniel@0: to the context.
Daniel@0: For node attributes, the substring "\N" is replaced by the name of the node,
Daniel@0: and the substring "\G" by the name of the graph.
Daniel@0: For graph or cluster attributes, the substring "\G" is replaced by the
Daniel@0: name of the graph or cluster.
Daniel@0: For edge attributes, the substring "\E" is replaced by the name of the edge,
Daniel@0: the substring "\G" is replaced by the name of the graph or cluster,
Daniel@0: and the substrings "\T" and "\H" by the names of
Daniel@0: the tail and head nodes, respectively.
Daniel@0: The name of an edge is the string formed from the name of the
Daniel@0: tail node, the appropriate edge operator ("--" or "->") and the name of the
Daniel@0: head node.
Daniel@0: In all cases, the substring "\L" is replaced by the object's label attribute.
Daniel@0:
Daniel@0: In addition, if the associated attribute is
Daniel@0: label,
Daniel@0: headlabel or taillabel,
Daniel@0: the escape sequences "\n", "\l" and "\r"
Daniel@0: divide the label into lines, centered, left-justified, and right-justified,
Daniel@0: respectively.
Daniel@0:
Daniel@0:
- layerList
Daniel@0:
- list of strings separated by characters from the
Daniel@0: layersep attribute (by default, colons,
Daniel@0: tabs or spaces), defining layer
Daniel@0: names and implicitly numbered 1,2,...
Daniel@0:
Daniel@0:
- layerRange
Daniel@0:
- layerId or layerIdslayerId,
where layerId = "all",
Daniel@0: a decimal integer or a layer name.
Daniel@0: (An integer i corresponds to layer i.)
Daniel@0: The string s consists of 1 or more separator characters specified
Daniel@0: by the layersep attribute.
Daniel@0:
Daniel@0: - lblString
Daniel@0:
- an escString
Daniel@0: or an HTML label.
Daniel@0:
Daniel@0:
- outputMode
Daniel@0:
- "breadthfirst","nodesfirst","edgesfirst"
Daniel@0: These specify the order in which nodes and edges are drawn in concrete
Daniel@0: output. The default "breadthfirst" is the simplest, but when the graph
Daniel@0: layout does not avoid edge-node overlap, this mode will sometimes have
Daniel@0: edges drawn over nodes and sometimes on top of nodes. If the mode
Daniel@0: "nodesfirst" is chosen, all nodes are drawn first, followed by the
Daniel@0: edges. This guarantees an edge-node overlap will not be mistaken for
Daniel@0: an edge ending at a node. On the other hand, usually for aesthetic
Daniel@0: reasons, it may be desirable that all edges appear beneath nodes, even
Daniel@0: if the resulting drawing is ambiguous. This can be achieved by choosing
Daniel@0: "edgesfirst".
Daniel@0:
Daniel@0:
- packMode
Daniel@0:
- "node", "clust" , "graph" , "array[_flags][%d]"
Daniel@0:
Daniel@0: The modes "node", "clust" or "graph"
Daniel@0: specify that the components should be packed together tightly, using
Daniel@0: the specified granularity.
Daniel@0: A value of "node" causes
Daniel@0: packing at the node and edge level, with no overlapping of these objects.
Daniel@0: This produces a layout with the least area, but it also allows interleaving,
Daniel@0: where a node of one component may lie between two nodes in another
Daniel@0: component. A value of "graph" does a packing using the bounding box of the
Daniel@0: component. Thus, there will be a rectangular region around a component
Daniel@0: free of elements of any other component.
Daniel@0: A value of "clust" guarantees that top-level clusters are kept intact.
Daniel@0: What effect a value has also depends on the layout algorithm. For
Daniel@0: example, neato does not support clusters, so a value of "clust" will
Daniel@0: have the same effect as the default "node" value.
Daniel@0:
Daniel@0: The mode "array[_flags][%d]"
Daniel@0: indicates that the components should be packed at the
Daniel@0: graph level into an array of graphs. By default, the components
Daniel@0: are in row-major order, with the number of columns roughly the
Daniel@0: square root of the number of components. If the optional flags
Daniel@0: contains "c", then column-major order is used. Finally, if the
Daniel@0: optional integer suffix is used, this specifies the number of
Daniel@0: columns for row-major or the number of rows for column-major.
Daniel@0: Thus, the mode "array_c4" indicates array packing, with 4 rows,
Daniel@0: starting in the upper left and going down the first column, then
Daniel@0: down the second column, etc., until all components are used.
Daniel@0:
Daniel@0: If the optional flags contains "u", this causes the insertion
Daniel@0: order of elements in the array to be determined by user-supplied
Daniel@0: values. Each component can specify its sort value by a
Daniel@0: non-negative integer using the sortv attribute.
Daniel@0: Components are
Daniel@0: inserted in order, starting with the one with the smallest
Daniel@0: sort value. If no sort value is specified, zero is used.
Daniel@0:
Daniel@0:
- pagedir
Daniel@0:
- "BL", "BR", "TL", "TR", "RB", "RT", "LB", "LT".
Daniel@0: These specify the 8 row or column major orders for traversing a
Daniel@0: rectangular array, the first character corresponding to the major
Daniel@0: order and the second to the minor order. Thus, for "BL", the
Daniel@0: major order is from bottom to top, and the minor order is from left
Daniel@0: to right. This means the bottom row is traversed first, from left
Daniel@0: to right, then the next row up, from left to right, and so on,
Daniel@0: until the topmost row is traversed.
Daniel@0:
Daniel@0:
- point
Daniel@0:
- "%f,%f"('!') representing the point (x,y). The
Daniel@0: optional '!' indicates the
Daniel@0: node position should not change (input-only).
Daniel@0:
Daniel@0: If dim is 3 or more, point may also have
Daniel@0: the format "%f,%f,%f"('!') to represent the point (x,y,z).
Daniel@0:
Daniel@0:
- pointf
Daniel@0:
- "%lf,%lf" representing the point (x,y).
Daniel@0:
Daniel@0:
- pointfList
Daniel@0:
- list of pointf, separated by spaces.
Daniel@0:
Daniel@0:
- portPos
Daniel@0:
- modifier indicating where on a node an edge should be aimed.
Daniel@0: It has the form portname[:compass_point]
Daniel@0: or compass_point.
Daniel@0: If the first form is used, the corresponding node must either have
Daniel@0: record shape with one of its fields
Daniel@0: having the given portname,
Daniel@0: or have an HTML-like label, one of
Daniel@0: whose components has a PORT attribute set to portname.
Daniel@0:
Daniel@0: If a compass point is used, it must have the form
Daniel@0: "n","ne","e","se","s","sw","w","nw","c","_". This modifies the edge
Daniel@0: placement to aim for the corresponding compass point on the port or,
Daniel@0: in the second form where no portname is supplied, on the node
Daniel@0: itself. The compass point "c" specifies the center of the node or port.
Daniel@0: The compass point "_" specifies that an appropriate side of the port
Daniel@0: adjacent to the exterior of the node should be used, if such exists.
Daniel@0: Otherwise, the center is used.
Daniel@0: If no compass point is used with a portname, the default value is "_".
Daniel@0:
Daniel@0:
Daniel@0: This attribute can be attached to an edge using the
Daniel@0: headport and
Daniel@0: tailport attributes, or as part of the
Daniel@0: edge description as in
Daniel@0:
Daniel@0: node1:port1 -> node2:port5:nw;
Daniel@0:
Daniel@0:
Daniel@0: Note that it is legal to have a portname the same as one of
Daniel@0: the compass points. In this case, this reference will be resolved to
Daniel@0: the port. Thus, if node A has a port w, then
Daniel@0: headport=w will refer to the port and not the compass point.
Daniel@0: At present, in this case, there is no way to specify that the compass
Daniel@0: point should be used.
Daniel@0:
Daniel@0:
- quadType
Daniel@0:
- "normal", "fast", "none".
Daniel@0:
Daniel@0: Using "fast" gives about a 2-4 times overall speedup compared with "normal",
Daniel@0: though layout quality can suffer a little.
Daniel@0:
Daniel@0:
- rankType
Daniel@0:
- "same", "min", "source", "max", "sink"
Daniel@0:
Daniel@0:
- rankdir
Daniel@0:
- "TB", "LR", "BT", "RL", corresponding to directed graphs drawn
Daniel@0: from top to bottom, from left to right, from bottom to top, and from
Daniel@0: right to left, respectively.
Daniel@0:
Daniel@0:
- rect
Daniel@0:
- "%f,%f,%f,%f" The rectangle llx,lly,urx,ury gives the coordinates, in
Daniel@0: points, of the lower-left corner (llx,lly) and the upper-right corner
Daniel@0: (urx,ury).
Daniel@0:
Daniel@0:
- shape
Daniel@0:
- A string specifying the shape of a node.
Daniel@0: There are three
Daniel@0: main types of shapes :
Daniel@0: polygon-based,
Daniel@0: record-based and
Daniel@0: user-defined.
Daniel@0:
Daniel@0:
- smoothType
Daniel@0:
- Values are "none", "avg_dist", "graph_dist", "power_dist", "rng",
Daniel@0: "spring" and "triangle".
Daniel@0:
Daniel@0:
- splineType
Daniel@0:
- spline ( ';' spline )*
Daniel@0:
Daniel@0: | where spline | = | (endp)? (startp)? point (triple)+ |
Daniel@0: | and triple | = | point point point |
Daniel@0: | and endp | = | "e,%f,%f" |
Daniel@0: | and startp | = | "s,%f,%f" |
Daniel@0:
Daniel@0: If a spline has points p1 p2 p3 ... pn, (n = 1 (mod 3)), the points
Daniel@0: correspond to the control points of a B-spline from p1 to pn. If startp
Daniel@0: is given, it touches one node of the edge, and the arrowhead
Daniel@0: goes from p1 to startp. If startp is not given, p1 touches a node.
Daniel@0: Similarly for pn and endp.
Daniel@0:
Daniel@0: - startType
Daniel@0:
- has the syntax [style][seed].
Daniel@0:
Daniel@0: If style is present, it must be one of the strings "regular",
Daniel@0: "self", or "random". In the first case, the nodes are
Daniel@0: placed regularly about a circle. In the second case,
Daniel@0: an abbreviated version of neato is run to obtain the initial layout.
Daniel@0: In the last case, the nodes are placed randomly in a unit square.
Daniel@0:
Daniel@0: If seed is present, it specifies a seed for the random number
Daniel@0: generator. If seed is a positive number, this is used as the
Daniel@0: seed. If it is anything else,
Daniel@0: the current time, and possibly the process id, is used to pick a seed,
Daniel@0: thereby making the choice more random. In this case, the seed value
Daniel@0: is stored in the graph.
Daniel@0:
Daniel@0: If the value is just "random", a time-based seed is chosen.
Daniel@0:
Daniel@0: Note that input positions, specified by a node's
Daniel@0: pos
Daniel@0: attribute, are only used when the style is "random".
Daniel@0:
Daniel@0:
- style
Daniel@0:
- styleItem ( ',' styleItem )*
Daniel@0:
Daniel@0: | where styleItem | = | name or name'('args')' |
Daniel@0: | and args | = | name ( ',' name )* |
Daniel@0: | and name | = | [^)(, ][^)(,]* |
Daniel@0:
Daniel@0: Note that whitespace characters are ignored, except for names which
Daniel@0: can contain them. A
Daniel@0: name cannot contain any comma, or left or right parenthesis, and it cannot
Daniel@0: begin with a whitespace character.
Daniel@0:
Daniel@0: At present, the recognized style names are
Daniel@0: "dashed", "dotted", "solid", "invis" and "bold" for nodes and edges,
Daniel@0: and "filled", "diagonals" and "rounded" for nodes only.
Daniel@0: The styles "filled" and "rounded" are recognized for clusters.
Daniel@0: Additional styles are available in
Daniel@0: device-dependent form. Style lists are passed to device drivers, which
Daniel@0: can use this to generate appropriate output.
Daniel@0:
Daniel@0: The setlinewidth style value can be
Daniel@0: used for more control over the width of node borders and edges than is
Daniel@0: allowed by bold. This style value takes an argument, specifying the
Daniel@0: width of the line in points. For example, style="bold" is
Daniel@0: equivalent to style="setlinewidth(2)".
Daniel@0: The use of setlinewidth is deprecated; one should use the
Daniel@0: penwidth attribute instead.
Daniel@0:
Daniel@0:
- viewPort
Daniel@0:
- "%lf,%lf,%lf,%lf,%lf" or "%lf,%lf,%lf,'%s'"
Daniel@0:
Daniel@0: The viewPort W,H,Z,x,y or W,H,Z,N
Daniel@0: specifies a viewport for the final image. The pair (W,H) gives the
Daniel@0: dimensions (width and height) of the final image, in
Daniel@0: points.
Daniel@0: The optional Z is the zoom factor, i.e., the image in the original layout will be
Daniel@0: W/Z by H/Z points in size. By default, Z is 1.
Daniel@0: The optional last part is either a pair (x,y) giving a position in the original layout of the
Daniel@0: graph, in
Daniel@0: points, of the center of the viewport, or the name N
Daniel@0: of a node whose center should used as the focus.
Daniel@0: By default, the focus is the center of the graph bounding box, i.e.,
Daniel@0: (bbx/2,bby/2), where "bbx,bby" is the
Daniel@0: value of the bounding box attribute bb.
Daniel@0:
Daniel@0: Sample values: 50,50,.5,'2.8 BSD' or 100,100,2,450,300.
Daniel@0: The first will take the 100x100 point square centered on the node 2.8 BSD
Daniel@0: and scale it down by 0.5, yielding a 50x50 point final image.
Daniel@0:
Daniel@0:
Daniel@0:
Daniel@0: