com.orchestranetworks.addon.dqid.chart

Class Chart

java.lang.Object

com.orchestranetworks.addon.dqid.chart.Chart

public abstract class Chart
extends Object

Represents a chart.

See Also:

ChartFactory, Data, Options, DisplayOptions

Method Summary

Modifier and Type	Method and Description
String	getContainerID()
static void	prepare(com.orchestranetworks.ui.UIComponentWriter writer) Deprecated. From 2.6.1, please use the new API prepareResources(UIComponentWriter) instead.
static void	prepare(com.orchestranetworks.ui.UIComponentWriter writer, Template template) Deprecated. From 2.6.1, please use the new API prepareResources(UIComponentWriter, Template) instead.
void	prepareResources(com.orchestranetworks.ui.UIComponentWriter writer) Prepares the Chart framework.
void	prepareResources(com.orchestranetworks.ui.UIComponentWriter writer, Template template) Prepares the framework using a specific Template object that specifies global options for all charts.
void	write(com.orchestranetworks.ui.UIComponentWriter writer) Writes this chart to the HTML document.

Methods inherited from class java.lang.Object

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

Method Detail

getContainerID

public String getContainerID()

Returns:

Returns the id attribute of the div HTML element containing this chart.

write

public final void write(com.orchestranetworks.ui.UIComponentWriter writer)

Writes this chart to the HTML document.

prepare

@Deprecated
public static final void prepare(com.orchestranetworks.ui.UIComponentWriter writer)

Deprecated. From 2.6.1, please use the new API prepareResources(UIComponentWriter) instead.

Prepares the Chart framework.

This method includes all the javascript libraries and declares the appropriate javascript code required for the API to function properly.
This method must be called before any chart is written.

See Also:

prepare(UIComponentWriter, Template)

prepare

@Deprecated
public static final void prepare(com.orchestranetworks.ui.UIComponentWriter writer,
                                             Template template)

Deprecated. From 2.6.1, please use the new API prepareResources(UIComponentWriter, Template) instead.

Prepares the framework using a specific Template object that specifies global options for all charts.

This is useful to provide a consistent look for all charts, such as the color-palette without having to redefine these options for each chart.
These options can be overridden for a specific chart using the Options object.
This method must be called before any chart is written.

See Also:

Template, Options

prepareResources

public final void prepareResources(com.orchestranetworks.ui.UIComponentWriter writer)

Prepares the Chart framework.

This method includes all the javascript libraries and declares the appropriate javascript code required for the API to function properly.
This method must be called before any chart is written.

Since:

2.6.1

See Also:

prepare(UIComponentWriter, Template)

prepareResources

public final void prepareResources(com.orchestranetworks.ui.UIComponentWriter writer,
                                   Template template)

Prepares the framework using a specific Template object that specifies global options for all charts.

This is useful to provide a consistent look for all charts, such as the color-palette without having to redefine these options for each chart.
These options can be overridden for a specific chart using the Options object.
This method must be called before any chart is written.

Since:

2.6.1

See Also:

Template, Options