Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::LayoutStandards Class Reference

Standard values for graphical attributes and layouts. More...

#include <ogdf/basic/LayoutStandards.h>

Static Public Member Functions

Global default node attributes

These attribute values are used by GraphAttributes as default graphical representation of nodes.

static double defaultNodeWidth ()
 Returns the global default width for nodes. More...
 
static void setDefaultNodeWidth (double w)
 Sets the global default width for nodes to w. More...
 
static double defaultNodeHeight ()
 Returns the global default height for nodes. More...
 
static void setDefaultNodeHeight (double h)
 Sets the global default height for nodes to h. More...
 
static Shape defaultNodeShape ()
 Returns the global default shape for nodes. More...
 
static void setDefaultNodeShape (Shape s)
 Sets the global default shape for nodes to s. More...
 
static Stroke defaultNodeStroke ()
 Returns the global default stroke for nodes. More...
 
static Color defaultNodeStrokeColor ()
 Returns the global default stroke color for nodes. More...
 
static float defaultNodeStrokeWidth ()
 Returns the global default stroke width for nodes. More...
 
static void setDefaultNodeStroke (Stroke stroke)
 Sets the global default stroke for nodes to stroke. More...
 
static Fill defaultNodeFill ()
 Returns the global default fill for nodes. More...
 
static Color defaultNodeFillColor ()
 Returns the global default fill color for nodes. More...
 
static void setDefaultNodeFill (Fill fill)
 Sets the global default fill for nodes to fill. More...
 
Global default edge attributes

These attribute values are used by GraphAttributes as default graphical representation of edges.

static Stroke defaultEdgeStroke ()
 Returns the global default stroke for edges. More...
 
static Color defaultEdgeStrokeColor ()
 Returns the global default stroke color for edges. More...
 
static float defaultEdgeStrokeWidth ()
 Returns the global default stroke width for edges. More...
 
static void setDefaultEdgeStroke (Stroke stroke)
 Sets the global default stroke for edges to stroke. More...
 
static EdgeArrow defaultEdgeArrow ()
 Returns the global default arrow type for edges. More...
 
static void setDefaultEdgeArrow (EdgeArrow arrow)
 Sets the global default arrow type for edges to arrow. More...
 
Global default cluster attributes

These attribute values are used by ClusterGraphAttributes as default graphical representation of clusters.

static Stroke defaultClusterStroke ()
 Returns the global default stroke for clusters. More...
 
static Color defaultClusterStrokeColor ()
 Returns the global default stroke color for clusters. More...
 
static float defaultClusterStrokeWidth ()
 Returns the global default stroke width for clusters. More...
 
static void setDefaultClusterStroke (Stroke stroke)
 Sets the global default stroke for cluster to stroke. More...
 
static Fill defaultClusterFill ()
 Returns the global default fill for clusters. More...
 
static Color defaultClusterFillColor ()
 Returns the global default fill color for clusters. More...
 
static void setDefaultClusterFill (Fill fill)
 Sets the global default fill for clusters to fill. More...
 
Global default separation parameters

These values can be used by layout algorithms as useful settings for separation parameters.

static double defaultNodeSeparation ()
 Returns the global default node separation. More...
 
static void setDefaultNodeSeparation (double d)
 Sets the global default node separation to d. More...
 
static double defaultCCSeparation ()
 Returns the global default separation between connected components. More...
 
static void setDefaultCCSeparation (double d)
 Sets the global default separation between connected components to d. More...
 

Static Private Attributes

static double s_defCCSeparation
 the default separation between connected components (for layout algorithms) (must be positive). More...
 
static Fill s_defClusterFill
 the default cluster fill. More...
 
static Stroke s_defClusterStroke
 the default cluster stroke. More...
 
static EdgeArrow s_defEdgeArrow
 the default arrow type of an edge . More...
 
static Stroke s_defEdgeStroke
 the default stroke of an edge. More...
 
static Fill s_defNodeFill
 the default fill of a node. More...
 
static double s_defNodeHeight
 the default height of a node (must be positive). More...
 
static double s_defNodeSeparation
 the default node separation (for layout algorithms) (must be positive). More...
 
static Shape s_defNodeShape
 the default shape of a node. More...
 
static Stroke s_defNodeStroke
 the default stroke of a node. More...
 
static double s_defNodeWidth
 the default width of a node (must be positive). More...
 

Detailed Description

Standard values for graphical attributes and layouts.

Definition at line 44 of file LayoutStandards.h.

Member Function Documentation

◆ defaultCCSeparation()

static double ogdf::LayoutStandards::defaultCCSeparation ( )
inlinestatic

