public class SLDColorMapBuilder extends Object
LinearColorMap
using elements from RasterSymbolizer
ColorMapTransform
element.
This class is not intended to be thread safe.
Modifier and Type | Field and Description |
---|---|
static Color |
defaultColorForValuesToPreserve |
static Color |
defaultGapsColor
Default color to fill gaps
|
Constructor and Description |
---|
SLDColorMapBuilder()
Default constructor for the
SLDColorMapBuilder class. |
SLDColorMapBuilder(String name)
Constructor for the
SLDColorMapBuilder class. |
Modifier and Type | Method and Description |
---|---|
SLDColorMapBuilder |
addColorMapEntry(ColorMapEntry colorMapEntry)
|
SLDColorMapBuilder |
addValueToPreserve(double value)
Add a value that we should try to preserve while applying the color map.
|
LinearColorMap |
buildLinearColorMap() |
Color |
getColorForValuesToPreserve() |
boolean |
getExtendedColors()
Getter of the property extendedColors
|
int |
getLinearColorMapType()
Retrieves the
LinearColorMap.LinearColorMapType for this SLDColorMapBuilder . |
int |
getNumberColorMapEntries()
Getter of the property numberColorMapEntries
|
int |
getNumberOfColorMapElements()
Getter of the property numberOfColorMapElements
|
double[] |
getValuesToPreserve()
Retrieves the values to preserve.
|
SLDColorMapBuilder |
setColorForValuesToPreserve(Color color)
Set the color to use for the values we want to preserve.
|
SLDColorMapBuilder |
setExtendedColors(boolean extendedColors)
Setter of the property extendedColors
Unless this property is set prior to start working with this
SLDColorMapBuilder we
will make use of only 256 colors. |
void |
setGapsColor(Color defaultColor)
Sets the default
Color to use when a value falls outside the range of values for
provided color map elements. |
SLDColorMapBuilder |
setLinearColorMapType(int colorMapType)
Sets the
LinearColorMap.LinearColorMapType for this SLDColorMapBuilder . |
SLDColorMapBuilder |
setNumberColorMapEntries(int numberColorMapEntries)
Setter of the property numberColorMapEntries
|
public static final Color defaultColorForValuesToPreserve
public static final Color defaultGapsColor
public SLDColorMapBuilder()
SLDColorMapBuilder
class.public SLDColorMapBuilder(String name)
SLDColorMapBuilder
class.name
- name for the LinearColorMap
we will create at the end of this process.public void setGapsColor(Color defaultColor)
Color
to use when a value falls outside the range of values for
provided color map elements.
Note that once the underlying colormap has been built this method will throw an IllegalStateException
if invoked.
In case one would want to unset the default color, he should simply call this method with
a null
value.
the
- default Color
to use when a value falls outside the provided color map
elements.public SLDColorMapBuilder setLinearColorMapType(int colorMapType)
LinearColorMap.LinearColorMapType
for this SLDColorMapBuilder
.SLDColorMapBuilder
.LinearColorMap.LinearColorMapType
public int getLinearColorMapType()
LinearColorMap.LinearColorMapType
for this SLDColorMapBuilder
.
-1
is returned in case the LinearColorMap.LinearColorMapType
is still unspecified.
LinearColorMap.LinearColorMapType
for this SLDColorMapBuilder
or -1
case the LinearColorMap.LinearColorMapType
is still unspecified.public SLDColorMapBuilder addColorMapEntry(ColorMapEntry colorMapEntry)
colorMapEntry
- public double[] getValuesToPreserve()
ColorMapTransform
we will create.public SLDColorMapBuilder addValueToPreserve(double value)
This means that all the values we add using this method will be mapped to the same color
which can be set using setColorForValuesToPreserve(Color)
.
SLDColorMapBuilder
.public SLDColorMapBuilder setColorForValuesToPreserve(Color color)
SLDColorMapBuilder
.public Color getColorForValuesToPreserve()
public boolean getExtendedColors()
public SLDColorMapBuilder setExtendedColors(boolean extendedColors)
Unless this property is set prior to start working with this SLDColorMapBuilder
we
will make use of only 256 colors. If we use extended colors, then we'll be able to use up to
65536 colors.
Note that this imposes a limitation on the maximum number of ColorMapEntry
we can
use.
extendedColors
- The extendedColors to set.public int getNumberColorMapEntries()
public SLDColorMapBuilder setNumberColorMapEntries(int numberColorMapEntries)
numberColorMapEntries
- The numberColorMapEntries to set.public int getNumberOfColorMapElements()
public LinearColorMap buildLinearColorMap()
Copyright © 1996–2019 Geotools. All rights reserved.