color_bar.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_FORMATS_SVG_COLOR_BAR_H_
#define GENESIS_UTILS_FORMATS_SVG_COLOR_BAR_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2024 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/gradient.hpp"
#include "genesis/utils/formats/svg/group.hpp"
 
#include <map>
#include <string>
#include <utility>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Forward Declarations
// =================================================================================================
 
class ColorMap;
class ColorNormalization;
class ColorNormalizationDiverging;
class ColorNormalizationLinear;
class ColorNormalizationLogarithmic;
 
// =================================================================================================
//     Svg Color Bar
// =================================================================================================
 
struct SvgColorBarSettings
{
public:
 
    // -------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------
 
    enum class Direction
    {
        kTopToBottom,
        kBottomToTop,
        kLeftToRight,
        kRightToLeft
    };
 
    // -------------------------------------------------------------
    //     Properties
    // -------------------------------------------------------------
 
    Direction direction = Direction::kBottomToTop;
 
    double width  = 20;
    double height = 200;
    double line_width = 1;
 
    bool with_tickmarks    = true;
    bool with_labels       = true;
 
    size_t num_ticks = 5;
    double text_size = 10.0;
 
};
 
std::pair<SvgGradientLinear, SvgGroup> make_svg_color_bar(
    SvgColorBarSettings const& settings,
    ColorMap const& map,
    ColorNormalization const& norm,
    std::string const& id = ""
);
 
SvgGroup make_svg_color_list(
    ColorMap const& map,
    std::vector<std::string> const& labels
);
 
SvgGroup make_svg_color_list(
    std::vector<Color> const& colors,
    std::vector<std::string> const& labels
);
 
} // namespace utils
} // namespace genesis
 
#endif // include guard