Package uk.ac.rdg.resc.edal.graphics.utils

Class PlottingStyleParameters

java.lang.Object

uk.ac.rdg.resc.edal.graphics.utils.PlottingStyleParameters

public class PlottingStyleParameters
extends Object

Class defining the parameters which affect the style of a plot and which can be substituted into a style template.

Author:

Guy Griffiths

Constructor Summary

Constructors

Constructor	Description
PlottingStyleParameters(List<Extent<Float>> scaleRanges, String palette, Color aboveMaxColour, Color belowMinColour, Color noDataColour, Boolean logScaling, Integer numColourBands, Float opacity)

Method Summary

Modifier and Type	Method	Description
Color	getAboveMaxColour()
Color	getBelowMinColour()
Extent<Float>	getColorScaleRange()
List<Extent<Float>>	getColorScaleRanges()
Color	getNoDataColour()
Integer	getNumColorBands()
Float	getOpacity()
String	getPalette()
Boolean	isLogScaling()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlottingStyleParameters

public PlottingStyleParameters(List<Extent<Float>> scaleRanges,
                               String palette,
                               Color aboveMaxColour,
                               Color belowMinColour,
                               Color noDataColour,
                               Boolean logScaling,
                               Integer numColourBands,
                               Float opacity)

Method Detail

getColorScaleRange

public Extent<Float> getColorScaleRange()

Returns:

The first defined scale range of this layer

getColorScaleRanges

public List<Extent<Float>> getColorScaleRanges()

Returns:

The scale ranges of this layer

getPalette

public String getPalette()

Returns:

The palette to use for this layer. This can be an existing palette name, or a palette definition in the form #[aa]rrggbb,#[aa]rrggbb,#[aa]rrggbb..., where each element is a hexadecimal value

getAboveMaxColour

public Color getAboveMaxColour()

Returns:

The colour to use for values which are higher the the maximum scale value.

getBelowMinColour

public Color getBelowMinColour()

Returns:

The colour to use for values which are lower the the minimum scale value.

getNoDataColour

public Color getNoDataColour()

Returns:

The colour to use for values which have no data.

isLogScaling

public Boolean isLogScaling()

Returns:

true if this variable is to use logarithmic scaling by default

getNumColorBands

public Integer getNumColorBands()

Returns:

The number of colour bands to use for this layer's palette

getOpacity

public Float getOpacity()