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