com.esri.aims.mtier.model.map.layer.renderer.symbol
Class ChartSymbol

java.lang.Object
  com.esri.aims.mtier.model.map.layer.renderer.symbol.Symbol
      com.esri.aims.mtier.model.map.layer.renderer.symbol.ChartSymbol

All Implemented Interfaces:

Serializable

public class ChartSymbol
extends Symbol

Used to symbolize features with bar or pie diagrams. The properties supported by this object matches the attributes of the ArcXML ChartSymbol element. The ChartSymbol extends the Symbol object.

See Also:

Serialized Form

Field Summary

static String	BAR
static String	PIE

Constructor Summary

ChartSymbol()
Constructs an instance of a CharSymbol.

Method Summary

void	addChartValue(ChartValue object) Adds a ChartValue object to the chartvalues collection.
void	clearChartValues() Clears all ChartValue objects from the chartvalues collection.
ChartValue	getChartValue(int index) Returns a ChartValue object by index.
int	getChartValuesCount() Returns the count of all ChartValues in the chartvalues collection.
long	getMaxSize() Returns the maximum size of chart associated with this ChartSymbol.
long	getMaxValue() Returns the ChartSymbol's maxvalue.
long	getMinSize() Returns the ChartSymbol's minsize value.
long	getMinValue() Returns the ChartSymbols minvalue.
String	getMode() Returns the type of chart associated with this ChartSymbol.
String	getOutline() Returns the ChartSymbol's outline color value.
String	getShadow() Returns the ChartSymbol's shadow color value.
long	getSize() Returns the ChartSymbol's size value.
String	getSizeField() Returns the ChartSymbol's sizefield value.
double	getTransparency() Returns the ChartSymbol's transparency value.
String	getType() Returns the type of Symbol, "Chart".
boolean	isAntialiasing() Determines if the ChartSymbol's antialiasing method is set.
Object	removeChartValue(int index) Removes a ChartValue object by index from the ChartVvalues collection.
void	setAntialiasing(boolean value) Sets the antialiasing property as active.
void	setMaxSize(long value) Sets the maximum size of chart, if size or sizefield is not used.
void	setMaxValue(long value) Sets the maximum value that corresponds to the minimum chartsize in minsize.
void	setMinSize(long value) Sets the minimum size of chart, if size or sizefield is not used.
void	setMinValue(long value) Sets the minimum value that corresponds to the minimum chartsize in minsize.
void	setMode(String value) Sets the mode of the ChartSymbol as Pie or Chart.
void	setOutline(String value) Sets the ChartSymbol's outline color value.
void	setShadow(String value) Sets the ChartSymbol's shadow color value.
void	setSize(long value) Sets the size of charts with given value.
void	setSizeField(String value) Sets the value of ChartSymbol's size field, which corresponds to the field in the database containing the size of the chart.
void	setTransparency(double value) Sets the ChartSymbol's percentage of transparency value.

Methods inherited from class java.lang.Object

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

Field Detail

PIE

public static final String PIE

See Also:

Constant Field Values

BAR

public static final String BAR

See Also:

Constant Field Values

Constructor Detail

ChartSymbol

public ChartSymbol()

Constructs an instance of a CharSymbol.

ChartSymbol chartSymbol = new ChartSymbol();

Method Detail

getType

public String getType()

Returns the type of Symbol, "Chart".

Specified by:

getType in class Symbol

Returns:

String

isAntialiasing

public boolean isAntialiasing()

Determines if the ChartSymbol's antialiasing method is set.

 if(chartSymbol.isAntialiasing() == true){
    chartSymbol.setAntialiasing(false);
 }
 

Returns:

a boolean value

See Also:

setAntialiasing(boolean)

setAntialiasing

public void setAntialiasing(boolean value)

Sets the antialiasing property as active. Note that the time to generate a map may significantly increase when this property is set to True.

 chartSymbol.setAntialiasing(true);
 

Parameters:

value - the antialiasing value.

See Also:

isAntialiasing()

setMaxSize

public void setMaxSize(long value)

Sets the maximum size of chart, if size or sizefield is not used.

chartSymbol.setMaxSize(2);

Parameters:

value - the maxsize value

See Also:

getMaxSize()

getMaxSize

public long getMaxSize()

Returns the maximum size of chart associated with this ChartSymbol.

long maxSize = chartSymbol.getMaxSize();

Returns:

long

See Also:

setMaxSize(long)

setMaxValue

public void setMaxValue(long value)

Sets the maximum value that corresponds to the minimum chartsize in minsize.

chartSymbol.setMaxValue(25);

Parameters:

value - the maximum value .

See Also:

getMaxValue()

getMaxValue

public long getMaxValue()

Returns the ChartSymbol's maxvalue.

long maxValue = chartSymbol.getMaxValue();

Returns:

long

See Also:

setMaxValue(long)

setMinSize

public void setMinSize(long value)

Sets the minimum size of chart, if size or sizefield is not used.

chartSymbol.setMinSize(15);

Parameters:

value - the minsize value.

See Also:

getMinSize()

getMinSize

public long getMinSize()

Returns the ChartSymbol's minsize value.

