com.googlecode.gchart.client
Class GChart.Symbol

java.lang.Object
  com.googlecode.gchart.client.GChart.Symbol

Enclosing class:

GChart

public class GChart.Symbol
extends java.lang.Object

Defines a chart curve symbol. Each point on a curve is represented on the chart by an appropriate rendering of the curve's symbol.

See Also:

Curve.getSymbol, SymbolType

Method Summary

java.lang.String	getBackgroundColor() Returns the CSS background color of all the rectangular elements used in rendering the symbol.
double	getBaseline() Returns the baseline value for this symbol, previously specified via setBaseline
java.lang.String	getBorderColor() Returns the CSS border color of all the rectangular elements used in rendering the symbol.
java.lang.String	getBorderStyle() Returns the border style of all of the rectangular elements from which this symbol is built.
int	getBorderWidth() Returns the width of the border around each rectangular element used to render this symbol, in pixels.
int	getBrushHeight() Returns the height of the rectangular "brush" that defines how close the mouse cursor must be to a rendered symbol for the symbol to be considered to have been "touched" (which causes the point's hover feedback to pop up).
GChart.AnnotationLocation	getBrushLocation() Returns the location of the rectangular brush relative to the current x,y coordinates of the mouse cursor.
int	getBrushWidth() Returns the width of the rectangular "brush" that defines how close the mouse cursor must be to a rendered symbol for the symbol to be considered to have been "touched" (which causes the point's hover feedback to pop up).
boolean	getFillHasHovertext() Deprecated. Returns the value previously set by setFillHasHovertext.
double	getFillSpacing() Returns the spacing between successive rectangular elements used to emulate any required non-rectangular features of the symbol.
int	getFillThickness() Returns the "thickness" of rectangular elements used to emulate any required non-rectangular features of the symbol.
int	getHeight() Returns this symbol's height, as previously set by setHeight.
boolean	getHoverAnnotationEnabled() Retrieves a boolean that indicates if point-specific annotations popup whenever you hover over a point on the curve associated with this symbol.
GChart.SymbolType	getHoverAnnotationSymbolType() Retrieves the symbol type that will determine how the hover annotations for this symbol gets positioned.
java.lang.String	getHoverFontColor() Retrieves the font color of this symbol's hover annotations.
int	getHoverFontSize() Retrieves the CSS font size used with this symbol's hover annotations, in pixels.
java.lang.String	getHoverFontStyle() Retrieves the CSS font-style used with this symbol's hover annotations.
java.lang.String	getHoverFontWeight() Retrieves the weight of the font that will be used with this symbol's hover annotations.
GChart.AnnotationLocation	getHoverLocation() Retrieves point-relative location of this symbol's hover annotations.
java.lang.String	getHoverSelectionBackgroundColor() Retrieves the background color used to indicate that the mouse is "touching" (hovering over) a point.
java.lang.String	getHoverSelectionBorderColor() Retrieves the border color used to indicate that the mouse is "touching" (hovering over) a point.
java.lang.String	getHoverSelectionBorderStyle() Retrieves the border style used to indicate that the mouse is "touching" (hovering over) a point.
int	getHoverSelectionBorderWidth() Retrieves the width of the border around the perimeter of rectangles used to indicate that the mouse is "touching" (hovering over) a point.
boolean	getHoverSelectionEnabled() Retrieves a boolean that indicates if hover selection feedback will be provided for this curve.
double	getHoverSelectionFillSpacing() Returns the fill spacing that will be used when rendering this curve's hover selection feedback.
int	getHoverSelectionFillThickness() Returns the fill thickness that will be used when rendering this curve's hover selection feedback.
int	getHoverSelectionHeight() Returns the height of the symbol used to indicate when a given point is being "hovered over" with the mouse.
java.lang.String	getHoverSelectionImageURL() Returns the URL that will be used for all of the images used in rendering this symbol's selection feedback.
GChart.SymbolType	getHoverSelectionSymbolType() Returns the symbol type that GChart will use when generating selection feedback.
int	getHoverSelectionWidth() Returns the width of the symbol used to indicate when a given point is being "hovered over" with the mouse.
java.lang.String	getHovertextTemplate() Returns the hovertextTemplate of this symbol.
HoverUpdateable	getHoverWidget() When widget-based hover annotations are being used by the curve associated with this symbol, this method returns the HoverUpdateable widget used within those annotations.
int	getHoverXShift() Retrieves the number of pixels (along the x-axis) that this point's hover-annotation will be moved from its default, setHoverLocation-defined, point-relative location.
int	getHoverYShift() Retrieves the number of pixels (along the y-axis) that this point's hover annotation will be moved from its default, setHoverLocation-defined, point-relative location.
java.lang.String	getImageURL() Returns the URL that will be used for all of the images used in rendering this symbol.
double	getModelHeight() Returns this symbol's height as previously set by setModelHeight.
double	getModelWidth() Returns this symbol's width as previously set by setModelWidth.
GChart.Curve	getParent() Returns the Curve that contains this Symbol.
double	getPieSliceOrientation() Returns the value, previously specified via setPieSliceOrientation, that defines the angular orientation of any pie slices associated with this symbol.
double	getPieSliceSize() Returns the value, previously specified via setPieSliceSize, that defines the size of the angle subtended by any pie slice associated with this symbol.
GChart.SymbolType	getSymbolType() Returns this symbol's type.
int	getWidth() Returns this symbol's width as previously set by setWidth.
void	setBackgroundColor(java.lang.String backgroundColor) Specifies the background or fill color of this symbol.
void	setBaseline(double baseline) Specifies the baseline value for this symbol.
void	setBorderColor(java.lang.String borderColor) Specifies the border color, as a CSS or RGBA color specification string.
void	setBorderStyle(java.lang.String borderStyle) Sets the border style of the rectangular elements used to render this symbol.
void	setBorderWidth(int borderWidth) Sets the width of the border around the graphical element(s) used to render this curve, in pixels.
void	setBrushHeight(int height) Sets the height of the rectangular point-selection "brush".
void	setBrushLocation(GChart.AnnotationLocation location) Sets the location of the brush relative to the mouse x,y coordinates.
void	setBrushSize(int width, int height) Convenience method equivalent to:
void	setBrushWidth(int width) Sets the width of the rectangular "brush" that defines how close the mouse position must be to a rendered symbol for that symbol to have been "touched".
void	setDistanceMetric(double xScaleFactor, double yScaleFactor) Allows you to change the x,y scale factors that define the distance between the mouse cursor and each rendered point; these distances determine which point is "closest" to the mouse during hit testing.
void	setFillHasHovertext(boolean fillHasHovertext) Deprecated. As of GChart 2.4, hover feedback has been completely redesigned. Though these changes are mostly positive, one downside is that, to simplify its hit-testing algorithms, GChart only provides hover feedback for the explicitly specified data points on a line chart; it can no longer provide feedback for the "filled in" points connecting successive data points. If you need hover feedback on such interpolated points you will have to explicitly add individual data points to the curve representing the interpolated values. Another difference is that you can no longer turn off hover feedback for a pie slice via this method. If you need to turn hover feedback off for a pie slice (or for any other symbol, for that matter) you can use the (new with 2.4) setHoverAnnotationEnabled and setHoverSelectionEnabled methods.
void	setFillSpacing(double fillSpacing) Specifies the spacing between successive rectangular elements used to render any required non-rectangular features of the symbol.
void	setFillThickness(int fillThickness) Sets the "thickness" of the rectangular elements used to render any required non-rectangular features of this symbol.
void	setHeight(int height) Sets the height of this symbol (including any specified border) in pixels.
void	setHoverAnnotationEnabled(boolean hoverAnnotationEnabled) Sets a boolean that determines if point-specific annotations will popup whenever you hover over a point on the curve associated with this symbol.
void	setHoverAnnotationSymbolType(GChart.SymbolType hoverAnnotationSymbolType) Sets the symbol type that GChart will use when positioning hover annotations.
void	setHoverFontColor(java.lang.String cssColor) Specifies the color of the hover annotations' font.
void	setHoverFontSize(int fontSize) Specifies the CSS font size used in this symbol's hover annotations, in pixels.
void	setHoverFontStyle(java.lang.String cssStyle) Specifies the CSS font-style used by this symbol's hover annotations.
void	setHoverFontWeight(java.lang.String cssWeight) Specifies the weight of the font that will be used to render the text of this point's hover annotations.
void	setHoverLocation(GChart.AnnotationLocation hoverLocation) Specifies the location of this point's hover annotations.
void	setHoverSelectionBackgroundColor(java.lang.String hoverSelectionBackgroundColor) Specifies the background color used to indicate that the mouse is "touching" (hovering over) a point.
void	setHoverSelectionBorderColor(java.lang.String hoverSelectionBorderColor) Specifies the border color used to indicate that the mouse is "touching" (hovering over) a point.
void	setHoverSelectionBorderStyle(java.lang.String hoverSelectionBorderStyle) Specifies the border style used to indicate that the mouse is "touching" (hovering over) a point.
void	setHoverSelectionBorderWidth(int borderWidth) Sets the width of the border around the perimeter of rectangles used to indicate that the mouse is "touching" (hovering over) a point.
void	setHoverSelectionEnabled(boolean hoverSelectionEnabled) Specifies if hover selection feedback will be provided for this curve.
void	setHoverSelectionFillSpacing(double selectionFillSpacing) Specifies the fill spacing that will be used when rendering this curve's hover selection feedback.
void	setHoverSelectionFillThickness(int selectionFillThickness) Specifies the fill thickness that will be used when rendering this curve's hover selection feedback.
void	setHoverSelectionHeight(int selectionHeight) Sets the height of the symbol used to indicate when a given point is being "hovered over" with the mouse.
void	setHoverSelectionImageURL(java.lang.String imageURL) Specifies the URL that will define the image used to render selection feedback for points on the curve associated with this symbol.
void	setHoverSelectionSymbolType(GChart.SymbolType hoverSelectionSymbolType) Sets the symbol type that GChart will use when generating selection feedback.
void	setHoverSelectionWidth(int selectionWidth) Sets the width of the symbol used to indicate when a given point is being "hovered over" with the mouse.
void	setHovertextTemplate(java.lang.String hovertextTemplate) Defines the "hover-text" that appears whenever the user points their mouse at a point on the curve.
void	setHoverWidget(HoverUpdateable annotationWidget) Specifies a HoverUpdateable widget that will be used to display all hover annotations associated with this symbol.
void	setHoverWidget(HoverUpdateable hoverWidget, int widthUpperBound, int heightUpperBound) Specifies a HoverUpdateable widget that will be used to display the hover annotations associated with this symbol.
void	setHoverXShift(int xShift) Specifies the number of pixels (along the x-axis) to move this symbol's hover annotations from their default, AnnotationLocation-defined, point-relative locations.
void	setHoverYShift(int yShift) Specifies the number of pixels (along the y-axis) to move this symbol's hover annotations from their default, AnnotationLocation-defined, point-relative locations.
void	setImageURL(java.lang.String imageURL) Specifies the URL that will define the image used to represent the points on this curve.
void	setModelHeight(double modelHeight) Sets the height of this symbol (including any specified border) in model units (arbitrary, user-defined, units).
void	setModelWidth(double modelWidth) Sets the width of this symbol (including any specified border) in model units.
void	setPieSliceOrientation(double pieSliceOrientation) Specifies a value that defines the angular orientation of the first edge of the pie slice associated with this symbol.
void	setPieSliceSize(double pieSliceSize) Specifies a value that defines the angular size of any pie slice associated with this symbol.
void	setSymbolType(GChart.SymbolType symbolType) Sets the type of this symbol.
void	setWidth(int width) Sets the width of this symbol (including any specified border) in pixels.

Methods inherited from class java.lang.Object

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

Method Detail

getBackgroundColor

public java.lang.String getBackgroundColor()

Returns the CSS background color of all the rectangular elements used in rendering the symbol.

Returns:

the CSS background color used to fill in the central (non-border) part of each rectangular element used to render a curve's symbol.

See Also:

setBackgroundColor

getBaseline

public double getBaseline()

Returns the baseline value for this symbol, previously specified via setBaseline

Returns:

the previously specified baseline value for this symbol.

See Also:

setBaseline

getBorderColor

public java.lang.String getBorderColor()

Returns the CSS border color of all the rectangular elements used in rendering the symbol.

Returns:

the color of the border of the rectangular elements used to render the symbol, in standard CSS format

See Also:

setBorderColor

getBorderStyle

public java.lang.String getBorderStyle()

Returns the border style of all of the rectangular elements from which this symbol is built.

Returns:

the CSS borderStyle of this symbol's elements (dotted, dashed, solid, etc. )

See Also:

setBorderStyle

getBorderWidth

public int getBorderWidth()

Returns the width of the border around each rectangular element used to render this symbol, in pixels.

Returns:

the previously set border width (in pixels).

See Also:

setBorderWidth

getBrushHeight

public int getBrushHeight()

Returns the height of the rectangular "brush" that defines how close the mouse cursor must be to a rendered symbol for the symbol to be considered to have been "touched" (which causes the point's hover feedback to pop up).

Returns:

the height of the "brush", in pixels, associated with this symbol/curve.

See Also:

setBrushHeight

getBrushLocation

public GChart.AnnotationLocation getBrushLocation()

Returns the location of the rectangular brush relative to the current x,y coordinates of the mouse cursor.

Returns:

the location of the rectangular brush relative to the x,y coordinates of the mouse cursor.

See Also:

setBrushLocation

getBrushWidth

public int getBrushWidth()

Returns the width of the rectangular "brush" that defines how close the mouse cursor must be to a rendered symbol for the symbol to be considered to have been "touched" (which causes the point's hover feedback to pop up).

Returns:

the width of the "brush", in pixels, associated with this symbol/curve.

See Also:

setBrushWidth

getFillHasHovertext

public boolean getFillHasHovertext()

Deprecated. Returns the value previously set by setFillHasHovertext.

See Also:

setFillHasHovertext

getFillSpacing

public double getFillSpacing()

Returns the spacing between successive rectangular elements used to emulate any required non-rectangular features of the symbol.

Returns:

the previously set (or the default, if the fillSpacing has been set to Double.NaN) fill spacing (in pixels).

See Also:

setFillSpacing, setFillThickness

getFillThickness

public int getFillThickness()

Returns the "thickness" of rectangular elements used to emulate any required non-rectangular features of the symbol.

Returns:

the previously set (or the default, if the fillThickness has been set to GChart.NAI) fill thickness (in pixels).

See Also:

setFillThickness, setFillSpacing

getHoverAnnotationEnabled

public boolean getHoverAnnotationEnabled()

Retrieves a boolean that indicates if point-specific annotations popup whenever you hover over a point on the curve associated with this symbol.

Returns:

true if hover-induced annotations popup, false otherwise.

See Also:

setHoverAnnotationEnabled

getHoverFontWeight

public java.lang.String getHoverFontWeight()

Retrieves the weight of the font that will be used with this symbol's hover annotations.

Returns:

the standard CSS font-weight specification such as normal, bold, bolder, lighter, 100, 200, ... 900, or inherit used by hover annotations

See Also:

setHoverFontWeight

getHoverFontColor

public java.lang.String getHoverFontColor()

Retrieves the font color of this symbol's hover annotations.

Returns:

color of the font used to display this symbol's hover annotations

See Also:

setHoverFontColor

getHoverFontStyle

public java.lang.String getHoverFontStyle()

Retrieves the CSS font-style used with this symbol's hover annotations.

Returns:

the CSS font-style, namely, normal, italic, oblique, or inherit of text displayed in the hover annotations associated with this symbol

See Also:

setHoverFontStyle

getHoverFontSize

public int getHoverFontSize()

Retrieves the CSS font size used with this symbol's hover annotations, in pixels.

Returns:

the font size used in the text displayed in the hover annotations associated with this symbol.

See Also:

setHoverFontSize

getHoverLocation

public GChart.AnnotationLocation getHoverLocation()

Retrieves point-relative location of this symbol's hover annotations.

Returns:

the relative location of the hover annotations for all points on the curve associated with this symbol.

See Also:

setHoverLocation, DEFAULT_HOVER_LOCATION

getHoverAnnotationSymbolType

public GChart.SymbolType getHoverAnnotationSymbolType()

Retrieves the symbol type that will determine how the hover annotations for this symbol gets positioned.

Returns:

SymbolType used to position hover annotations, or null if the symbol type of the hovered over point is being used.

See Also:

setHoverAnnotationSymbolType

getHoverSelectionBackgroundColor

public java.lang.String getHoverSelectionBackgroundColor()

Retrieves the background color used to indicate that the mouse is "touching" (hovering over) a point.

Returns:

a CSS color specification string that represents the background color used to indicate "hover-selection".

See Also:

setHoverSelectionBackgroundColor

getHoverSelectionBorderColor

public java.lang.String getHoverSelectionBorderColor()

Retrieves the border color used to indicate that the mouse is "touching" (hovering over) a point.

Returns:

a CSS color specification string that represents the border color used to indicate "hover-selection".

See Also:

setHoverSelectionBorderColor

getHoverSelectionBorderStyle

public java.lang.String getHoverSelectionBorderStyle()

Retrieves the border style used to indicate that the mouse is "touching" (hovering over) a point.

Returns:

a CSS border style specification string that represents the border style used to indicate "hover-selection".

See Also:

setHoverSelectionBorderStyle

getHoverSelectionBorderWidth

public int getHoverSelectionBorderWidth()

Retrieves the width of the border around the perimeter of rectangles used to indicate that the mouse is "touching" (hovering over) a point.

Returns:

the width of the border drawn around the perimeter of the selected symbol's rectangles to indicate that it has been "touched: by the mouse.

See Also:

setHoverSelectionBorderWidth

getHoverSelectionEnabled

public boolean getHoverSelectionEnabled()

Retrieves a boolean that indicates if hover selection feedback will be provided for this curve.

Returns:

if true, hover selection feedback is enabled, if false, hovering over a point does not change its color.

See Also:

setHoverSelectionEnabled

getHoverSelectionFillSpacing

public double getHoverSelectionFillSpacing()

Returns the fill spacing that will be used when rendering this curve's hover selection feedback.

Returns:

fill spacing used by hover selection feedback, or GChart.NAI if the fill spacing setting of the hovered-over curve is to be used.

See Also:

setHoverSelectionFillSpacing

getHoverSelectionFillThickness

public int getHoverSelectionFillThickness()

Returns the fill thickness that will be used when rendering this curve's hover selection feedback.

Returns:

fill thickness used by hover selection feedback, or GChart.NAI if the fill thickness setting of the hovered-over curve is to be used.

See Also:

setHoverSelectionFillThickness

getHoverSelectionHeight

public int getHoverSelectionHeight()

Returns the height of the symbol used to indicate when a given point is being "hovered over" with the mouse.

Returns:

the height of the symbol used to indicate that that a point has been selected, or GChart.NAI if the the height of the symbol representing the selected point is being used.

See Also:

setHoverSelectionHeight

getHoverSelectionImageURL

public java.lang.String getHoverSelectionImageURL()

Returns the URL that will be used for all of the images used in rendering this symbol's selection feedback.

Returns:

the url that defines the src property of all images used to draw this the selection feedback associated with this symbol.

See Also:

setHoverSelectionImageURL(java.lang.String)

getHoverSelectionSymbolType

public GChart.SymbolType getHoverSelectionSymbolType()

Returns the symbol type that GChart will use when generating selection feedback. GChart indicates that a point is selected by re-rendering the point as if it had this symbol type.

Returns:

the symbol type that in part determines how selection feedback for a hovered over point is drawn, or null if defaulting to the symbol type of the hovered over point.

See Also:

setHoverSelectionSymbolType

getHoverSelectionWidth

public int getHoverSelectionWidth()

Returns the width of the symbol used to indicate when a given point is being "hovered over" with the mouse.

Returns:

the width of the symbol used to indicate that that a point has been selected, or GChart.NAI if using to the width of the symbol representing the selected point.

See Also:

setHoverSelectionWidth

getHovertextTemplate

public java.lang.String getHovertextTemplate()

Returns the hovertextTemplate of this symbol.

Returns:

hovertextTemplate of the symbol

See Also:

setHovertextTemplate

getHoverWidget

public HoverUpdateable getHoverWidget()

When widget-based hover annotations are being used by the curve associated with this symbol, this method returns the HoverUpdateable widget used within those annotations. When simple text or HTML hover annotations are being used, it returns null.

Returns:

the widget used to provide widget-based hover annotations or null if hover annotations are not widget-based.

See Also:

setHoverWidget

getHoverXShift

public int getHoverXShift()

Retrieves the number of pixels (along the x-axis) that this point's hover-annotation will be moved from its default, setHoverLocation-defined, point-relative location.

Returns:

x-shift, in pixels, of the hover annotation

See Also:

getHoverXShift

getHoverYShift

public int getHoverYShift()

Retrieves the number of pixels (along the y-axis) that this point's hover annotation will be moved from its default, setHoverLocation-defined, point-relative location.

Returns:

y-shift, in pixels, of the hover annotation

See Also:

setHoverYShift

getImageURL

public java.lang.String getImageURL()

Returns the URL that will be used for all of the images used in rendering this symbol.

Returns:

the url that defines the src property of all images used to draw this symbol on the chart.

See Also:

setImageURL, setBlankImageURL

getParent

public GChart.Curve getParent()

Returns the Curve that contains this Symbol.

Returns:

a reference to the Curve that contains this Symbol (its "parent")

getPieSliceOrientation

public double getPieSliceOrientation()

Returns the value, previously specified via setPieSliceOrientation, that defines the angular orientation of any pie slices associated with this symbol.

Returns:

the value, either Double.NaN or a value between 0 and 1 previously set via setPieSliceOrientation, that determines the angular orientation of any pie slice associated with this symbol.

See Also:

setPieSliceOrientation, setPieSliceSize

getPieSliceSize

public double getPieSliceSize()

Returns the value, previously specified via setPieSliceSize, that defines the size of the angle subtended by any pie slice associated with this symbol.

Returns:

the value, between 0 and 1 and previously set via setPieSliceSize, that defines the size of the "wedge of pie" as a fraction of the total pie, for any pie slice associated with this symbol.

See Also:

setPieSliceOrientation, setPieSliceSize

getHeight

public int getHeight()

Returns this symbol's height, as previously set by setHeight.

Returns:

the previously set symbol height, in pixels.

See Also:

setHeight

getModelHeight

public double getModelHeight()

Returns this symbol's height as previously set by setModelHeight.

Returns:

the previously set symbol height, in model units

See Also:

setModelHeight, setWidth, setHeight, setWidth

getModelWidth

public double getModelWidth()

Returns this symbol's width as previously set by setModelWidth.

Returns:

the previously set symbol width, in model units.

See Also:

setModelWidth, setModelHeight, setWidth, setHeight

getSymbolType

public GChart.SymbolType getSymbolType()

Returns this symbol's type.

Returns:

the type of this symbol.

See Also:

setSymbolType

getWidth

public int getWidth()

Returns this symbol's width as previously set by setWidth.

Warning: This method won't return the correct pixel width associated with a setModelWidth setting, as you might have expected. It only returns the pixel width you last explicitly specified via setWidth.

Returns:

the previously set symbol width, in pixels

See Also:

setWidth, setModelWidth

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

Specifies the background or fill color of this symbol.

For example, this would define the color of the interior, non-border, part of bars in a bar-chart, the color of the interior of each shading bar in a banded-fill pie slice, or the canvas "fill" color of solid fill, canvas-rendered, pie slices.

You can use one of the 16 standard HTML/CSS color literals, illustrated below, to quickly specify common colors:

For more variety, use a standard CSS RGB (red, green, and blue) color format such as "#FF0000" (same as "red"), "#00FF00" (same as "green"), "#0000FF" (same as "blue"), "#FFFFFF" (same as "white") or "#000000" (same as "black").

If you are using an external canvas library that supports them, feel free to use RGBA color specifications (e.g, rgba(255,255,255,0.5)) for semi-transparent white). GChart will automatically collapse these specifications down to CSS standard RGB (e.g. rgb(255,255,255)) as needed for any non-canvas-rendered parts of the curve.

To maintain GWTCanvas consistency, GChart requires that you use integers in the range 0..255 in the first three comma delimited RGBA slots, and a double in the range 0..1 in the fourth. An runtime exception will be raised if you use any other format.

Why GChart sometimes deliberately drops your alpha-transparency specs (and how to workaround this limitation):

The external GWTCanvas vector graphics library lets you use the RGBA format, which adds a fourth, alpha parameter in addition to the standard red, green and blue. This alpha lets you define the degree of transparency: from 0 (transparent) to 1 (opaque).

Problem is, if you use this rgba(r,g,b,a) syntax to specify, say, the color of an HTML element's border, IE won't display anything but an error. So, whenever GChart uses an HTML element to render a symbol's background or border (instead of your external vector graphics library) it collapses the RGBA into the more widely accepted RGB format, by dropping the fourth, alpha, parameter and changing the leading rgba identifier to rgb.

GChart will render any "continuously filled" (you can use setFillSpacing(0) to request continuous filling) aspects of your symbols using whatever external vector graphics library you specified via setCanvasFactory. So, you can rely on the full RGBA syntax working for these aspects of your curve, provided that, like GWTCanvas, your external graphics library supports the rgba(r,g,b,a) syntax. Specifically, solid fill pie slices and their borders, solid fill area charts and their borders, and solid point-to-point connecting lines on a line chart all support RGBA-specified alpha-transparency.

On the other hand, due to a limitation of GChart's implementation, any rectangular aspects of your symbols, namely bar chart symbols and their borders, rectangular point markers and their borders, and banded-filled pie slices, are rendered via HTML and will collapse your rgba(r,g,b,a) specs into rgb(r,g,b).

But what if you need a semi-transparent bar chart, banded-fill pie slice, or rectangular point marker? Fortunately, there is a simple workaround: just pass the URL of an appropriately-sized semi-transparent image to the setImageURL method of the curve in question.

The default symbol background color is DEFAULT_SYMBOL_BACKGROUND_COLOR

Parameters:

backgroundColor - a standard CSS or canvas-library supported RGBA background color specification string.

See Also:

getBackgroundColor, setBorderColor, DEFAULT_SYMBOL_BACKGROUND_COLOR, setImageURL

setBaseline

public void setBaseline(double baseline)

Specifies the baseline value for this symbol. Use a baseline value when you need to create bar charts whose bars extend up/down to a specified y baseline value (for vertical bar charts) or left/right to a specified x baseline value (for horizontal bar charts).

In greater detail:

• For curves that employ symbol types with names of the form VBAR_BASELINE_*, a vertical bar is drawn that connects the x,y position of each data point to the horizontal line defined by the equation y=baseline. For the default baseline setting of Double.NaN, the defining equation is y=(yMin+yMax)/2 (i.e., a midpoint baseline).

• For curves that employ symbol types with names of the form HBAR_BASELINE_*, a horizontal bar is drawn from the x,y position associated with each data point to the vertical line defined by the equation x=baseline. For the default baseline setting of Double.NaN, the defining equation is x=(xMin+xMax)/2.

Parameters:

baseline - the y (or x) that defines the horizontal (or vertical) line to which any baseline-based vertical (or horizontal) bars are extended.

See Also:

getBaseline, HBAR_BASELINE_CENTER, HBAR_BASELINE_SOUTH, HBAR_BASELINE_NORTH, VBAR_BASELINE_CENTER, VBAR_BASELINE_EAST, VBAR_BASELINE_WEST

setBorderColor

public void setBorderColor(java.lang.String borderColor)

Specifies the border color, as a CSS or RGBA color specification string.

Both standard CSS and the all-but-IE-supported RGBA extension (with the fourth paramter defining alpha-transparency, for example, rgba(255,255,255,0.5) to define a semi-transparent white) are allowed. However, GChart may collapse these extended specifications into ordinary RGB in some cases. See setBackgroundColor for full details.

For example, for a square symbol, this would set the color of the line that indicates the outter perimeter of that square. For a banded-fill pie slice, this would set the color of the outter perimeter of every shading bar used to fill in the pie slice. For a solid fill pie slice, with an external canvas library such as GWTCanvas plugged into GChart via setCanvasFactory, this method would instead set the color of the canvas-stroked line around the slice's perimeter.

This color also defines the color of the point-to-point connecting lines of a continuously connected line chart.

Using TRANSPARENT_BORDER_COLOR:

Although you can use the special CSS keyword "transparent", due to a well-known bug, IE6 will usually render that as black. Plus, different browsers define the background color that shines through the transparent border differently, and external canvas libraries such as GWTCanvas may not support the use of "transparent". So, GChart provides a browser-independent keyword TRANSPARENT_BORDER_COLOR that you can use instead, that emulates transparency by removing the border entirely, and then shifting and resizing the transparently bordered element so as to create the illusion that its transparent border is still there. That's not exactly the same thing as having a transparent border (the emulated borders can't "see" mouse moves over them, for example) but it's close enough for most charting purposes. Another simple way to workaround these transparent border inconsistencies is to use an explicitly specified border color equal to the chart's background color.

Parameters:

borderColor - the color of the borders of this curve's rendered symbols, and of any point-to-point connecting lines. Use any valid CSS color specification string (including the RGBA extension), or the special GChart keyword TRANSPARENT_BORDER_COLOR. For more information on standard CSS color specifications including how GChart handles the RGBA extended format, see setBackgroundColor.

See Also:

TRANSPARENT_BORDER_COLOR, getBorderColor, setBackgroundColor, setCanvasFactory

setBorderStyle

public void setBorderStyle(java.lang.String borderStyle)

Sets the border style of the rectangular elements used to render this symbol.

Parameters:

borderStyle - a CSS border style such as "solid", "dotted", "dashed", etc.

See Also:

getBorderStyle, setBackgroundColor, setBorderColor

setBorderWidth

public void setBorderWidth(int borderWidth)

Sets the width of the border around the graphical element(s) used to render this curve, in pixels.

If positive, the border is drawn inside each graphical element. If negative, the border is drawn outside of those elements. Note that, negative, external, borders do not increase the mouse hit-testing region associated with the rendered symbols.

Tip: To get the hit test region around a symbol to, in effect, include the external border associated with a negative border width, simply increase the width and the height of the symbol's point selection brush by 2*Math.abs(getBorderWidth()).

If a rectangular symbol's width or height ever become less than twice the specified positive border width, the border will be shrunk down until it just fills up the entire rectangular area of the symbol.

On backgrounds vs borders in bar charts when printing

Because borders are usually printed more reliably than background colors cross-browser, using such oversized borders is a simple way to assure that on-screen and printed bar chart renderings are consistent. Consistency isn't everything: the removal of background colors can save ink. So, you might prefer to just design bar charts that look good with either solid-filled (on-screen) or outlined (printed w. 'print background colors' unchecked in FF, for example) bars.

Parameters:

borderWidth - the width of the symbol's border, in pixels

See Also:

getBorderWidth

setBrushHeight

public void setBrushHeight(int height)

Sets the height of the rectangular point-selection "brush". This brush defines how close the mouse must get to a point on the chart in order to "touch" it.

Whenever a point is touched, GChart displays that point's hover feedback. By default, the selected point is highlighted, the associated symbol's hovertext template is expanded relative to the touched point, and the resulting plain text or HTML is placed onto the chart at an appropriate, point-relative, location. You can override this default by passing a HoverUpdateable Widget to the the setHoverWidget method. In that case, instead of expanding your hovertext template, the HoverUpdateable Widget is instead positioned properly relative to the touched point, and its hoverUpdate method is invoked with a reference to the touched point passed in as its first argument.

The rules for determining if the brush is "touching" a symbol are as follows:

1. For all symbols except pie slices, the symbol is considered to have been touched if the rectangle containing the rendered symbol, and a rectangle with the specified brush width and height, and centered on the current mouse position, intersect.

   Note: The brush is centered on the mouse by default. You can place the brush above, below, etc. the mouse position via the setBrushLocation method.

   For example, with a 10 x 10 pixel brush, a bar chart's bar gets "touched" whenever the mouse is either within, or within a 5 pixel border around, the bar. Note that on line charts, only the individual (rectangular) point markers, not connecting lines between them, are touchable.

2. For pie slices, the slice is considered to have been touched if the mouse cursor is within the angle subtended by the slice, and within sliceRadius + max(brushWidth, brushHeight)/2.0 of the center of the pie containing the slice. Intuitively, the brush in effect aligns its longest dimension, compass-like, so that it points to the center of the pie containing the slice.

   Note: Unlike other symbol types, pie slice hit testing works the same regardless of the brush location (c.f. setBrushLocation) setting.

Even though each curve's symbol can have an independently sized brush--which gives you a lot of control over which curve's points are easiest to select--using the same sized brush for all curves produces results more consistent with the simple concept of a single physical brush "touching" symbols on the chart.

Finally, if the brush touches more than one symbol, the symbol whose center is closest to the mouse cursor (by default, that's also the brush center point) is considered to have been touched. (In these calculations, the ordinary, Euclidean, definition of distance is used by default; the setDistanceMetric method allows for other definitions). For pie slices, the symbol's center point is defined (to simplify the calculations) as the point at the center of the pie that contains the slice. In case of any remaining ties, the point later on the point list (the one "on top") is selected.

Fine-print: Known brush size limitations when selecting off-chart points:

GChart allows you to render points that fall outside of the GChart's containing rectangle.

But, GChart can't see mouse moves around such off-chart elements--the mouse has to be right on top of these elements before it's motion is detected by GChart (the browser sends mouse moves in these regions to whatever non-GChart related browser elements occupy this space).

Consequently, even though GChart still uses your brush settings for hit testing with such points, because it can't see mouse activity until the center of the mouse "touches" such elements, it will often act as if you were using a 1x1 pixel brush for such externally rendered points.

Unfortunately, this is a basic limitation of how GChart handles mouse events. But there are a number of possible workarounds, such as adding a transparent curve with similar, but larger, dimensions/point locations to the off-chart curve's points (so as to capture external mouse moves around external points) or adding a transparent annotation around external points (again, to create a mouse capture region around these points). Perhaps the easiest approach is to simply make the outter decoration regions around the chart big enough (via methods such as setAxisLabelThickness and similarly named set*Thickness methods) so that there is enough empty space around the plot area's perimeter so that points never fall outside the chart's bounding rectangle.

Because most applications place their points on the chart, this is only an issue for advanced applications that deliberately draw outside of the chart's rectangle so as to overlay the chart onto the host page.

Parameters:

height - the height of the rectangular point selection brush used by points on the curve associated with this symbol (in pixels).

See Also:

getBrushHeight, setBrushWidth, setBrushSize, setBrushLocation, setDistanceMetric, setHoverWidget, HoverUpdateable, DEFAULT_BRUSH_WIDTH, DEFAULT_BRUSH_HEIGHT, getTouchedPoint, touch, setHoverTouchingEnabled

setBrushLocation

public void setBrushLocation(GChart.AnnotationLocation location)

Sets the location of the brush relative to the mouse x,y coordinates.

With the default setting of AnnotationLocation.CENTER, the brush is centered on the mouse cursor, which is usually acceptable.

The most useful non-default settings, which facilitate "single sided" point selection, are tabulated below:

Location	Impact on point selection
AnnotationLocation.NORTH	The mouse only selects points when it is on or below them.
AnnotationLocation.SOUTH	The mouse only selects points when it is on or above them.
AnnotationLocation.WEST	The mouse only selects points when it is on them or to their right.
AnnotationLocation.EAST	The mouse only selects points when it is on them or to their left.

Tip: When a chart has two curves, setting one curve to use NORTH as its brush location, and the other to use SOUTH, and using a brush height equal to the height of the decorated chart (returned via getYChartSizeDecorated()) allows points on one curve to be selected when the user is near the top of the chart, and points on the other curve to be selected when the user is near the bottom of the chart.

Parameters:

location - the location of the rectangular brush, relative to the x,y position of the mouse.

See Also:

setBrushHeight, setBrushWidth, getYChartSizeDecorated

setBrushSize

public void setBrushSize(int width,
                         int height)

Convenience method equivalent to:

   setBrushWidth(width);
   setBrushHeight(height);
 

For a full discussion of how GChart uses it's "brush" to determine when hover feedback for a point gets displayed, see setBrushHeight.

Parameters:

width - the width of this chart's brush, in pixels

height - the height of this chart's brush, in pixels

See Also:

setBrushHeight, setBrushWidth, DEFAULT_BRUSH_WIDTH, DEFAULT_BRUSH_HEIGHT

setBrushWidth

public void setBrushWidth(int width)

Sets the width of the rectangular "brush" that defines how close the mouse position must be to a rendered symbol for that symbol to have been "touched".

For a full discussion of how GChart uses it's "brush" to determine when hover feedback for a point gets displayed, see setBrushHeight.

Parameters:

width - width of the point selection brush, in pixels.

See Also:

setBrushHeight, setBrushSize, DEFAULT_BRUSH_WIDTH, DEFAULT_BRUSH_HEIGHT

setDistanceMetric

public void setDistanceMetric(double xScaleFactor,
                              double yScaleFactor)

Allows you to change the x,y scale factors that define the distance between the mouse cursor and each rendered point; these distances determine which point is "closest" to the mouse during hit testing.

Whenever the mouse selection brush "touches" more than one point, the point whose center is closest to the mouse cursor is the one selected. For a point centered at (all coordinates are in pixels) (xCenter, yCenter) the distance to the mouse cursor at (xMouse, yMouse) is given by:

   dx = xScaleFactor*(xCenter-xMouse);
   dy = yScaleFactor*(yCenter-yMouse);
   distance = Math.sqrt(dx*dx + dy*dy); 
 

In the above, (xCenter, yCenter) is the position at the center of the rectangle associated with the rendered point. For pie slices, it is the position at the center of the pie containing the slice.

Tip: Here are the most commonly used x-y scale factors, and how they are typically used:

1. To select points based on the ordinary (Euclidean) distance use xScaleFactor = 1, yScaleFactor = 1 (this is the default).

2. To select points based only on how close the mouse x-coordinate is to the x-coordinate at the point's center (often a good choice for a time series chart) use xScaleFactor=1, yScaleFactor=0

3. To select points based only on how close the mouse y-coordinate is to the y-coordinate at the point's center (a good choice for a horizontally oriented bar chart) use xScaleFactor=0, yScaleFactor=1

4. To ignore the distance to the point, and instead always select, from among those points touching the brush, the point rendered last, use xScaleFactor=0, yScaleFactor=0. This choice guarantees that points that are completely occluded by other points can never get selected. But, because distances are ignored, this choice can lead to points further from the mouse being selected in preference to points closer to the mouse. You can minimize this effect by using a very small brush size.

Warning: Mixed metrics, like mixed metaphors, can be confusing:

Since each curve gets it's own distance metric, it's possible to preferentially select one curve over another by giving it relatively smaller scale factors. This can produce very counter-intuitive selection behaviors (selecting a point that is farther away from the mouse than another point, for example). Generally, it's best to use the same distance metric for all curves except in special cases.

For example, suppose you had a vertical bar chart on curve 0 that was restricted to the top half of your chart, and a horizontal bar chart on curve 1 restricted to the bottom half. Then you might use xScaleFactor=1, yScaleFactor=0 for curve 0 and xScaleFactor=0, yScaleFactor=1 for curve 1. This "mixed metric" would not create confusion, because the user would view the region-specific selection behaviour as sensibly coordinated with the orientation of the bars in each region.

Though using a relatively larger xScaleFactor, yScaleFactor makes a curve's points relatively harder to select during hit testing, to completely ignore a curve's points during hit testing, you need to use setHoverSelectionEnabled(false) and setHoverAnnotationEnabled(false).

Parameters:

xScaleFactor - multiplies the x-pixel distance between the mouse cursor and the point center (see distance formula above).

yScaleFactor - multiplies the y-pixel distance between the mouse cursor and the point center (see distance formula above).

See Also:

setBrushSize, setBrushLocation, setHoverSelectionEnabled, setHoverAnnotationEnabled

setFillHasHovertext

public void setFillHasHovertext(boolean fillHasHovertext)

Deprecated. As of GChart 2.4, hover feedback has been completely redesigned. Though these changes are mostly positive, one downside is that, to simplify its hit-testing algorithms, GChart only provides hover feedback for the explicitly specified data points on a line chart; it can no longer provide feedback for the "filled in" points connecting successive data points. If you need hover feedback on such interpolated points you will have to explicitly add individual data points to the curve representing the interpolated values.

Another difference is that you can no longer turn off hover feedback for a pie slice via this method. If you need to turn hover feedback off for a pie slice (or for any other symbol, for that matter) you can use the (new with 2.4) setHoverAnnotationEnabled and setHoverSelectionEnabled methods.

See Also:

getFillHasHovertext, setHovertextTemplate, setBrushSize, setHoverAnnotationEnabled, setHoverSelectionEnabled

setFillSpacing

public void setFillSpacing(double fillSpacing)

Specifies the spacing between successive rectangular elements used to render any required non-rectangular features of the symbol.

The exact meaning of this spacing setting depends on the symbol type, and on if an external canvas factory has been specified via setCanvasFactory:

SymbolType	How spacing is interpreted	Default value
BOX_*	The distance between the centers of the "dots" used to draw the dotted connecting lines between successive x,y data points on a curve. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a continuous line connecting the centers of successive boxes is produced in exactly the same way as is done for the LINE symbol type. Without a canvas factory (the default) fillSpacing == 0 works the same as fillSpacing == 1.	4
LINE	The horizontal distance between the centers of the successive vertical bars, or the vertical distance between the centers of the successive horizontal bars, that GChart uses to render the point-to-point connecting lines of the LINE symbol type. The defaults (no canvas factory specified, 0px spacing) provide the smoothest lines possible without using canvas, but also the longest chart update times. Spacing values larger than 1px will provide proportionally faster rendering of connecting lines (provided the connecting line segments are significantly longer than the specified spacing), but they give the lines a grainy, "stair-step" look. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a continuous, crisp (sans stair-steps) line connecting the centers of successive boxes is produced--quickly. Without any canvas factory specified, fillSpacing == 0 will work the same as fillSpacing == 1. Tip: To assure an unbroken connecting line, use a non-zero fill thickness setting greater than or equal to your fill spacing setting.	0
PIE_SLICE_*	The vertical or horizontal distance between the centers of the vertical, and/or horizontal, shading bars used to fill in the pie slice. With the default setting, this produces a banded-fill look. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, the pie slices are crisp, quickly-rendered, and solid-filled. Without a canvas factory specified (the default) fillSpacing == 0 works the same as fillSpacing == 1.	4
VBAR_*	The horizontal distance between corresponding edges of the vertical bars used to fill in the trapezoidal areas linearly interpolated between successive vertical bars on a curve. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a filled polygon whose perimeter connects the x,y points of the curve with a corresponding interval on the x-axis, x2-axis, or horizontal baseline is rendered, so as to create a vertical, solid-filled, area chart. Without a canvas factory, fillSpacing == 0 works the same as fillSpacing == 1.	0
HBAR_*	The vertical distance between corresponding edges of the horizontal bars used to fill in the trapezoidal areas linearly interpolated between successive horizontal bars on a curve. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a filled polygon whose perimeter connects the x,y points of the curve with a corresponding interval on the y-axis, y2-axis, or vertical baseline will be rendered, so as to create a horizontal, solid-filled, area chart. Without a canvas factory, fillSpacing == 0 works the same as fillSpacing == 1.	0
XGRIDLINE	The horizontal distance between corresponding edges of the vertical bars used to fill in the trapezoidal areas linearly interpolated between successive x-gridlines on a curve. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a filled polygon is drawn whose perimeter connects the x,y points of the curve with a corresponding interval on either the x-axis or x2-axis, depending on whichever axis is closest to the first point on the curve. Without a canvas factory, fillSpacing == 0 works the same as fillSpacing == 1. Tip: To make a canvas-filled x-gridline curve fill in a rectangular region, set the y of each point to Double.MAX_VALUE.	4
YGRIDLINE	The vertical distance between corresponding edges of the horizontal bars used to fill in the trapezoidal areas linearly interpolated between successive y-gridlines on a curve. If fillSpacing == 0 ("continuously filled"), fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a filled polygon is drawn whose perimeter connects the x,y points of the curve with a corresponding interval on either the y-axis or y2-axis, depending on whichever axis is closest to the first point on the curve. Without a canvas factory, fillSpacing == 0 works the same as fillSpacing == 1. Tip: To make a canvas-filled y-gridline curve fill in a rectangular region, set the x of each point to Double.MAX_VALUE.	4

As of version 2.5 GChart provides support for canvas-based, crisp, quickly drawn, lines, 2-D pie slices, and area charts if a fillSpacing of 0 is specified ("continuously filled") along with a fillThickness > 0. However, you must bolt-on an external canvas library (plain vanilla GWT does not currently come pre-loaded with a browser independent canvas Widget. However, the fact that the GWT incubator project contains one implies that the GWT team is considering adding one). See the setCanvasFactory method for details.

By default, GChart does not use an external canvas library, and thus depends only on the standard GWT distribution and its own 3,000-odd semi-colon terminated lines of GWT Java. If you decide to stick with this default, the following tips may help you workaround GChart's rectangle-element-based limitations when used in this mode.

First, if your goal is to produce a solid connecting line between points always use the LINE symbol type rather than the BOX_CENTER symbol type with a fill spacing of 1px. The LINE symbol type knows how to merge adjacent pixels into larger rectangular elements, and is therefore usually much more efficient, especially with curves that involve many near-vertical or near-horizontal connecting lines. For best performance, use the BOX_CENTER symbol only to produce dotted connecting lines that have widely spaced dots.

In general, since the number of elements required is often inversely proportional to fill spacing, using a very small fill spacing like 1px, while allowed, could degrade performance unacceptably, especially for very large-sized charts. On the other hand, too large a fill spacing/thickness can degrade graphical quality unacceptably (e.g. due to too few "dots" on dotted connecting lines, "stair-step" solid connecting lines, or "grainy filled" pie slices).

Tip: For pie slices as well as for dotted or solid connecting lines, scaling down the size of the chart via setXPixelSize and setYPixelSize can also speed up chart display, and thus will often provide a better-looking alternative to increasing the fill spacing.

In particular, for a typical curve whose x-values always increase with point index (i.e. no "doubling back") LINE symbol type curves often have a number of elements, and thus an update time, that is approximately equal to:

     "Some Constant" * (xMaxInPixels-xMinInPixels)/fillSpacing

   

So, for LINE curves, halving the x-axis range via setXPixelSize will provide approximately the same speedup as doubling the fill spacing setting, and, because the lines will be less "stair-steppy", will often provide a more acceptable visual result.

Experience suggests that many applications will be able to find a combination of chart size and spacing/thickness settings that provide an acceptable level of both graphical quality and performance--particularly if your charting needs are more utilitarian than aesthetic. When that's not good enough, it's time to use setCanvasFactory to super-charge GChart's rendering with the power of a cross-browser vector graphics facility, such as GWTCanvas.

Parameters:

fillSpacing - spacing between successive rectangular elements used to fill in non-rectangular symbols, in pixels. If a canvas factory has been specified, you can use a setting of 0 to produces "continuously filled" elements.

See Also:

getFillSpacing, setFillThickness, setCanvasFactory

setFillThickness

public void setFillThickness(int fillThickness)

Sets the "thickness" of the rectangular elements used to render any required non-rectangular features of this symbol.

The exact meaning of this thickness setting, as well as the default used whenever the thickness is set to the special undefined integer value recognized by GChart (GChart.NAI), depends on the symbol type, and if an external canvas factory has been specified via setCanvasFactory:

SymbolType	How thickness is interpreted	Default value
BOX_*	The height and width of rectangular "dots" used to draw the dotted connecting lines between successive x,y data points on a curve. If the fill spacing (setFillSpacing) is 0 and a canvas factory has been specified via setCanvasFactory, fillThickness is the width of the continuous connecting lines between successive points.	0 (implies no interpolated dots or connecting lines)
LINE	The width of the vertical line segments placed end-to-end to render any "more-nearly-vertical" connecting lines of the curve, and the height of the horizontal line segments placed end-to-end to render any "more-nearly-horizontal" connecting lines on this curve. Note that if you use a fill thickness less than the fill spacing, your line will not be continuously connected. If the fill spacing (setFillSpacing) is 0 and a canvas factory has been specified via setCanvasFactory, fillThickness is the width of the continuous connecting lines drawn between successive points.	1
PIE_SLICE_*	The width of vertical, and/or the height of horizontal, shading bars used to fill in the pie slice If the fill spacing (setFillSpacing) is 0 and a canvas factory has been specified via setCanvasFactory, pie slices are solidly and continously filled for any fillThickness > 0.	2
VBAR_*	The width of vertical bars used to fill in the trapezoidal areas linearly interpolated between successive vertical bars on a curve. If the fill spacing (setFillSpacing) is 0 and a canvas factory has been specified via setCanvasFactory, these trapezoidal areas are merged together and solidly and continously filled for any fillThickness > 0.	0 (implies no "area filling" between bars)
HBAR_*	The height of horizontal bars used to fill in the trapezoidal areas linearly interpolated between successive horizontal bars on a curve. If the fill spacing (setFillSpacing) is 0 and a canvas factory has been specified via setCanvasFactory, these trapezoidal areas are merged together and solidly and continously filled for any fillThickness > 0.	0 (implies no "area filling" between bars)
XGRIDLINE	The width of vertical bars used to fill in the trapezoidal areas linearly interpolated between successive x-gridlilnes on a curve. If the fill spacing (setFillSpacing) is 0, fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a continuously filled area-chart, as described in setFillSpacing, will be produced.	0 (implies no "area filling" between gridlines)
YGRIDLINE	The height of horizontal bars used to fill in the trapezoidal areas linearly interpolated between successive y-gridlilnes on a curve. If the fill spacing (setFillSpacing) is 0, fillThickness > 0, and a canvas factory has been specified via setCanvasFactory, a continuously filled area-chart, as described in setFillSpacing, will be produced.	0 (implies no "area filling" between gridlines)

This fill thickness setting and the associated fill spacing setting (c.f. setFillSpacing) work together to define the look and efficiency of pie slice shading, connecting lines, etc.

Parameters:

fillThickness - the fill thickness, in pixels

See Also:

setCanvasFactory, getFillThickness, setFillSpacing

setHoverAnnotationEnabled

public void setHoverAnnotationEnabled(boolean hoverAnnotationEnabled)

Sets a boolean that determines if point-specific annotations will popup whenever you hover over a point on the curve associated with this symbol.

By default, these hover-induced popups are enabled.

Note that the point selection feedback on the hovered-over point is controlled separately, via the setHoverSelectionEnabled method.

Parameters:

hoverAnnotationEnabled - true if hover-induced annotations popup on this curve, false otherwise.

See Also:

getHoverAnnotationEnabled, setHoverSelectionEnabled, setHovertextTemplate, setHoverWidget, setHoverLocation, setHoverAnnotationSymbolType, setHoverXShift, setHoverYShift

setHoverFontWeight

public void setHoverFontWeight(java.lang.String cssWeight)

Specifies the weight of the font that will be used to render the text of this point's hover annotations.

Parameters:

cssWeight - A standard CSS font-weight specification such as normal, bold, bolder, lighter, 100, 200, ... 900, or inherit

See Also:

getHoverFontWeight, setHoverFontColor, setHoverFontStyle, setHoverFontSize, setHoverLocation, setHoverWidget, setHoverXShift, setHoverYShift

setHoverFontColor

public void setHoverFontColor(java.lang.String cssColor)

Specifies the color of the hover annotations' font.

For more information on standard CSS color specifications see the discussion in Symbol.setBackgroundColor.

Parameters:

cssColor - color of the font used to display this symbol's hover annotations.

See Also:

getHoverFontColor, setHoverFontWeight, setHoverFontStyle, setHoverFontSize, setHoverLocation, setHoverWidget, setHoverXShift, setHoverYShift

setHoverFontStyle

public void setHoverFontStyle(java.lang.String cssStyle)

Specifies the CSS font-style used by this symbol's hover annotations.

Parameters:

cssStyle - any valid CSS font-style, namely, normal, italic, oblique, or inherit.

See Also:

getHoverFontStyle, setHoverFontWeight, setHoverFontColor, setHoverFontSize, setHoverLocation, setHoverWidget, setHoverXShift, setHoverYShift

setHoverFontSize

public void setHoverFontSize(int fontSize)

Specifies the CSS font size used in this symbol's hover annotations, in pixels.

Parameters:

fontSize - the CSS font size used in the hover annotations associated with this symbol, in pixels.

See Also:

getHoverFontSize, setHoverFontWeight, setHoverFontColor, setHoverFontStyle, setHoverLocation, setHoverWidget, setHoverXShift, setHoverYShift

setHoverLocation

public void setHoverLocation(GChart.AnnotationLocation hoverLocation)

Specifies the location of this point's hover annotations. Set this property to null (the default) to use GChart's default hover location, which varies with the hover annotation's symbol type, as tabulated below. (The hover annotation symbol type defaults to the symbol type of the hovered over curve, and can be specified explicitly via the setHoverAnnotationSymbolType method).

SymbolType used to position hover annotation	Default Hover AnnotationLocation
HBAR_BASELINE_*	FARTHEST_FROM_VERTICAL_BASELINE
HBAR_*WEST	EAST
HBAR_*EAST	WEST
PIE_SLICE_*	OUTSIDE_PIE_ARC
VBAR_SOUTH*	NORTH
VBAR_BASELINE_*	FARTHEST_FROM_HORIZONTAL_BASELINE
VBAR_NORTH*	SOUTH
All others	NORTHWEST

You can further adjust the position of a point's hover annotations by specifying non-zero positional shifts via the setHoverXShift and setHoverYShift methods, and via the setHoverAnnotationSymbolType method.

Tip: To position hover annotations at a fixed location on the chart, (such as a status bar that displays information about the hovered over point, an inset chart that shows a detailed view, etc.) pass one of the ANCHOR_* symbol types to the setHoverAnnotationSymbolType method.

Parameters:

hoverLocation - the relative location of the hover annotations, or null to use a symbol-type-specific default.

See Also:

getHoverLocation, setHoverFontWeight, setHoverFontColor, setHoverFontStyle, setHoverFontSize, setHoverAnnotationSymbolType, setHoverWidget, setHoverXShift, setHoverYShift, DEFAULT_HOVER_LOCATION

setHoverAnnotationSymbolType

public void setHoverAnnotationSymbolType(GChart.SymbolType hoverAnnotationSymbolType)

Sets the symbol type that GChart will use when positioning hover annotations. GChart positions each hover annotation as if it were associated with a point with the same x,y as the hovered over point, and mapped to the same y-axis, but that appears on a curve with the symbol type specified by this method.

If null is used (this is the default) GChart will use the symbol type associated with the curve containing the hovered over point. Since normally you will want hover annotations to be positioned as if they were annotations of the hovered over points, this default is usually appropriate.

However, sometimes you would like the hover annotations to be positioned differently. For example, you might prefer the hover annotations to always appear within a status bar at the bottom of the chart. To achieve this, you could set this property to ANCHOR_SOUTHWEST. Or suppose you always wanted a pie chart's hover annotations to appear in the center of the pie instead of along the outer perimeter. Then you could use BOX_CENTER. Or, if you wanted the hover annotations to be positioned relative to the position that the mouse was at when the symbol was first "touched", you could use ANCHOR_MOUSE.

Tip: Pre v2.4 versions of GChart supported a much simpler, "at-the-mouse", setTitle-based, hover feedback that you can emulate using code such as:

     Symbol sym = getCurve().getSymbol();
     sym.setHoverAnnotationSymbolType(SymbolType.ANCHOR_MOUSE);
     sym.setHoverLocation(AnnotationLocation.SOUTHEAST);
     sym.setHoverYShift(-20); // push 20px below mouse
                              // (kind of like setTitle does it).

     // Convenience/transition-helper method
     // formatAsHovertext wraps plain text in appropriate
     // HTML so it looks kind of like setTitle-based hovertext.
     
     sym.setHovertextTemplate(
       GChart.formatAsHovertext("x=${x}, y=${y}")); 
 

Parameters:

hoverAnnotationSymbolType - the symbol type that in part determines how the hover annotations get positioned, or null (the default) to use the symbol type of the hovered over point.

See Also:

getHoverAnnotationSymbolType, setHoverLocation, setHovertextTemplate, setHoverXShift, setHoverYShift, GChart.formatAsHovertext

setHoverSelectionBackgroundColor

public void setHoverSelectionBackgroundColor(java.lang.String hoverSelectionBackgroundColor)

Specifies the background color used to indicate that the mouse is "touching" (hovering over) a point.

Whenever the user "touches" a point on this curve with the curve's mouse-centered "brush", GChart displays the hover feedback for that point, and indicates that the point is the one the hover feedback refers to changing its background color to this color.

The default hover selection background color is "transparent". This allows the original symbol to appear within selection rectangles that can be defined via the setHoverSelectionBorderWidth and setHoverSelectionBorderColor methods (1px thick external gray selection rectangles are used by default).

Tip: Because the background selection color will often cover the original symbol, it's usually best to choose a selection background color closely related to the original symbol's background color. For example, if the original symbol were blue, you might use a lighter shade of blue.

Parameters:

hoverSelectionBackgroundColor - a CSS color specification string that specifies the background color used to indicate "hover-selection".

See Also:

getHoverSelectionBackgroundColor, setHoverSelectionBorderColor, setHoverSelectionBorderStyle, setHoverSelectionBorderWidth, setBrushHeight

setHoverSelectionBorderColor

public void setHoverSelectionBorderColor(java.lang.String hoverSelectionBorderColor)

Specifies the border color used to indicate that the mouse is "touching" (hovering over) a point.

Whenever the user "touches" a point on this curve with the mouse-centered "brush", GChart displays the hover feedback for that point, and indicates that the point is the one the hover feedback refers to by drawing a border around it with the given color.

The width of this border, and if the is drawn outside or just inside the rectangles associated with the symbol, can be specified via setHoverSelectionBorderWidth. The default hover selection border color is gray.

Parameters:

hoverSelectionBorderColor - a CSS color specification string that specifies the color used to indicate "hover-selection", or the special keyword TRANSPARENT_BORDER_COLOR for a cross-browser consistent transparent border.

See Also:

getHoverSelectionBorderColor, setHoverSelectionBorderStyle, setHoverSelectionBorderWidth, setBrushHeight

setHoverSelectionBorderStyle

public void setHoverSelectionBorderStyle(java.lang.String hoverSelectionBorderStyle)

Specifies the border style used to indicate that the mouse is "touching" (hovering over) a point.

Whenever the user "touches" a point on this curve with the mouse-centered "brush", GChart displays the hover feedback for that point, and indicates that the point is the one the hover feedback refers to by drawing a border around it with the given style.

The width of this border, and if the is drawn outside or just inside the rectangles associated with the symbol, can be specified via setHoverSelectionBorderWidth. The default hover selection border style is solid.

Parameters:

hoverSelectionBorderStyle - a CSS border style specification string that indicates the style of border used to indicate "hover-selection".

See Also:

getHoverSelectionBorderStyle, setHoverSelectionBorderWidth, setHoverSelectionBorderColor, setBrushHeight

setHoverSelectionBorderWidth

public void setHoverSelectionBorderWidth(int borderWidth)

Sets the width of the border around the perimeter of rectangles used to indicate that the mouse is "touching" (hovering over) a point.

If positive, the border is drawn inside each rendered rectangle of the selected symbol. If negative, the border is drawn outside of those rectangles.

Tip: To create the illusion that symbols increase in size when they are "touched", use a hover selection border color that matches the symbol's color along with a negative hover selection border width.

Parameters:

borderWidth - the width of the border drawn around the perimeter of the selected symbol's rectangles to indicate that the symbol is being "touched: by the mouse. A negative value adds that border around the outside of the existing rectangles, in effect increasing the selected symbol's size (in pixels).

See Also:

getHoverSelectionBorderWidth, setHoverSelectionBorderColor, setHoverSelectionBackgroundColor, setHoverSelectionBorderStyle

setHoverSelectionEnabled

public void setHoverSelectionEnabled(boolean hoverSelectionEnabled)

Specifies if hover selection feedback will be provided for this curve.

When enabled, whenever the user "touches" a point on this curve with the mouse-centered "brush", GChart indicates the hover-selected point by adding a selection border around the point, etc.

By default, hover selection feedback is enabled.

Note that the pop-up hover annotation itself is controlled separately, via the setHoverAnnotationEnabled method.

Parameters:

hoverSelectionEnabled - a if true, hover selection feedback is enabled, if false, hovering over a point does not change its color.

See Also:

getHoverSelectionEnabled, setHoverAnnotationEnabled, setHoverSelectionBackgroundColor, setHoverSelectionBorderColor, setHoverSelectionBorderStyle, setHoverSelectionBorderWidth, setHoverSelectionSymbolType

setHoverSelectionFillSpacing

public void setHoverSelectionFillSpacing(double selectionFillSpacing)

Specifies the fill spacing that will be used when rendering this curve's hover selection feedback.

For more on fill spacing, see setFillSpacing.

Parameters:

selectionFillSpacing - fill spacing, in pixels, used when rendering this curve's hover selection feedback or Double.NaN (the default) to adopt the curve's fill spacing.

See Also:

getHoverSelectionFillSpacing, setFillSpacing

setHoverSelectionFillThickness

public void setHoverSelectionFillThickness(int selectionFillThickness)

Specifies the fill thickness that will be used when rendering this curve's hover selection feedback.

For more on fill thickness, see setFillThickness.

Parameters:

selectionFillThickness - fill thickness, in pixels, used when rendering this curve's hover selection feedback or GChart.NAI (the default) to adopt the curve's fill thickness.

See Also:

getHoverSelectionFillThickness, setFillThickness

setHoverSelectionHeight

public void setHoverSelectionHeight(int selectionHeight)

Sets the height of the symbol used to indicate when a given point is being "hovered over" with the mouse.

With the default setting of GChart.NAI, GChart simply gives the hover selection symbol the same height as the symbol representing the point itself. Though this default is usually appropriate, you might want the selection symbol to have a larger size so as to increase the visibility of the selected point, etc.

Parameters:

selectionHeight - the height of the symbol used to indicate that that a point has been selected, in pixels, or GChart.NAI (the default) to use the height of the symbol representing the selected point.

See Also:

getHoverSelectionHeight, setHoverSelectionWidth, setHoverSelectionBorderColor, setHoverSelectionBackgroundColor

setHoverSelectionImageURL

public void setHoverSelectionImageURL(java.lang.String imageURL)

Specifies the URL that will define the image used to render selection feedback for points on the curve associated with this symbol.

Specify null to use the URL returned by getBlankImageURL (this is the default, and gives you a blank 1x1 pixel GIF). Since the image is transparent, the setHoverSelectionBackgroundColor method can be used to define the background color of the selection feedback.

Though most applications will do just fine with this default, you can use this method for special selection effects, such creating a semi-transparent "screen" (say, by using an image with alternating transparent and gray pixels) that overlays the selected points.

The image is applied in the same way as the symbol's own image URL, but to the internal, system, curve GChart uses to render the selection feedback. See setImageURL for additional information.

Parameters:

imageURL - the url that defines the image used to generate selection feedback for points rendered with this symbol, or null to to use GChart's default selection image URL (a 1x1 transparent blank GIF).

See Also:

getHoverSelectionImageURL, setImageURL, setBlankImageURL

setHoverSelectionSymbolType

public void setHoverSelectionSymbolType(GChart.SymbolType hoverSelectionSymbolType)

Sets the symbol type that GChart will use when generating selection feedback. GChart indicates that a point is selected by re-rendering the point as if it had this symbol type (this re-rendering overlays, but need not completely cover, the original rendering).

If null is used (this is the default) GChart will use the symbol type associated with the original point. This default, which overlays the selection feedback on top of the rendered symbol, is usually appropriate.

However, sometimes you would like the selection feedback to use a different symbol type. For example, you might prefer to indicate that a point is selected by drawing a vertical gridline through the point. To achieve this, you could use the XGRIDLINE symbol type. Or, you might wish to indicate selection by dropping a vertical line from the center of the selected point to the x-axis. In this case, you could use VBAR_SOUTH as the hover selection symbol type.

Note: The special mouse related symbol types (those with names matching ANCHOR_MOUSE*) are intended for use in positioning hover popup annotations (via setHoverAnnotationSymbolType). They are not expected to be useful, and could potentially cause confusion, if used as the symbol type passed to this method.

Parameters:

hoverSelectionSymbolType - the symbol type that in part determines how selection feedback for a hovered over point is drawn, or null (the default) to use the symbol type of the hovered over point.

See Also:

getHoverSelectionSymbolType, setHoverSelectionBackgroundColor, setHoverSelectionBorderColor, setHoverSelectionBorderWidth, setHoverSelectionHeight, setHoverSelectionWidth, setHoverAnnotationSymbolType

setHoverSelectionWidth

public void setHoverSelectionWidth(int selectionWidth)

Sets the width of the symbol used to indicate when a given point is being "hovered over" with the mouse.

With the default setting of GChart.NAI, GChart simply gives the hover selection symbol the same width as the symbol representing the point itself. Though this default is usually appropriate, you might want the selection symbol to have a larger size so as to increase the visibility of the selected point, etc.

Parameters:

selectionWidth - the width of the symbol used to indicate that that a point has been selected, in pixels, or GChart.NAI (the default) to use the width of the symbol representing the selected point.

See Also:

getHoverSelectionWidth, setHoverSelectionHeight, setHoverSelectionBorderColor, setHoverSelectionBackgroundColor

setHovertextTemplate

public void setHovertextTemplate(java.lang.String hovertextTemplate)

Defines the "hover-text" that appears whenever the user points their mouse at a point on the curve.

HTML is supported within hover-text. As with setAnnotationText, you must prefix HTML template strings with <html> or they will be treated as plain text.

Three built-in parameters, ${x}, ${y}, and ${pieSliceSize} are recognized within these hover text templates. Any occurrences of ${x} in the string will be replaced with the x-coordinate of the point, formatted as per the specified tick label format of the x-axis. Any occurrences of ${y} within the string will be replaced with the y-coordinate of the point, formatted either using the y-axis or y2-axis tick label format, depending on the axis on which the curve is displayed. Any occurrences of ${pieSliceSize} within the string will be replaced with 100 times the specified pieSliceSize of the point, formatted the same way as ${y}, except that a "%" is tacked onto the end.

In addition to these built-in parameters, user-defined parameters are also supported. All parameter names must begin with a letter (a,b,...,z or A,B,...,Z) and be followed by a series of letters, digits (0,1,...,9), and underscores (_). For example, ${myParam3} or ${xyz_123}. Note that parameter names are case-sensitive.

You define the rules for expanding these user-defined parameters relative to the hovered-over point, by instantiating a HoverParameterInterpreter and passing it to GChart's setHoverParameterInterpreter method. See the HoverParameterInterpreter interface's javadocs for full details.

Tip: If the ${ is not followed by a valid parameter name and then by }, the "invalid name", along with the original delimiters, passes through literally into the final hovertext (no exception is thrown). So, if you see keywords in your hovertext, it probably means you misspelled a keyword (e.g. you entered ${piesliceSize} instead of ${pieSliceSize}), forgot the closing }, began a user-defined parameter name with a digit, and so on.

The default hovertext template, used automatically if hovertext template is null, is DEFAULT_PIE_SLICE_HOVERTEXT_TEMPLATE for pie slice type symbols and DEFAULT_HOVERTEXT_TEMPLATE for all other symbol types.

Tip:If you notice unexplained whitespace to the right or below your pages, that comes and goes as you hover over the chart, it could be due to an overly large default estimate for the hidden "bounding box" GChart uses to properly center hover annotations. You can use the setHoverWidget method, with a null first widget parameter, to override these defaults and correct this problem.

Parameters:

hovertextTemplate - defines the hoverText to display when the mouse moves over a point on this curve, with ${x}, ${y} and ${pieSliceSize} parameters replaced as described above, and custom parameters replaced as defined by the parent GChart's HoverParameterInterpreter.

See Also:

getHovertextTemplate, getHovertext, HoverParameterInterpreter, setHoverParameterInterpreter, HoverUpdateable, setAnnotationText, DEFAULT_HOVERTEXT_TEMPLATE, DEFAULT_PIE_SLICE_HOVERTEXT_TEMPLATE

setHoverWidget

public void setHoverWidget(HoverUpdateable hoverWidget,
                           int widthUpperBound,
                           int heightUpperBound)

Specifies a HoverUpdateable widget that will be used to display the hover annotations associated with this symbol. If null, GChart's built-in, setHovertextTemplate-based, text or HTML based hover annotations will instead be used.

Whenever the rectangular "brush" centered on the current mouse position "touches" a point on this symbol's parent curve, GChart will first call the hoverUpdate method of this "hover-widget", and then position it appropriately relative to the touched point. Most applications will want to implement hoverUpdate so as to populate the hover widget with detailed information about the touched point. For example, to emulate GChart's default hover feedback, you could extend an HTML widget and, within the hoverUpdate method, use the setHTML method to set the widget's HTML to the expanded hover text returned by hoveredOverPoint.getHovertext().

The exact position of the hover widget relative to the touched point is defined by the companion methods, setHoverLocation, setHoverAnnotationSymbolType, setHoverXShift, and setHoverYShift.

Parameters:

hoverWidget - a Widget that implements the HoverUpdateable interface that GChart will use when generating this symbol's widget-based hover annotations, or null to use GChart's text or HTML based hover annotations (the other two parameters can still be used to specify upper-bounds on the width and height of this default hover text).

widthUpperBound - an upper bound on the width of the widget (or default hover annotation) in pixels. Use GChart.NAI to get the GChart-determined default.

heightUpperBound - an upper bound on the height of the widget (or default hover annotation) in pixels. Use GChart.NAI to get the GChart-determined default.

See Also:

getHoverWidget, getHovertext, HoverUpdateable, setHoverFontWeight, setHoverFontColor, setHoverFontStyle, setHoverFontSize, setHoverLocation, setHoverAnnotationSymbolType, setHovertextTemplate, setHoverXShift, setHoverYShift

setHoverWidget

public void setHoverWidget(HoverUpdateable annotationWidget)

Specifies a HoverUpdateable widget that will be used to display all hover annotations associated with this symbol. If null, GChart's built-in, setHovertextTemplate-based, text or HTML based hover annotations will instead be used.

A convenience method equivalent to setHoverWidget(hoverWidget, GChart.NAI, GChart.NAI)

Parameters:

annotationWidget - the GWT Widget that defines this point's hover-induced annotation, or null to use the default hover annotation, which is based on expanding the hover text template relative to the hovered over point.

See Also:

setHoverWidget(HoverUpdateable,int,int), setHovertextTemplate, getHovertext, DEFAULT_WIDGET_HEIGHT_UPPERBOUND, DEFAULT_WIDGET_WIDTH_UPPERBOUND

setHoverXShift

public void setHoverXShift(int xShift)

Specifies the number of pixels (along the x-axis) to move this symbol's hover annotations from their default, AnnotationLocation-defined, point-relative locations.

Actual positional shifts are defined via the same conventions as are used by setAnnotationXShift. See that method for further details.

See Also:

getHoverXShift, setAnnotationXShift, setHoverFontWeight, setHoverFontColor, setHoverFontStyle, setHoverFontSize, setHoverLocation, setHoverAnnotationSymbolType, setHovertextTemplate, setHoverWidget, setHoverYShift

setHoverYShift

public void setHoverYShift(int yShift)

Specifies the number of pixels (along the y-axis) to move this symbol's hover annotations from their default, AnnotationLocation-defined, point-relative locations.

Actual positional shifts are defined via the same conventions as are used by setAnnotationYShift. See that method for further details.

See Also:

getHoverYShift, setAnnotationYShift, setHoverFontWeight, setHoverFontColor, setHoverFontStyle, setHoverFontSize, setHoverLocation, setHoverAnnotationSymbolType, setHovertextTemplate, setHoverWidget, setHoverXShift

setImageURL

public void setImageURL(java.lang.String imageURL)

Specifies the URL that will define the image used to represent the points on this curve.

Specify null to use the URL returned by getBlankImageURL (this is the default, and gives you a blank 1x1 pixel GIF).

Most applications will do just fine with the default. However, this method lets you replace the default, rectangular, chart symbols with custom images (e.g. a five pointed star) or even a Google Chart API url to use tiny 3-D pie charts for each point symbol (it looks a bit strange, and your chart will no longer be strictly client-side any more, but it does work).

Note that if the symbol's width and height are bigger or smaller than the specified image, the image will be stretched to fit the symbol's size. Except for single pixel images and such, this does not usually look that great, so exactly matching up the symbol and image size is often best.

Tip: By using a single pixel high or wide image whose other dimension exactly matches the width or height of the symbol, the image will stretch to produce a regular pattern of horizontal or vertical lines. For example, this technique can be used to produce a vertical or horizontal gradient effect in a horizontal or vertical bar chart.

Be aware that GChart was originally designed with only blank image URL's in mind, so it may take some effort to adjust other settings (such as symbol type, width, height, background color, border color, various legend related settings, and curve order) so that the overall chart looks right with your custom images for the curve symbols. In particular, the legend icons are just scaled-down versions of the image, which often doesn't look that great.

A alternative that gives you more control (but is less efficient) is to use SymbolType.NONE with setAnnotationWidget (or setAnnotationText) and setAnnotationLocation(AnnotationLocation.CENTER) to use separate, centered, widget-based (or HTML based) annotations in lieu of each point's image-based symbol.

Parameters:

imageURL - the url that defines the image within all the rectangular elements used to draw this symbol on the chart, or null to revert to GChart's default (a 1x1 transparent blank GIF).

See Also:

getImageURL, setBlankImageURL, setPlotAreaImageURL, setAnnotationWidget, setAnnotationText, setAnnotationLocation, setSymbolType, SymbolType.NONE

setHeight

public void setHeight(int height)

Sets the height of this symbol (including any specified border) in pixels.

Symbols for drawing vertical bars and symbols defining vertical lines between points or across the entire chart, compute their heights automatically based on curve data, axes limits, specified baselines, etc. These symbols, namely XGRIDLINE and all those whose names begin with VBAR_ will ignore this height setting.

Parameters:

height - height of this symbol, in pixels.

See Also:

getHeight

setModelHeight

public void setModelHeight(double modelHeight)

Sets the height of this symbol (including any specified border) in model units (arbitrary, user-defined, units). Model units are the same units in which the points on the chart are specified and charted.

Specification of the modelHeight undefines (that is, sets to GChart.NAI) any previous pixel-based specification made via setHeight.

Symbols for drawing vertical bars and symbols defining vertical lines between points or across the entire chart, compute their heights automatically based on curve data, axes limits, specified baselines, etc. These symbols, namely XGRIDLINE and all those whose names begin with VBAR_ will ignore this height setting.

Parameters:

modelHeight - height of this symbol, in model units

See Also:

getModelHeight, setHeight, setModelWidth, setWidth

setModelWidth

public void setModelWidth(double modelWidth)

Sets the width of this symbol (including any specified border) in model units. Model units are an arbitrary, user-defined units system associated with the x,y coordinates of points displayed on the chart.

Specification of a symbol's model width undefines (that is, sets to GChart.NAI) any previous, pixel-based, width specification made via setWidth.

Symbols for drawing horizontal bars, and symbols defining horizontal lines between points or across the entire chart, compute their widths automatically based on curve data, axes limits, specified baseline, etc. These symbols, namely YGRIDLINE and all those whose names begin with HBAR_ will ignore this width setting.

Parameters:

modelWidth - width of this symbol, in model units.

See Also:

setModelHeight, setWidth, setHeight

setPieSliceOrientation

public void setPieSliceOrientation(double pieSliceOrientation)

Specifies a value that defines the angular orientation of the first edge of the pie slice associated with this symbol. (An additional clockwise rotation as defined by setPieSliceSize defines the angular orientation of the second edge of the pie slice).

When specified explicitly, the value must be a fraction >= 0 and < 1, with 0 representing due south, 0.25 an additional clockwise angular rotation (starting at due south) that is 25% of the full, 360 degree rotation (and thus, if you can follow these gyrations, is due west), 0.5 representing a 50% clockwise angular rotation from due south (thus, due north), .75 a 75% clockwise rotation (and thus, due east), etc.

If the specially recognized value, Double.NaN, is specified, orientation is chosen so as to make this slice appear adjacent to the previous slice, (assuming it has the same x,y as the previous slice and is thus part of the same pie figure). If this symbol/point represents the very first pie slice, Double.NaN causes the slice to be oriented as specified via the setInitialPieSliceOrientation method (by default, that's due south). Note that though this value can be set regardless of the symbol's SymbolType, it only has an impact on how the symbol is rendered if the symbol has one of the pie slice symbol types (e.g. PIE_SLICE_VERTICAL_SHADING).

Parameters:

pieSliceOrientation - angle at which first edge of pie slice appears, expressed as a fraction of a full 360 degree (2*Pi radians) clockwise rotation from an initial due south position (the 6 o'clock position) required to reach the first edge of the pie slice.

See Also:

getPieSliceOrientation, setPieSliceSize, setInitialPieSliceOrientation

setPieSliceSize

public void setPieSliceSize(double pieSliceSize)

Specifies a value that defines the angular size of any pie slice associated with this symbol.

This must be value between 0 and 1. 0.25 represents a quarter pie slice, 0.5 a half pie, 1 a full pie, etc.

Note: To create a complete pie, you must arrange things so that the sum of all of your pie slice sizes adds up to exactly 1.0. If they sum to more than 1, some slices will cover up others; it they sum to less, your pie will have missing slices. You can assure you get a full pie, regardless of the original slice sizes by normalizing your slice sizes. Specifically, divide each original slice size by the sum over all of the original slice sizes. For example, if the original slice sizes were 1, 2, and 2 you could divide them by their sum (1 + 2 + 2 = 5) to obtain normalized slice sizes of 0.2, 0.4, and 0.4.

Note that though this value can be set regardless of the symbol's current SymbolType, it only has an impact on how the symbol is rendered if the symbol has one of the pie slice symbol types (e.g. PIE_SLICE_VERTICAL_SHADING).

Parameters:

pieSliceSize - Fraction of a full pie subtended by this particular pie slice. Must be between 0 and 1, inclusive.

See Also:

getPieSliceSize, setPieSliceOrientation

setSymbolType

public void setSymbolType(GChart.SymbolType symbolType)

Sets the type of this symbol.

Note: The special mouse related symbol types (those with names that begin with ANCHOR_MOUSE) are intended for use in positioning hover popup annotations (via setHoverAnnotationSymbolType). They are not expected to be useful, and could potentially cause confusion, if used as the symbol types of ordinary curves.

Parameters:

symbolType - the new symbol type for this symbol.

See Also:

SymbolType, ANCHOR_MOUSE, setHoverAnnotationSymbolType

setWidth

public void setWidth(int width)

Sets the width of this symbol (including any specified border) in pixels.

Symbols for drawing horizontal bars, and symbols defining horizontal lines between points or across the entire chart, compute their widths automatically based on curve data, axes limits, specified baseline, etc. These symbols, namely YGRIDLINE and all those whose names begin with HBAR_ will ignore this width setting.

Parameters:

width - width of this symbol, in pixels

See Also:

setHeight