public class

RampDefinition

extends Object
java.lang.Object
   ↳ com.esri.core.renderer.RampDefinition

Class Overview

This class is used to store the properties of an AlgorithmicColorRamp and serialize/deserialize to/from JSON.

Summary

Nested Classes
enum RampDefinition.Algorithm Defines an algorithm used by a map server to generate a color ramp given starting and ending colors. 
Public Constructors
RampDefinition(int from, int to, RampDefinition.Algorithm algorithm)
Instantiates a new ramp definition with the given from and to colors and the given algorithm.
Public Methods
RampDefinition.Algorithm getAlgorithm()
Gets the algorithm used to generate intermediate colors between the from color and the to color.
int getFromColor()
Gets the from color.
int getToColor()
Gets the to color.
void setAlgorithm(RampDefinition.Algorithm algorithm)
Sets the algorithm used to generate intermediate colors between the from color and the to color.
void setFromColor(int fromColor)
Sets the from color.
void setToColor(int toColor)
Sets the to color.
String toString()
Protected Methods
void toJson(JsonGenerator node)
Write this class to the given JsonNode.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RampDefinition (int from, int to, RampDefinition.Algorithm algorithm)

Instantiates a new ramp definition with the given from and to colors and the given algorithm.

Parameters
from int: the from
to int: the to
algorithm RampDefinition.Algorithm: the algorithm

Public Methods

public RampDefinition.Algorithm getAlgorithm ()

Gets the algorithm used to generate intermediate colors between the from color and the to color.

Returns
RampDefinition.Algorithm the algorithm

public int getFromColor ()

Gets the from color.

Returns
int the from color

public int getToColor ()

Gets the to color.

Returns
int the to color

public void setAlgorithm (RampDefinition.Algorithm algorithm)

Sets the algorithm used to generate intermediate colors between the from color and the to color.

Parameters
algorithm RampDefinition.Algorithm: the new algorithm

public void setFromColor (int fromColor)

Sets the from color.

Parameters
fromColor int: the new from color

public void setToColor (int toColor)

Sets the to color.

Parameters
toColor int: the new to color

public String toString ()

Returns
String

Protected Methods

protected void toJson (JsonGenerator node)

Write this class to the given JsonNode.

Parameters
node JsonGenerator: the node to write this instance's value to
Throws
Exception the exception