org.gvsig.chart

Interface ChartProperties

All Superinterfaces:

Cloneable, DynObject, Persistent

All Known Subinterfaces:

GroupedChartsProperties

All Known Implementing Classes:

AbstractChartProperties, BarsChartProperties, OverlayChartProperties, PieChartProperties, TemporalChartProperties, XYPlotChartProperties

public interface ChartProperties
extends DynObject, Persistent, Cloneable

This class contains the definition of a ChartService.

See Also:

ChartService

Method Summary

Methods

Modifier and Type	Method and Description
ChartProperties	clone()
String	getChartDescription() Obtains a description of the chart purpose
boolean	getChartIsHorizontal() Check if the chart will be painted on horizontal or vertical
boolean	getChartLabellingDataShown()
Font	getChartLabellingFont()
String	getChartLabellingPosition()
boolean	getChartLabellingVisible()
String	getChartName() Get the name of the chart (internal name)
ChartRenderer	getChartRenderer() Get the current ChartRenderer used
ChartRenderer	getChartRenderer(String name)
String	getChartRendererName() Get ID of the current ChartRenderer used
String	getChartTableName() Gets the table name of the data origin.
String	getChartTitle() Get the title of the chart (shown in the chart area drawn)
String	getChartType() Get the ChartService's type.
float	getDomainAxisPosition()
boolean	getHasLegendCoordinates() Gets if it must use the coordinates or not
boolean	getHasLegendDefaultConf() If the legend must attend to the manual configuration or the default
boolean	getHasPlotDefaultSize() Determines if the Plot has a default size
boolean	getHasPlotOutline() Determines if the Plot has outline or not
boolean	getIsLegendVisible() Gets if the legend is visible or not in this ChartService
String	getLegendOrientation() Obtains the predefined place inside the position selected of the legend
String	getLegendPosition() Obtains the predefined position of the legend
Font	getLegendTitleFont() Gets the font used on the title
boolean	getLegendTitleIsVisible() Gets if the legend title is visible
String	getLegendTitleText() Obtains the legend's title
int	getLegendXCoordinate() Obtains the x-coordinate of the position of the legend
int	getLegendYCoordinate() Obtains the y-coordinate of the position of the legend
String	getNoDataMessageText()
boolean	getNullGroupIgnored()
float	getPlotBackgroundAlpha() Gets the transparency alpha value of the plot area background
Color	getPlotBackgroundColor() Gets the background color of the Plot area
int	getPlotHeight() Returns the plot area height
int	getPlotWidth() Returns the plot area width
int	getPlotXPosition() Gets the x-coordinate of the upper-left corner of the Plot area
int	getPlotYPosition() Gets the y-coordinate of the upper-left corner of the Plot area
Map<String,ChartRenderer>	getRenderers()
RequiredField	getRequiredField(String name) Get an specific RequiredField using its name.
List<RequiredField>	getRequiredFields() Get a List with the RequiredFields needed to define the the set of fields of the ChartDataSet to contain the chart's data
boolean	getUseSelectedFeatures() true if the chart will be rendered only for selected features
boolean	hasDefaultChartAxis()
boolean	is3DChart() Gets the dimension of the chart
boolean	isChartVisibleIfNoData()
boolean	isMandatoryChart()
boolean	isXYPlotChart()
void	setChartDescription(String description)
void	setChartDimension(Boolean type)
void	setChartDynValue(String name, Object value) Deprecated.
void	setChartLabellingDataShown(boolean b)
void	setChartLabellingFont(Font labellingFont)
void	setChartLabellingPosition(String chartLabellingRotation)
void	setChartLabellingVisible(boolean visible)
void	setChartName(String name)
void	setChartRenderer(String chartRendererName)
void	setChartTableName(String name)
void	setChartTitle(String title) This method gives a title to the chart when it's drawn
void	setDomainAxisPosition(float angle)
void	setHasDefaultChartAxis(boolean selected)
void	setHasLegendCoordinates(boolean urls) Assign if the legend must use a coordinates manually indicated
void	setHasLegendManualConf(boolean urls) Indicates if the Legend have to use the default configuration or it has another one specified manually
void	setHasPlotManualSize(boolean urls) Sets if the Plot has a non-predefined size
void	setHasPlotOutline(boolean urls) Sets if the plot has outline or not
void	setIsChartVisibleIfNoData(boolean charts)
void	setIsLegendVisible(boolean urls) Sets if the legend will be visible for this ChartService
void	setIsMandatoryChart(boolean selected)
void	setIsXYPlotChart(boolean selected)
void	setLegendOrientation(String table) Inserts a predefined place inside the position selected for the legend
void	setLegendPosition(String table) Establish a predefined position for the legend
void	setLegendTitleFont(Font font) Establishes a font for the title
void	setLegendTitleIsVisible(boolean selected) Sets if the legend title will be visible
void	setLegendTitleText(String title) Assigns a text to the legend title
void	setLegendXCoordinate(int table) Sets the x-coordinate of the legend
void	setLegendYCoordinate(int table) Sets the y-coordinate of the legend
void	setNoDataMessageText(String text)
void	setNullGroupIgnored(boolean ignored)
void	setPlotBackgroundAlpha(float table) Sets a transparency for the plot area background
void	setPlotBackgroundColor(Color table) Assigns a background color to the Plot area
void	setPlotHeight(int table) Defines the height of the Plot area
void	setPlotWidth(int table) Defines the width of the Plot area
void	setPlotXPosition(int table) Establishes a x-coordinate for the upper-left corner of the Plot area
void	setPlotYPosition(int table) Establishes a y-coordinate for the upper-left corner of the Plot area
void	setUseSelectedFeatures(boolean b)

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clear, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Method Detail

