XLSparkline.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLSPARKLINE_HPP
#define OPENXLSX_XLSPARKLINE_HPP
 
#include "OpenXLSX-Exports.hpp"
#include "XLXmlFile.hpp"
#include <string>
 
namespace OpenXLSX
{
    enum class XLSparklineType { Line, Column, Stacked };
 
    struct XLSparklineOptions
    {
        XLSparklineType type {XLSparklineType::Line};
        std::string     seriesColor {"FF376092"}; // Default blue-ish
        std::string     negativeColor {"FFD00000"}; // Default red
        std::string     markersColor {"FFD00000"};
        std::string     firstMarkerColor {"FFD00000"};
        std::string     lastMarkerColor {"FFD00000"};
        std::string     highMarkerColor {"FFD00000"};
        std::string     lowMarkerColor {"FFD00000"};
 
        bool            markers {false}; // Show markers
        bool            high {false};    // Highlight highest point
        bool            low {false};     // Highlight lowest point
        bool            first {false};   // Highlight first point
        bool            last {false};    // Highlight last point
        bool            negative {false};// Highlight negative points
        bool            displayXAxis {false}; // Show horizontal axis
        std::string     displayEmptyCellsAs {"gap"}; // gap, zero, span
    };
 
    class OPENXLSX_EXPORT XLSparkline
    {
    public:
        XLSparkline();
        explicit XLSparkline(XMLNode node);
        ~XLSparkline();
 
        XLSparklineType type() const;
        void            setType(XLSparklineType type);
 
        std::string location() const;
        void        setLocation(const std::string& sqref);
 
        std::string dataRange() const;
        void        setDataRange(const std::string& formula);
 
    private:
        XMLNode m_node;
    };
 
}    // namespace OpenXLSX
 
#endif    // OPENXLSX_XLSPARKLINE_HPP