Graph::Easy::Edge::Cell - A cell in an edge in Graph::Easy


Graph-Easy documentation  | view source Contained in the Graph-Easy distribution.

Index


NAME

Top

Graph::Easy::Edge::Cell - A cell in an edge in Graph::Easy

SYNOPSIS

Top

        use Graph::Easy;

	my $ssl = Graph::Easy::Edge->new(
		label => 'encrypted connection',
		style => 'solid',
		color => 'red',
	);
	my $src = Graph::Easy::Node->new( 'source' );
	my $dst = Graph::Easy::Node->new( 'destination' );

	$graph = Graph::Easy->new();

	$graph->add_edge($src, $dst, $ssl);

	print $graph->as_ascii();

DESCRIPTION

Top

A Graph::Easy::Edge::Cell represents an edge between two (or more) nodes in a simple graph.

Each edge has a direction (from source to destination, or back and forth), plus a style (line width and style), colors etc. It can also have a name, e.g. a text label associated with it.

There should be no need to use this package directly.

METHODS

Top

error()

	$last_error = $edge->error();

	$cvt->error($error);			# set new messags
	$cvt->error('');			# clear error

Returns the last error message, or '' for no error.

as_ascii()

	my $ascii = $path->as_ascii();

Returns the path-cell as a little ascii representation.

as_html()

	my $html = $path->as_html($tag,$id);

eturns the path-cell as HTML code.

label()

	my $label = $path->label();

Returns the name (also known as 'label') of the path-cell.

style()

	my $style = $edge->style();

Returns the style of the edge.

EXPORT

Top

None by default. Can export the following on request:

  EDGE_START_E
  EDGE_START_W
  EDGE_START_N
  EDGE_START_S

  EDGE_END_E
  EDGE_END_W	
  EDGE_END_N
  EDGE_END_S

  EDGE_SHORT_E
  EDGE_SHORT_W	
  EDGE_SHORT_N
  EDGE_SHORT_S

  EDGE_SHORT_BD_EW
  EDGE_SHORT_BD_NS

  EDGE_SHORT_UN_EW
  EDGE_SHORT_UN_NS

  EDGE_HOR
  EDGE_VER
  EDGE_CROSS

  EDGE_N_E
  EDGE_N_W
  EDGE_S_E
  EDGE_S_W

  EDGE_S_E_W
  EDGE_N_E_W
  EDGE_E_N_S
  EDGE_W_N_S	

  EDGE_LOOP_NORTH
  EDGE_LOOP_SOUTH
  EDGE_LOOP_EAST
  EDGE_LOOP_WEST

  EDGE_N_W_S
  EDGE_S_W_N
  EDGE_E_S_W
  EDGE_W_S_E

  EDGE_TYPE_MASK
  EDGE_FLAG_MASK
  EDGE_ARROW_MASK

  EDGE_START_MASK
  EDGE_END_MASK
  EDGE_MISC_MASK

  ARROW_RIGHT
  ARROW_LEFT
  ARROW_UP
  ARROW_DOWN

SEE ALSO

Top

Graph::Easy.

AUTHOR

Top

Copyright (C) 2004 - 2007 by Tels http://bloodgate.com.

See the LICENSE file for more details.


Graph-Easy documentation  | view source Contained in the Graph-Easy distribution.