getChartType

String getChartType()

Get the ChartService's type.

Returns:

a String with the ID of the kind of Service

getChartName

String getChartName()

Get the name of the chart (internal name)

Returns:

the ChartService's name

setChartName

void setChartName(String name)

getChartTitle

String getChartTitle()

Get the title of the chart (shown in the chart area drawn)

Returns:

the ChartService's title

setChartTitle

void setChartTitle(String title)

This method gives a title to the chart when it's drawn

Parameters:

title -

getChartDescription

String getChartDescription()

Obtains a description of the chart purpose

Returns:

description of the chart

setChartDescription

void setChartDescription(String description)

is3DChart

boolean is3DChart()

Gets the dimension of the chart

Returns:

true if it's 3D or false if it is 2D

setChartDimension

void setChartDimension(Boolean type)

getChartIsHorizontal

boolean getChartIsHorizontal()

Check if the chart will be painted on horizontal or vertical

Returns:

true if is horizontal or false if it's vertical

getRequiredFields

List<RequiredField> getRequiredFields()

Get a List with the RequiredFields needed to define the the set of fields of the ChartDataSet to contain the chart's data

Returns:

List of RequiredFields

setChartDynValue

@Deprecated
void setChartDynValue(String name,
                               Object value)

Deprecated.

getChartTableName

String getChartTableName()

Gets the table name of the data origin.

Returns:

table name

setChartTableName

void setChartTableName(String name)

getRequiredField

RequiredField getRequiredField(String name)

Get an specific RequiredField using its name.

Parameters:

{@link - RequiredField}'s name

Returns:

RequiredField

getChartRendererName

String getChartRendererName()

Get ID of the current ChartRenderer used

Returns:

ChartRenderer name

getChartRenderer

ChartRenderer getChartRenderer()

Get the current ChartRenderer used

Returns:

ChartRenderer

setIsLegendVisible

void setIsLegendVisible(boolean urls)

Sets if the legend will be visible for this ChartService

getIsLegendVisible

boolean getIsLegendVisible()

Gets if the legend is visible or not in this ChartService

Returns:

if is visible or not

setLegendTitleIsVisible

void setLegendTitleIsVisible(boolean selected)

Sets if the legend title will be visible

Parameters:

true - if visible, false if not

getLegendTitleIsVisible

boolean getLegendTitleIsVisible()

Gets if the legend title is visible

Returns:

legend title's visibility

setLegendTitleText

void setLegendTitleText(String title)

Assigns a text to the legend title

Parameters:

title -

getLegendTitleText

String getLegendTitleText()

Obtains the legend's title

Returns:

the legend's title

setLegendTitleFont

void setLegendTitleFont(Font font)

Establishes a font for the title

Parameters:

font - to be used

getLegendTitleFont

Font getLegendTitleFont()

Gets the font used on the title

Returns:

the font used

setHasLegendManualConf

void setHasLegendManualConf(boolean urls)

Indicates if the Legend have to use the default configuration or it has another one specified manually

Parameters:

true - if has a manual configuration, false to use the default one

getHasLegendDefaultConf

boolean getHasLegendDefaultConf()

If the legend must attend to the manual configuration or the default

Returns:

true if has manual configuration, false if not

setHasLegendCoordinates

void setHasLegendCoordinates(boolean urls)

Assign if the legend must use a coordinates manually indicated

Parameters:

boolean - to use coordinates or not

getHasLegendCoordinates

boolean getHasLegendCoordinates()

Gets if it must use the coordinates or not

Returns:

boolean - if it have to use it or not

getLegendPosition

String getLegendPosition()

Obtains the predefined position of the legend

Returns:

String with the position (TOP, BOTTOM, LEFT, RIGHT);

setLegendPosition

void setLegendPosition(String table)

Establish a predefined position for the legend

Parameters:

String - with a valid predefined position (TOP, BOTTOM, LEFT, RIGHT)

getLegendOrientation

String getLegendOrientation()

Obtains the predefined place inside the position selected of the legend

Returns:

a orientation inside the selected position (LEFT, CENTER, RIGHT) for the TOP and BOTTOM positions, and TOP, CENTER and BOTTOM for the LEFT, RIGHT positions.

setLegendOrientation

void setLegendOrientation(String table)

Inserts a predefined place inside the position selected for the legend

Parameters:

a - orientation inside the selected position (LEFT, CENTER, RIGHT) for the TOP and BOTTOM positions, and TOP, CENTER and BOTTOM for the LEFT, RIGHT positions.

getLegendXCoordinate

int getLegendXCoordinate()

Obtains the x-coordinate of the position of the legend

Returns:

pixels moved over x-axis

setLegendXCoordinate

void setLegendXCoordinate(int table)

Sets the x-coordinate of the legend

Parameters:

number - of pixels to be moved over the x-axis

getLegendYCoordinate

int getLegendYCoordinate()

Obtains the y-coordinate of the position of the legend

Returns:

pixels moved over y-axis

setLegendYCoordinate

void setLegendYCoordinate(int table)

Sets the y-coordinate of the legend

Parameters:

number - of pixels to be moved over the y-axis

getPlotBackgroundColor

Color getPlotBackgroundColor()

Gets the background color of the Plot area

Returns:

The background color

setPlotBackgroundColor

void setPlotBackgroundColor(Color table)

Assigns a background color to the Plot area

Parameters:

The - color to assign

getPlotBackgroundAlpha

float getPlotBackgroundAlpha()

Gets the transparency alpha value of the plot area background

Returns:

the transparency factor

setPlotBackgroundAlpha

void setPlotBackgroundAlpha(float table)

Sets a transparency for the plot area background

Parameters:

The - transparency value

setHasPlotOutline

void setHasPlotOutline(boolean urls)

Sets if the plot has outline or not

Parameters:

true - if has outline, false if not

getHasPlotOutline

boolean getHasPlotOutline()

Determines if the Plot has outline or not

Returns:

true if has outline, false if not

setHasPlotManualSize

void setHasPlotManualSize(boolean urls)

Sets if the Plot has a non-predefined size

Parameters:

false - if has manual configuration, true if not

getHasPlotDefaultSize

boolean getHasPlotDefaultSize()

Determines if the Plot has a default size

Returns:

true if has default size, false if not

getPlotXPosition

int getPlotXPosition()

Gets the x-coordinate of the upper-left corner of the Plot area

Returns:

integer with the x-coordinate

setPlotXPosition

void setPlotXPosition(int table)

Establishes a x-coordinate for the upper-left corner of the Plot area

Parameters:

int - with the x-coordinate

getPlotYPosition

int getPlotYPosition()

Gets the y-coordinate of the upper-left corner of the Plot area

Returns:

integer with the y-coordinate

setPlotYPosition

void setPlotYPosition(int table)

Establishes a y-coordinate for the upper-left corner of the Plot area

Parameters:

int - with the y-coordinate

getPlotWidth

int getPlotWidth()

Returns the plot area width

Returns:

the width of the plot area

setPlotWidth

void setPlotWidth(int table)

Defines the width of the Plot area

Parameters:

the - plot area width

getPlotHeight

int getPlotHeight()

Returns the plot area height

Returns:

the height of the plot area

setPlotHeight

void setPlotHeight(int table)

Defines the height of the Plot area

Parameters:

the - plot area height

isMandatoryChart

boolean isMandatoryChart()

setIsMandatoryChart

void setIsMandatoryChart(boolean selected)

hasDefaultChartAxis

boolean hasDefaultChartAxis()

setHasDefaultChartAxis

void setHasDefaultChartAxis(boolean selected)

isXYPlotChart

boolean isXYPlotChart()

setIsXYPlotChart

void setIsXYPlotChart(boolean selected)

clone

ChartProperties clone()

getNoDataMessageText

String getNoDataMessageText()

setNoDataMessageText

void setNoDataMessageText(String text)

isChartVisibleIfNoData

boolean isChartVisibleIfNoData()

setIsChartVisibleIfNoData

void setIsChartVisibleIfNoData(boolean charts)

getUseSelectedFeatures

boolean getUseSelectedFeatures()

true if the chart will be rendered only for selected features

Returns:

setUseSelectedFeatures

void setUseSelectedFeatures(boolean b)

getChartRenderer

ChartRenderer getChartRenderer(String name)

getRenderers

Map<String,ChartRenderer> getRenderers()

setChartRenderer

void setChartRenderer(String chartRendererName)

getNullGroupIgnored

boolean getNullGroupIgnored()

setNullGroupIgnored

void setNullGroupIgnored(boolean ignored)

getDomainAxisPosition

float getDomainAxisPosition()

setDomainAxisPosition

void setDomainAxisPosition(float angle)

setChartLabellingVisible

void setChartLabellingVisible(boolean visible)

getChartLabellingVisible

boolean getChartLabellingVisible()

setChartLabellingFont

void setChartLabellingFont(Font labellingFont)

getChartLabellingFont

Font getChartLabellingFont()

setChartLabellingDataShown

void setChartLabellingDataShown(boolean b)

getChartLabellingPosition

String getChartLabellingPosition()

setChartLabellingPosition

void setChartLabellingPosition(String chartLabellingRotation)

getChartLabellingDataShown

boolean getChartLabellingDataShown()