Returns the global default separation between connected components.

Definition at line 175 of file LayoutStandards.h.

◆ defaultClusterFill()

static Fill ogdf::LayoutStandards::defaultClusterFill ( )
inlinestatic

Returns the global default fill for clusters.

Definition at line 150 of file LayoutStandards.h.

◆ defaultClusterFillColor()

static Color ogdf::LayoutStandards::defaultClusterFillColor ( )
inlinestatic

Returns the global default fill color for clusters.

Definition at line 152 of file LayoutStandards.h.

◆ defaultClusterStroke()

static Stroke ogdf::LayoutStandards::defaultClusterStroke ( )
inlinestatic

Returns the global default stroke for clusters.

Definition at line 141 of file LayoutStandards.h.

◆ defaultClusterStrokeColor()

static Color ogdf::LayoutStandards::defaultClusterStrokeColor ( )
inlinestatic

Returns the global default stroke color for clusters.

Definition at line 143 of file LayoutStandards.h.

◆ defaultClusterStrokeWidth()

static float ogdf::LayoutStandards::defaultClusterStrokeWidth ( )
inlinestatic

Returns the global default stroke width for clusters.

Definition at line 145 of file LayoutStandards.h.

◆ defaultEdgeArrow()

static EdgeArrow ogdf::LayoutStandards::defaultEdgeArrow ( )
inlinestatic

Returns the global default arrow type for edges.

Definition at line 129 of file LayoutStandards.h.

◆ defaultEdgeStroke()

static Stroke ogdf::LayoutStandards::defaultEdgeStroke ( )
inlinestatic

Returns the global default stroke for edges.

Definition at line 120 of file LayoutStandards.h.

◆ defaultEdgeStrokeColor()

static Color ogdf::LayoutStandards::defaultEdgeStrokeColor ( )
inlinestatic

Returns the global default stroke color for edges.

Definition at line 122 of file LayoutStandards.h.

◆ defaultEdgeStrokeWidth()

static float ogdf::LayoutStandards::defaultEdgeStrokeWidth ( )
inlinestatic

Returns the global default stroke width for edges.

Definition at line 124 of file LayoutStandards.h.

◆ defaultNodeFill()

static Fill ogdf::LayoutStandards::defaultNodeFill ( )
inlinestatic

Returns the global default fill for nodes.

Definition at line 106 of file LayoutStandards.h.

◆ defaultNodeFillColor()

static Color ogdf::LayoutStandards::defaultNodeFillColor ( )
inlinestatic

Returns the global default fill color for nodes.

Definition at line 108 of file LayoutStandards.h.

◆ defaultNodeHeight()

static double ogdf::LayoutStandards::defaultNodeHeight ( )
inlinestatic

Returns the global default height for nodes.

Definition at line 81 of file LayoutStandards.h.

◆ defaultNodeSeparation()

static double ogdf::LayoutStandards::defaultNodeSeparation ( )
inlinestatic

Returns the global default node separation.

Definition at line 164 of file LayoutStandards.h.

◆ defaultNodeShape()

static Shape ogdf::LayoutStandards::defaultNodeShape ( )
inlinestatic

Returns the global default shape for nodes.

Definition at line 92 of file LayoutStandards.h.

◆ defaultNodeStroke()

static Stroke ogdf::LayoutStandards::defaultNodeStroke ( )
inlinestatic

Returns the global default stroke for nodes.

Definition at line 97 of file LayoutStandards.h.

◆ defaultNodeStrokeColor()

static Color ogdf::LayoutStandards::defaultNodeStrokeColor ( )
inlinestatic

Returns the global default stroke color for nodes.

Definition at line 99 of file LayoutStandards.h.

◆ defaultNodeStrokeWidth()

static float ogdf::LayoutStandards::defaultNodeStrokeWidth ( )
inlinestatic

Returns the global default stroke width for nodes.

Definition at line 101 of file LayoutStandards.h.

◆ defaultNodeWidth()

static double ogdf::LayoutStandards::defaultNodeWidth ( )
inlinestatic

Returns the global default width for nodes.

Definition at line 70 of file LayoutStandards.h.

◆ setDefaultCCSeparation()

static void ogdf::LayoutStandards::setDefaultCCSeparation ( double  d)
inlinestatic

Sets the global default separation between connected components to d.

Parameters
dmust be a positive value and is set as new default separation between connected components.

Definition at line 180 of file LayoutStandards.h.

◆ setDefaultClusterFill()

static void ogdf::LayoutStandards::setDefaultClusterFill ( Fill  fill)
inlinestatic

Sets the global default fill for clusters to fill.

Definition at line 154 of file LayoutStandards.h.

