|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dss.sparkChart.CommonSparkChart
public class CommonSparkChart
The spark chart is a simple, condensed graph that is used to display trends or variations. They are often used within the columns of a table, or displayed in a dashboard to provide additional context to a data-dense display.
Nested Class Summary | |
---|---|
static class |
CommonSparkChart.Type Defines the types of spark charts. |
Constructor Summary | |
---|---|
CommonSparkChart() Constructor. |
Method Summary | |
---|---|
ReferenceArea |
createReferenceArea() Creates and returns a new ReferenceArea . |
ReferenceLine |
createReferenceLine() Creates and returns a new ReferenceLine . |
void |
destroyReferenceObjects() Destroys all reference objects and removes them from the spark chart. |
void |
exportToPNG(java.io.OutputStream os) Exports this spark chart to the OutputStream as a PNG file. |
void |
exportToSVG(java.io.OutputStream os) Exports this spark chart to the OutputStream as an SVG file. |
GraphConstants.AxisScaledFromBaseline |
getAxisScaledFromBaseline() Returns the axis scaling behavior. |
java.awt.Color |
getBackgroundColor() |
java.awt.Color |
getColor() Returns the color of the data items (bars, line, or area). |
java.awt.Color |
getFirstMarkerColor() Returns the Color used to hilight the first data item. |
java.awt.Color |
getHighMarkerColor() Returns the Color used to hilight the data item with the greatest value. |
java.awt.Dimension |
getImageSize() |
java.awt.Color |
getLastMarkerColor() Returns the Color used to hilight the last data item. |
java.awt.Color |
getLowMarkerColor() Returns the Color used to hilight the data item with the smallest value. |
java.util.EnumSet<GraphConstants.Markers> |
getMarkers() Returns the markers to display on this spark chart. |
java.lang.String |
getNoDataErrorText() Returns the text that will be shown when this spark chart has no data. |
java.util.List<ReferenceObject> |
getReferenceObjects() Returns a List of all reference objects belonging to this spark chart. |
Threshold |
getThreshold() Returns the Threshold instance used for customizing thresholds for this spark chart. |
CommonSparkChart.Type |
getType() Returns the type of this spark chart; such as bar, line, or area. |
java.lang.String |
getXML() Returns XML containing attribute settings for this spark chart. |
void |
setAxisScaledFromBaseline(GraphConstants.AxisScaledFromBaseline value) Specifies the axis scaling behavior. |
void |
setBackgroundColor(java.awt.Color color) |
void |
setColor(java.awt.Color color) Specifies the color of the data items (bars, line, or area). |
void |
setFirstMarkerColor(java.awt.Color color) Specifies the Color used to hilight the first data item. |
void |
setHighMarkerColor(java.awt.Color color) Specifies the Color used to hilight the data item with the greatest value. |
void |
setImageSize(java.awt.Dimension size) |
void |
setLastMarkerColor(java.awt.Color color) Specifies the Color used to hilight the last data item. |
void |
setLowMarkerColor(java.awt.Color color) Specifies the Color used to hilight the data item with the smallest value. |
void |
setMarkers(java.util.EnumSet<GraphConstants.Markers> markers) Specifies the markers to display on this spark chart. |
void |
setNoDataErrorText(java.lang.String text) Specifies the text that will be shown when this spark chart has no data. |
void |
setType(CommonSparkChart.Type type) Specifies the type of this spark chart; such as bar, line or area. |
void |
setValue(java.util.List<SparkItem> data) Specifies the data for this spark chart. |
void |
setXML(java.lang.String xml) Applies XML containing attribute settings onto this spark chart. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CommonSparkChart()
Method Detail |
---|
public void setValue(java.util.List<SparkItem> data)
data
- the List of SparkItems containing the data for this spark chartpublic void exportToPNG(java.io.OutputStream os) throws java.io.IOException, java.lang.Exception
OutputStream
as a PNG file.os
- the OutputStream
where the PNG will be writtenjava.io.IOException
- if an error occurs in using the OutputStream
java.lang.Exception
- if any other error occurs while exporting to PNGpublic void exportToSVG(java.io.OutputStream os) throws java.io.IOException, java.lang.Exception
OutputStream
as an SVG file.os
- the OutputStream
where the SVG will be writtenjava.io.IOException
- if an error occurs in using the OutputStream
java.lang.Exception
- if any other error occurs while exporting to SVGpublic java.lang.String getXML()
setXML
to save and restore state. This syntax may change in future versions of the code, so XML retrieved from one version of the spark chart should only be used with the same version.public void setXML(java.lang.String xml) throws oracle.dss.util.xml.BIIOException, oracle.dss.util.xml.BISAXException, oracle.dss.util.xml.BIParseException
getXML
to save and restore state. This syntax may change in future versions of the code, so XML retrieved from one version of the spark chart should only be used with the same version.xml
- a String representing the attribute settings for the componentoracle.dss.util.xml.BIIOException
oracle.dss.util.xml.BISAXException
oracle.dss.util.xml.BIParseException
public GraphConstants.AxisScaledFromBaseline getAxisScaledFromBaseline()
GraphConstants.AxisScaledFromBaseline
public void setAxisScaledFromBaseline(GraphConstants.AxisScaledFromBaseline value)
GraphConstants.AxisScaledFromBaseline
public java.awt.Color getBackgroundColor()
public void setBackgroundColor(java.awt.Color color)
public java.awt.Color getColor()
public void setColor(java.awt.Color color)
public java.awt.Dimension getImageSize()
public void setImageSize(java.awt.Dimension size)
public java.util.EnumSet<GraphConstants.Markers> getMarkers()
GraphConstants.Markers
public void setMarkers(java.util.EnumSet<GraphConstants.Markers> markers)
GraphConstants.Markers
public java.awt.Color getFirstMarkerColor()
setMarkers
method must be called to enable this functionality.public void setFirstMarkerColor(java.awt.Color color)
setMarkers
method must be called to enable this functionality.color
- the Color used to hilight the first data item.public java.awt.Color getLastMarkerColor()
setMarkers
method must be called to enable this functionality.public void setLastMarkerColor(java.awt.Color color)
setMarkers
method must be called to enable this functionality.color
- the Color used to hilight the last data item.public java.awt.Color getHighMarkerColor()
setMarkers
method must be called to enable this functionality.public void setHighMarkerColor(java.awt.Color color)
setMarkers
method must be called to enable this functionality.color
- the Color used to hilight the data item with the greatest value.public java.awt.Color getLowMarkerColor()
setMarkers
method must be called to enable this functionality.public void setLowMarkerColor(java.awt.Color color)
setMarkers
method must be called to enable this functionality.color
- the Color used to hilight the data item with the smallest value.public java.lang.String getNoDataErrorText()
public void setNoDataErrorText(java.lang.String text)
public CommonSparkChart.Type getType()
CommonSparkChart.Type
public void setType(CommonSparkChart.Type type)
CommonSparkChart.Type
public ReferenceArea createReferenceArea()
ReferenceArea
. Use reference areas to denote special ranges of values.ReferenceArea
instance used to denote important ranges of valuespublic ReferenceLine createReferenceLine()
ReferenceLine
. Use reference areas to denote an important axis value.ReferenceLine
instance used to denote an important axis valuepublic void destroyReferenceObjects()
public java.util.List<ReferenceObject> getReferenceObjects()
public Threshold getThreshold()
Threshold
instance used for customizing thresholds for this spark chart.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |