import_cond_format_databar
Defined in header: <orcus/spreadsheet/import_interface_cond_format.hpp>
-
class import_cond_format_databar
Interface for importing a data bar rule of a conditional format. A data bar rule draws a bar in each cell whose length reflects the cell value relative to two thresholds.
Public Functions
-
virtual ~import_cond_format_databar()
-
virtual void set_show_value(bool show) = 0
Set whether or not to show the value in the cell.
- Parameters:
show – Whether or not to show the value in the cell.
-
virtual void set_gradient(bool gradient) = 0
Set whether or not to use a gradient for the data bar.
- Parameters:
gradient – Whether or not to use a gradient.
-
virtual void set_axis(databar_axis_t axis) = 0
Set the position of the 0 axis of the data bar.
- Parameters:
axis – Position of the 0 axis.
-
virtual void set_color_positive(color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue) = 0
Set the data bar color for positive values.
-
virtual void set_color_negative(color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue) = 0
Set the data bar color for negative values.
-
virtual void set_min_length(double length) = 0
Set the minimum length of the data bar.
- Parameters:
length – Minimum length of the data bar.
-
virtual void set_max_length(double length) = 0
Set the maximum length of the data bar.
- Parameters:
length – Maximum length of the data bar.
-
virtual import_cond_format_value *start_value() = 0
Start importing a new threshold of the data bar. A data bar has exactly two thresholds.
The implementor should initialize the internal buffer to store the value data when this method is called.
Note
Note that the import_cond_format_databar implementer must return a non-null pointer.
- Returns:
Interface for importing the new value.
-
virtual void commit() = 0
Commit the data bar rule to the parent conditional format.
-
virtual ~import_cond_format_databar()