Package org.apache.poi.xssf.usermodel
Class XSSFColorScaleFormatting
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFColorScaleFormatting
- All Implemented Interfaces:
ColorScaleFormatting
High level representation for Color Scale / Color Gradient Formatting
component of Conditional Formatting settings
-
Method Summary
Modifier and TypeMethodDescriptionCreates a new, empty ThresholdGets 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
public int getNumControlPoints()Description copied from interface:ColorScaleFormatting
How many control points should be used to map the colours? Normally 2 or 3- Specified by:
getNumControlPoints
in interfaceColorScaleFormatting
-
setNumControlPoints
public void setNumControlPoints(int num) Description copied from interface:ColorScaleFormatting
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- Specified by:
setNumControlPoints
in interfaceColorScaleFormatting
-
getColors
Description copied from interface:ColorScaleFormatting
Gets the list of colours that are interpolated between.- Specified by:
getColors
in interfaceColorScaleFormatting
-
setColors
Description copied from interface:ColorScaleFormatting
Sets the list of colours that are interpolated between. The number must matchColorScaleFormatting.getNumControlPoints()
- Specified by:
setColors
in interfaceColorScaleFormatting
-
getThresholds
Description copied from interface:ColorScaleFormatting
Gets the list of thresholds- Specified by:
getThresholds
in interfaceColorScaleFormatting
-
setThresholds
Description copied from interface:ColorScaleFormatting
Sets the of thresholds. The number must matchColorScaleFormatting.getNumControlPoints()
- Specified by:
setThresholds
in interfaceColorScaleFormatting
-
createColor
- Returns:
- color from scale
-
createThreshold
Description copied from interface:ColorScaleFormatting
Creates a new, empty Threshold- Specified by:
createThreshold
in interfaceColorScaleFormatting
-