A toolkit for working with phylogenetic data.
v0.24.0
RectangularLayout Class Reference

#include <genesis/tree/drawing/rectangular_layout.hpp>

Inherits LayoutBase.

Detailed Description

Definition at line 47 of file rectangular_layout.hpp.

Public Member Functions

 RectangularLayout ()=default
 
 RectangularLayout (Tree const &orig_tree, LayoutType const drawing_type=LayoutType::kCladogram, bool ladderize=true)
 
 RectangularLayout (RectangularLayout const &)=default
 
 RectangularLayout (RectangularLayout &&)=default
 
virtual ~RectangularLayout () override=default
 
RectangularLayoutheight (double const value)
 
double height () const
 
RectangularLayoutoperator= (RectangularLayout const &)=default
 
RectangularLayoutoperator= (RectangularLayout &&)=default
 
RectangularLayoutwidth (double const value)
 
double width () const
 
- Public Member Functions inherited from LayoutBase
 LayoutBase ()=default
 
 LayoutBase (Tree const &orig_tree, LayoutType const drawing_type=LayoutType::kCladogram, bool ladderize=true)
 
 LayoutBase (LayoutBase const &)=default
 
 LayoutBase (LayoutBase &&)=default
 
virtual ~LayoutBase ()=default
 
void align_labels (bool value)
 Align the taxon labels/node names/texts to each other. More...
 
bool align_labels () const
 
void extra_spacer (double value)
 Set some extra space betwen the tree nodes and their labels when align_labels() is set to true. More...
 
double extra_spacer () const
 
void inner_node_spreading (LayoutSpreading value)
 
LayoutSpreading inner_node_spreading () const
 
LayoutBaseoperator= (LayoutBase const &)=default
 
LayoutBaseoperator= (LayoutBase &&)=default
 
void set_edge_distance_strokes (utils::SvgStroke const &stroke)
 
void set_edge_distance_strokes (std::vector< utils::SvgStroke > const &strokes)
 
void set_edge_shapes (utils::SvgGroup const &shape)
 
void set_edge_shapes (std::vector< utils::SvgGroup > const &shapes)
 
void set_edge_spreading_strokes (utils::SvgStroke const &stroke)
 
void set_edge_spreading_strokes (std::vector< utils::SvgStroke > const &strokes)
 
void set_edge_strokes (utils::SvgStroke const &stroke)
 
void set_edge_strokes (std::vector< utils::SvgStroke > const &strokes)
 
void set_label_spacer_strokes (utils::SvgStroke const &stroke, LayoutSpreading spreading=LayoutSpreading::kLeafNodesOnly)
 
void set_label_spacer_strokes (std::vector< utils::SvgStroke > const &strokes)
 
void set_node_shapes (utils::SvgGroup const &shape)
 
void set_node_shapes (std::vector< utils::SvgGroup > const &shapes)
 
void text_template (utils::SvgText const &tt)
 
utils::SvgTexttext_template ()
 
utils::SvgText const & text_template () const
 
utils::SvgDocument to_svg_document () const
 
void tree (Tree const &orig_tree, bool ladderize=true)
 
Tree const & tree () const
 
void type (LayoutType const drawing_type)
 
LayoutType type () const
 

Additional Inherited Members

- Protected Member Functions inherited from LayoutBase
Treetree ()
 

Constructor & Destructor Documentation

◆ RectangularLayout() [1/4]

RectangularLayout ( )
default

◆ RectangularLayout() [2/4]

RectangularLayout ( Tree const &  orig_tree,
LayoutType const  drawing_type = LayoutType::kCladogram,
bool  ladderize = true 
)
inline

Definition at line 56 of file rectangular_layout.hpp.

◆ ~RectangularLayout()

virtual ~RectangularLayout ( )
overridevirtualdefault

◆ RectangularLayout() [3/4]

RectangularLayout ( RectangularLayout const &  )
default

◆ RectangularLayout() [4/4]

Member Function Documentation

◆ height() [1/2]

RectangularLayout & height ( double const  value)

Definition at line 58 of file rectangular_layout.cpp.

◆ height() [2/2]

double height ( ) const

Definition at line 64 of file rectangular_layout.cpp.

◆ operator=() [1/2]

RectangularLayout& operator= ( RectangularLayout const &  )
default

◆ operator=() [2/2]

RectangularLayout& operator= ( RectangularLayout &&  )
default

◆ width() [1/2]

RectangularLayout & width ( double const  value)

Definition at line 47 of file rectangular_layout.cpp.

◆ width() [2/2]

double width ( ) const

Definition at line 53 of file rectangular_layout.cpp.


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