org.gvsig.chart

Interface ChartService

All Superinterfaces:

Cloneable, Persistent, Service

All Known Implementing Classes:

AbstractChart, AbstractXYChart, BarsChart, OverlayChart, PieChart, TemporalChart, XYPlotChart

public interface ChartService
extends Service, Persistent, Cloneable

This class represent a Chart and provides all the method to manage it. It is defined by a ChartProperties that contains its characteristics.

See Also:

ChartProperties

Method Summary

Modifier and Type	Method and Description
boolean	canBeOverlayed() Determine if a Chart can share it plot area with others
ChartService	clone()
void	createChartLegendItems()
ChartSerieEntity	createNewChartSerieEntity(Object item)
void	draw(Graphics2D g, Rectangle r) This method draws a ChartService in a specific area.
ChartDataSet	getChartDataSet() Obtains the ChartService's data that is used on the chart
ChartEditor	getChartEditor()
ChartLegendItem	getChartLegend()
List<ChartSerieEntity>	getChartLegendItems()
String	getChartName() Get the name of the service
ChartProperties	getChartProperties() Get the ChartService's definition using a ChartProperties object.
ChartRenderer	getChartRenderer() Returns a ChartRenderer using its ID
Map<String,ChartRenderer>	getChartRenderers() With this method, you can get all the available renderers to this type of ChartService.
ChartRenderingInfo	getChartRenderingInfo()
String	getChartType() Get the ChartService's type.
List<ChartAxis>	getDomainAxis() Useful to get the DomainAxis of a ChartService
Object	getInnerChart() Useful to swing part.
List<ValueAxis>	getRangeAxis() Get the ValueAxis of a ChartService
ChartRenderer	getRenderer() It gets the renderer used to drawn the chart.
boolean	hasDomainAxis() Check if it has a DomainAxis (ChartAxis)
boolean	hasRangeAxis() Check if it has a RangeAxis (ValueAxis)
boolean	isVisible() Check if it's visible or not
void	loadSavedChartLegendItems()
void	refreshChart()
void	scaleFonts(double myScale) Method used to scale the fonts to be readable when the chart is resized
void	setAxisVisibles(boolean b)
void	setBackgroundPaint(float f) Defines the alpha value of the background (from 0.0 to 1.0)
void	setBackgroundPaint(Paint p) Defines an specific Paint to the chart's background
void	setCategoriesPaint(List<Color> colors)
void	setChartDataSet(ChartDataSet data) Insert a ChartDataSet to the service
void	setChartLegend(ChartLegendItem legend)
void	setDirty(boolean dirty)
void	setDomainAxis(ChartAxis axis) Assign a ChartAxis in a ChartService
void	setDomainAxis(List<ChartAxis> domainAxis) Assign a set of ChartAxis in a ChartService
void	setFontScaled(Font myScale)
void	setIsAChartSymbol(boolean b)
void	setRangeAxis(List<ValueAxis> rangeAxis) Assign a set of ValueAxis in a ChartService
void	setRangeAxis(ValueAxis axis) Assign a ValueAxis in a ChartService
void	setVisible(boolean isVisible) Set a flag to the ChartService to be visible or not
Object	toCategoryValue(int idSerie, int pixelY)
Object	toSerieValue(int idSerie, int pixelX)
int	toXPixelValue(int idSerie, Object value)
int	toYPixelValue(int idSerie, Object value)
void	update() Refresh chart information

Methods inherited from interface org.gvsig.tools.service.Service

getManager

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

loadFromState, saveToState

Method Detail

draw

void draw(Graphics2D g,
          Rectangle r)

This method draws a ChartService in a specific area.

Parameters:

the - graphics where it will be painted and the area of it to be draw

toSerieValue

Object toSerieValue(int idSerie,
                    int pixelX)

toXPixelValue

int toXPixelValue(int idSerie,
                  Object value)

toCategoryValue

Object toCategoryValue(int idSerie,
                       int pixelY)

toYPixelValue

int toYPixelValue(int idSerie,
                  Object value)

getChartDataSet

ChartDataSet getChartDataSet()

Obtains the ChartService's data that is used on the chart

Returns:

ChartDataSet

setChartDataSet

void setChartDataSet(ChartDataSet data)