◆ setDefaultClusterStroke()

static void ogdf::LayoutStandards::setDefaultClusterStroke ( Stroke  stroke)
inlinestatic

Sets the global default stroke for cluster to stroke.

Definition at line 147 of file LayoutStandards.h.

◆ setDefaultEdgeArrow()

static void ogdf::LayoutStandards::setDefaultEdgeArrow ( EdgeArrow  arrow)
inlinestatic

Sets the global default arrow type for edges to arrow.

Definition at line 131 of file LayoutStandards.h.

◆ setDefaultEdgeStroke()

static void ogdf::LayoutStandards::setDefaultEdgeStroke ( Stroke  stroke)
inlinestatic

Sets the global default stroke for edges to stroke.

Definition at line 126 of file LayoutStandards.h.

◆ setDefaultNodeFill()

static void ogdf::LayoutStandards::setDefaultNodeFill ( Fill  fill)
inlinestatic

Sets the global default fill for nodes to fill.

Definition at line 110 of file LayoutStandards.h.

◆ setDefaultNodeHeight()

static void ogdf::LayoutStandards::setDefaultNodeHeight ( double  h)
inlinestatic

Sets the global default height for nodes to h.

Parameters
hmust be a positive value and is set as new default node height.

Definition at line 86 of file LayoutStandards.h.

◆ setDefaultNodeSeparation()

static void ogdf::LayoutStandards::setDefaultNodeSeparation ( double  d)
inlinestatic

Sets the global default node separation to d.

Parameters
dmust be a positive value and is set as new default node separation.

Definition at line 169 of file LayoutStandards.h.

◆ setDefaultNodeShape()

static void ogdf::LayoutStandards::setDefaultNodeShape ( Shape  s)
inlinestatic

Sets the global default shape for nodes to s.

Definition at line 94 of file LayoutStandards.h.

◆ setDefaultNodeStroke()

static void ogdf::LayoutStandards::setDefaultNodeStroke ( Stroke  stroke)
inlinestatic

Sets the global default stroke for nodes to stroke.

Definition at line 103 of file LayoutStandards.h.

◆ setDefaultNodeWidth()

static void ogdf::LayoutStandards::setDefaultNodeWidth ( double  w)
inlinestatic

Sets the global default width for nodes to w.

Parameters
wmust be a positive value and is set as new default node width.

Definition at line 75 of file LayoutStandards.h.

Member Data Documentation

◆ s_defCCSeparation

double ogdf::LayoutStandards::s_defCCSeparation
staticprivate

the default separation between connected components (for layout algorithms) (must be positive).

Definition at line 59 of file LayoutStandards.h.

◆ s_defClusterFill

Fill ogdf::LayoutStandards::s_defClusterFill
staticprivate

the default cluster fill.

Definition at line 56 of file LayoutStandards.h.

◆ s_defClusterStroke

Stroke ogdf::LayoutStandards::s_defClusterStroke
staticprivate

the default cluster stroke.

Definition at line 55 of file LayoutStandards.h.

◆ s_defEdgeArrow

EdgeArrow ogdf::LayoutStandards::s_defEdgeArrow
staticprivate

the default arrow type of an edge .

Definition at line 53 of file LayoutStandards.h.

◆ s_defEdgeStroke

Stroke ogdf::LayoutStandards::s_defEdgeStroke
staticprivate

the default stroke of an edge.

Definition at line 52 of file LayoutStandards.h.

◆ s_defNodeFill

Fill ogdf::LayoutStandards::s_defNodeFill
staticprivate

the default fill of a node.

Definition at line 50 of file LayoutStandards.h.

◆ s_defNodeHeight

double ogdf::LayoutStandards::s_defNodeHeight
staticprivate

the default height of a node (must be positive).

Definition at line 47 of file LayoutStandards.h.

◆ s_defNodeSeparation

double ogdf::LayoutStandards::s_defNodeSeparation
staticprivate

the default node separation (for layout algorithms) (must be positive).

Definition at line 58 of file LayoutStandards.h.

◆ s_defNodeShape

Shape ogdf::LayoutStandards::s_defNodeShape
staticprivate

the default shape of a node.

Definition at line 48 of file LayoutStandards.h.

◆ s_defNodeStroke

Stroke ogdf::LayoutStandards::s_defNodeStroke
staticprivate

the default stroke of a node.

Definition at line 49 of file LayoutStandards.h.

◆ s_defNodeWidth

double ogdf::LayoutStandards::s_defNodeWidth
staticprivate

the default width of a node (must be positive).

Definition at line 46 of file LayoutStandards.h.


The documentation for this class was generated from the following file: