edu.ucdavis.cstars.client.renderer

Class ClassBreaksRenderer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.renderer.Renderer

edu.ucdavis.cstars.client.renderer.ClassBreaksRenderer

public class ClassBreaksRenderer
extends Renderer

A class breaks renderer symbolizes each graphic based on the value of some numeric attribute.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassBreaksRenderer.Break Deprecated. at v2.0. Use Info instead
static class	ClassBreaksRenderer.Info

Method Summary

Methods

Modifier and Type	Method and Description
void	addBreak(double minValue, double maxValue, Symbol symbol) Adds a class break.
void	addBreak(double minValue, double maxValue, Symbol symbol, java.lang.String label, java.lang.String description) Adds a class break.
static ClassBreaksRenderer	create(Symbol defaultSymbol, java.lang.String attributeField) Creates a new ClassBreaksRenderer object.
java.lang.String	getAttributeField() The name of the attribute field the renderer uses to match values against.
com.google.gwt.core.client.JsArray<ClassBreaksRenderer.Break>	getBreaks() Deprecated. at v2.0, use getInfos() instead.
com.google.gwt.core.client.JsArray<ClassBreaksRenderer.Info>	getInfos() Each element in the array is an object that provides information about the class breaks associated with the renderer.
void	removeBreak(double minValue, double maxValue) Removes a break.

Methods inherited from class edu.ucdavis.cstars.client.renderer.Renderer

fromJson, getDefaultSymbol, getSymbol, toJson

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static final ClassBreaksRenderer create(Symbol defaultSymbol,
                         java.lang.String attributeField)

Creates a new ClassBreaksRenderer object.

Parameters:

defaultSymbol - - Default symbol for the renderer. This symbol is used for unmatched values.

attributeField - - Attribute field renderer uses to match values.

Returns:

ClassBreaksRenderer

getAttributeField

public final java.lang.String getAttributeField()

The name of the attribute field the renderer uses to match values against.

Returns:

String

getBreaks

public final com.google.gwt.core.client.JsArray<ClassBreaksRenderer.Break> getBreaks()

Deprecated. at v2.0, use getInfos() instead.

A 2-D array representing defined breaks. The array consists of [minValue,maxValue] pairs.

Returns:

JsArray

getInfos

public final com.google.gwt.core.client.JsArray<ClassBreaksRenderer.Info> getInfos()

Each element in the array is an object that provides information about the class breaks associated with the renderer.

Returns:

JsArray

addBreak

public final void addBreak(double minValue,
            double maxValue,
            Symbol symbol)

Adds a class break. You can provide the minimum, maximum and symbol values as individual arguments or using the info object. The range of the break is greater than or equal to the minimum value and less than the maximum value. After making changes, you must refresh the graphic.

Parameters:

minValue - - Minimum value in the break.

maxValue - - Maximum value in the break.

symbol - - Symbol used for the break.

addBreak

public final void addBreak(double minValue,
            double maxValue,
            Symbol symbol,
            java.lang.String label,
            java.lang.String description)

Adds a class break. You can provide the minimum, maximum and symbol values as individual arguments or using the info object. The range of the break is greater than or equal to the minimum value and less than the maximum value. After making changes, you must refresh the graphic.

Parameters:

minValue - - Minimum value in the break.

maxValue - - Maximum value in the break.

symbol - - Symbol used for the break.

label - - Label for the symbol used to draw the value.

description - - Label for the symbol used to draw the value.

removeBreak

public final void removeBreak(double minValue,
               double maxValue)

Removes a break. After making changes, you must refresh the graphic.

Parameters:

minValue - - Minimum value in the break to remove.

maxValue - - Maximum value in the break to remove.