axis.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_FORMATS_SVG_AXIS_H_
#define GENESIS_UTILS_FORMATS_SVG_AXIS_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2023 Lucas Czech
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include "genesis/utils/formats/svg/group.hpp"
#include "genesis/utils/tools/tickmarks.hpp"
 
#include <map>
#include <string>
#include <utility>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Svg Axis
// =================================================================================================
 
struct SvgAxisSettings
{
public:
 
    // -------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------
 
    enum class Position
    {
        kLeft,
        kRight,
        kTop,
        kBottom
    };
 
    // -------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------
 
    Position position = Position::kBottom;
 
    double length = 1.0;
 
    double offset = 10.0;
 
    double tick_size = 8.0;
 
    double label_text_size = 10.0;
 
    double axis_text_size = 10.0;
};
 
SvgGroup make_svg_axis(
    SvgAxisSettings const& settings,
    std::map<double, std::string> const& labels,
    std::string const& name = ""
);
 
SvgGroup make_svg_axis(
    SvgAxisSettings const& settings,
    std::vector<Tickmarks::LabeledTick> const& labels,
    std::string const& name = "",
    bool round_labels = true
);
 
} // namespace utils
} // namespace genesis
 
#endif // include guard