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.intHow many control points should be used to map the colours? Normally 2 or 3Gets the list of thresholdsvoidSets the list of colours that are interpolated between.voidsetNumControlPoints(int num) Sets the number of control points to use to map the colours.voidsetThresholds(ConditionalFormattingThreshold[] thresholds) Sets the of thresholds.
-
Method Details
-
getNumControlPoints
public int getNumControlPoints()Description copied from interface:ColorScaleFormattingHow many control points should be used to map the colours? Normally 2 or 3- Specified by:
getNumControlPointsin interfaceColorScaleFormatting
-
setNumControlPoints
public void setNumControlPoints(int num) Description copied from interface:ColorScaleFormattingSets 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
Thresholdcount and Color count match- Specified by:
setNumControlPointsin interfaceColorScaleFormatting
-
getColors
Description copied from interface:ColorScaleFormattingGets the list of colours that are interpolated between.- Specified by:
getColorsin interfaceColorScaleFormatting
-
setColors
Description copied from interface:ColorScaleFormattingSets the list of colours that are interpolated between. The number must matchColorScaleFormatting.getNumControlPoints()- Specified by:
setColorsin interfaceColorScaleFormatting
-
getThresholds
Description copied from interface:ColorScaleFormattingGets the list of thresholds- Specified by:
getThresholdsin interfaceColorScaleFormatting
-
setThresholds
Description copied from interface:ColorScaleFormattingSets the of thresholds. The number must matchColorScaleFormatting.getNumControlPoints()- Specified by:
setThresholdsin interfaceColorScaleFormatting
-
createColor
- Returns:
- color from scale
-
createThreshold
Description copied from interface:ColorScaleFormattingCreates a new, empty Threshold- Specified by:
createThresholdin interfaceColorScaleFormatting
-