Insert a ChartDataSet to the service

Parameters:

the - ChartDataSet to be drawn by the ChartService

getChartProperties

ChartProperties getChartProperties()

Get the ChartService's definition using a ChartProperties object.

Returns:

ChartProperties

getChartRenderingInfo

ChartRenderingInfo getChartRenderingInfo()

getChartEditor

ChartEditor getChartEditor()

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 service

Returns:

the ChartService's name

getInnerChart

Object getInnerChart()

Useful to swing part. The idea is: If someone wants to implement his own ChartService using un underlaying library, the main object can be reached by this method. In our case, the object will be a JFreeChart, but if not, the Swing library can make its own cast.

Returns:

the inner object that the library uses to render.

getRenderer

ChartRenderer getRenderer()

It gets the renderer used to drawn the chart.

Returns:

the ChartService's renderer

getChartRenderers

Map<String,ChartRenderer> getChartRenderers()

With this method, you can get all the available renderers to this type of ChartService.

Returns:

a Map with an ID and the Renderer.

getChartRenderer

ChartRenderer getChartRenderer()

Returns a ChartRenderer using its ID

Parameters:

ChartRenderer's - name

Returns:

the ChartRenderer with the ID indicated in the name

hasDomainAxis

boolean hasDomainAxis()

Check if it has a DomainAxis (ChartAxis)

Returns:

a boolean depending if it has a DomainAxis or not

hasRangeAxis

boolean hasRangeAxis()

Check if it has a RangeAxis (ValueAxis)

Returns:

a boolean depending if it has a RangeAxis or not

getDomainAxis

List<ChartAxis> getDomainAxis()

Useful to get the DomainAxis of a ChartService

Returns:

all the DomainAxis (ChartAxis) that compounds the chart

getRangeAxis

List<ValueAxis> getRangeAxis()

Get the ValueAxis of a ChartService

Returns:

all the (ValueAxis) that compounds the chart

setRangeAxis

void setRangeAxis(List<ValueAxis> rangeAxis)

Assign a set of ValueAxis in a ChartService

Parameters:

List - of ValueAxis

setRangeAxis

void setRangeAxis(ValueAxis axis)

Assign a ValueAxis in a ChartService

Parameters:

{@link - ValueAxis}

setDomainAxis

void setDomainAxis(List<ChartAxis> domainAxis)

Assign a set of ChartAxis in a ChartService

Parameters:

List - of ChartAxis

setDomainAxis

void setDomainAxis(ChartAxis axis)

Assign a ChartAxis in a ChartService

Parameters:

{@link - ChartAxis}

setBackgroundPaint

void setBackgroundPaint(Paint p)

Defines an specific Paint to the chart's background

Parameters:

the - Paint set to the background

setBackgroundPaint

void setBackgroundPaint(float f)

Defines the alpha value of the background (from 0.0 to 1.0)

Parameters:

f - alpha value

scaleFonts

void scaleFonts(double myScale)

Method used to scale the fonts to be readable when the chart is resized

Parameters:

myScale -

isVisible

boolean isVisible()

Check if it's visible or not

Returns:

true if it's visible, false if it isn't

setVisible

void setVisible(boolean isVisible)

Set a flag to the ChartService to be visible or not

Parameters:

isVisible -

getChartLegendItems

List<ChartSerieEntity> getChartLegendItems()

createChartLegendItems

void createChartLegendItems()

getChartLegend

ChartLegendItem getChartLegend()

setChartLegend

void setChartLegend(ChartLegendItem legend)

update

void update()

Refresh chart information

canBeOverlayed

boolean canBeOverlayed()

Determine if a Chart can share it plot area with others

Returns:

true if can be overlayed, false if not

clone

ChartService clone()

loadSavedChartLegendItems

void loadSavedChartLegendItems()

setIsAChartSymbol

void setIsAChartSymbol(boolean b)

setCategoriesPaint

void setCategoriesPaint(List<Color> colors)

setDirty

void setDirty(boolean dirty)

createNewChartSerieEntity

ChartSerieEntity createNewChartSerieEntity(Object item)

setFontScaled

void setFontScaled(Font myScale)

setAxisVisibles

void setAxisVisibles(boolean b)

refreshChart

void refreshChart()