long minSize = chartSymbol.getMinSize();

Returns:

long

See Also:

setMinSize(long)

setMinValue

public void setMinValue(long value)

Sets the minimum value that corresponds to the minimum chartsize in minsize.

chartSymbol.setMinValue(15);

Parameters:

value - the minimum value.

See Also:

getMinValue()

getMinValue

public long getMinValue()

Returns the ChartSymbols minvalue.

String minValue = chartSymbol.getMinValue();

Returns:

long

See Also:

setMinValue(long)

setMode

public void setMode(String value)

Sets the mode of the ChartSymbol as Pie or Chart.

chartSymbol.setMode("Pie");

Parameters:

value - the type of chart - Pie or Chart.

See Also:

getMode()

getMode

public String getMode()

Returns the type of chart associated with this ChartSymbol.

String mode = chartSymbol.getMode();

Returns:

String

See Also:

setMode(java.lang.String)

setOutline

public void setOutline(String value)

Sets the ChartSymbol's outline color value.

chartSymbol.setOutline("100,0,0");

Parameters:

value - the outline color value.

See Also:

getOutline()

getOutline

public String getOutline()

Returns the ChartSymbol's outline color value.

String outline = chartSymbol.getOutline();

Returns:

String

See Also:

setOutline(java.lang.String)

setShadow

public void setShadow(String value)

Sets the ChartSymbol's shadow color value.

chartSymbol.setShadow("250,0,0");

Parameters:

value - the shadow color value.

See Also:

getShadow()

getShadow

public String getShadow()

Returns the ChartSymbol's shadow color value.

String shadow = chartSymbol.getShadow();

Returns:

String

See Also:

setShadow(java.lang.String)

setSize

public void setSize(long value)

Sets the size of charts with given value. All charts will be the same size.

chartSymbol.setSize(25);

Parameters:

value - the chart size.

See Also:

getSize()

getSize

public long getSize()

Returns the ChartSymbol's size value.

long size = chartSymbol.getSize();

Returns:

long

See Also:

setSize(long)

setSizeField

public void setSizeField(String value)

Sets the value of ChartSymbol's size field, which corresponds to the field in the database containing the size of the chart. The field can be in the layer table or the joined table. Example:

chartSymbol.setSizeField("lakes");

Refer to the ArcXML Programmer's Reference Guide for more information.

Parameters:

value - the sizefield value

See Also:

getSizeField()

getSizeField

public String getSizeField()

Returns the ChartSymbol's sizefield value. Example:

String field = chartSymbol.getSizeField();

Returns:

String

See Also:

setSizeField(java.lang.String)

setTransparency

public void setTransparency(double value)

Sets the ChartSymbol's percentage of transparency value. Example:

chartSymbol.setTransparency(25.0);

Parameters:

value - the transparency value of chart symbol. 1.0 is 0 percent transparent and 0.0 is 100 percent transparent.

See Also:

getTransparency()

getTransparency

public double getTransparency()

Returns the ChartSymbol's transparency value. Example:

double transparency = chartSymbol.getTransparency();

Returns:

double

See Also:

setTransparency(double)

addChartValue

public void addChartValue(ChartValue object)

Adds a ChartValue object to the chartvalues collection. Example:

 ChartValue chartValue = new ChartValue();
 chartValue.setLookUpField("world");
 chartValue.setColor("100,100,100");
 chartSymbol.addChartValue(chartValue);
 

Parameters:

object - the ChartValue object.

See Also:

getChartValue(int), removeChartValue(int), clearChartValues(), getChartValuesCount()

getChartValue

public ChartValue getChartValue(int index)

Returns a ChartValue object by index. Example:

 ChartValue chartValue = chartSymbol.getChartValue(0);
 

Parameters:

index - the ChartValue item to be returned.

Returns:

ChartValue

See Also:

addChartValue(com.esri.aims.mtier.model.map.layer.renderer.symbol.ChartValue), removeChartValue(int), clearChartValues(), getChartValuesCount()

removeChartValue

public Object removeChartValue(int index)

Removes a ChartValue object by index from the ChartVvalues collection. Example:

 ChartValue chartValue = (ChartValue)chartSymbol.removeChartValue(0);
 

Parameters:

index - the ChartValue by index.

Returns:

Object

See Also:

addChartValue(com.esri.aims.mtier.model.map.layer.renderer.symbol.ChartValue), getChartValue(int), clearChartValues(), getChartValuesCount()

clearChartValues

public void clearChartValues()

Clears all ChartValue objects from the chartvalues collection. Example:

 chartSymbol.clearChartValues();
 

See Also:

addChartValue(com.esri.aims.mtier.model.map.layer.renderer.symbol.ChartValue), getChartValue(int), removeChartValue(int), getChartValuesCount()

getChartValuesCount

public int getChartValuesCount()

Returns the count of all ChartValues in the chartvalues collection. Example: int chartValuesCount = chartSymbol.getChartValuesCount();

Returns:

int

See Also:

addChartValue(com.esri.aims.mtier.model.map.layer.renderer.symbol.ChartValue), getChartValue(int), removeChartValue(int), clearChartValues()