Package org.apache.poi.ss.usermodel
Interface ColorScaleFormatting
- All Known Implementing Classes:
HSSFColorScaleFormatting
,XSSFColorScaleFormatting
public interface ColorScaleFormatting
High level representation for the Color Scale / Colour Scale /
Color Gradient Formatting component of Conditional Formatting settings
-
Method Summary
Modifier and TypeMethodDescriptionCreates a new, empty ThresholdColor[]
Gets the list of colours that are interpolated between.int
How many control points should be used to map the colours? Normally 2 or 3Gets the list of thresholdsvoid
Sets the list of colours that are interpolated between.void
setNumControlPoints
(int num) Sets the number of control points to use to map the colours.void
setThresholds
(ConditionalFormattingThreshold[] thresholds) Sets the of thresholds.
-
Method Details
-
getNumControlPoints
int getNumControlPoints()How many control points should be used to map the colours? Normally 2 or 3 -
setNumControlPoints
void setNumControlPoints(int num) Sets the number of control points to use to map the colours. Should normally be 2 or 3.After updating, you need to ensure that the
Threshold
count and Color count match -
getColors
Color[] getColors()Gets the list of colours that are interpolated between. -
setColors
Sets the list of colours that are interpolated between. The number must matchgetNumControlPoints()
-
getThresholds
ConditionalFormattingThreshold[] getThresholds()Gets the list of thresholds -
setThresholds
Sets the of thresholds. The number must matchgetNumControlPoints()
-
createThreshold
ConditionalFormattingThreshold createThreshold()Creates a new, empty Threshold
-