org.moxieapps.gwt.highcharts.client
Class Point

java.lang.Object
  org.moxieapps.gwt.highcharts.client.Configurable<Point>
      org.moxieapps.gwt.highcharts.client.Point

public class Point
extends Configurable<Point>

Represents a single data point that can be added to a Series. As an extension of Configurable each point instance can also optionally have configuration options set on it. Standard example:

  chart.addSeries(chart.createSeries()
     .setName("Browser share")
     .setPoints(new Point[] {
        new Point(15, 45.0),
        new Point(25, 26.8),
        new Point(35, 12.8),
        new Point(46, 8.5),
        new Point(55, 6.2),
        new Point(65, 0.7)
     })
 );
 

Advanced pie chart example (where the points represent categories and values for each category):

  chart.addSeries(chart.createSeries()
     .setName("Browser share")
     .setPoints(new Point[]{
        new Point("Firefox", 45.0),
        new Point("IE", 26.8),
        new Point("Chrome", 12.8)
            .setSliced(true)
            .setSelected(true),
        new Point("Safari", 8.5),
        new Point("Opera", 6.2),
        new Point("Others", 0.7)
     })
 );
 

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Field Summary

String

id

Constructor Summary

Point(com.google.gwt.core.client.JavaScriptObject nativePoint)
This constructor is intended for internal use, and provides the ability to construct a GWT Point instance from the native JS Point instance managed within Highcharts.

Point(Number... values)
Create a new point with an arbitrary number of values.

Point(Number y)
Create a new point, setting only the Y axis value that the point should be rendered at within the series.

Point(Number x, Number y)
Create a new point, setting both the value that the point should be rendered at on the X and Y axis within the series.

Point(Number x, Number a, Number b)
Create a new point for an area range / area range spline chart, setting the x and low / high y values.

Point(Number x, Number open, Number high, Number low, Number close)
Create a new point for an OHLC chart, setting the x and all four OHLC values.

Point(Number x, String title, String text)
Creates a new point of type "flag" at a given value with a title and text.

Point(String name)
Creates a new point with only a 'name' field.

Point(String name, Number y)
Create a new point, setting the Y axis value that the point should be rendered at within the series as well as the "name" property of the point (which is often the case for pie charts.)

Method Summary

Number	getClose() For OHLC charts, return the "close" value of the data point
Number	getHigh() For OHLC charts, return the "high" value of the data point
Number	getLow() For OHLC charts, return the "low" value of the data point
String	getName() Return the name property that was set on this point, or null if no name was set.
com.google.gwt.core.client.JavaScriptObject	getNativePoint() Returns a pointer to the native Highchart's JS point instance that this GWT Point instance is associated with.
Number	getOpen() For OHLC charts, return the "open" value of the data point
String	getText() Return the text property that was set on this point, or null if no text was set.
String	getTitle() Return the title property that was set on this point, or null if no name was set.
com.google.gwt.json.client.JSONObject	getUserData() Retrieve any arbitrary data that was stored along with the point (via the setUserData(JSONObject) method) when it was originally added to a series
Number	getValue() Retrieves the intensity 'value' of the point as it pertains to heatmaps.
Number	getX() Retrieve the X value of where point should be rendered at within the series.
Number	getY() Retrieve the Y value of where point should be rendered at within the series.
Number	getZ() Retrieves the Z value of where point should be rendered at within the series for 3D chart types.
Point	remove() Remove the point from the series, automatically redrawing the chart using the default animation options.
Point	remove(boolean redraw, Animation animation) Remove the point from the series, explicitly controlling whether the chart is redrawn and the details of the animation options.
Point	remove(boolean redraw, boolean animation) Remove the point from the series, explicitly controlling whether the chart is redrawn and/or animated or not.
Point	select(boolean select, boolean accumulate) Select or unselect the point.
Point	selectToggle(boolean accumulate) Toggle the selection state of the point.
Point	setColor(String color) Convenience method for setting the 'color' option of the point.
Point	setDrilldownSeries(Series drilldownSeries) Convenience method for setting the 'drilldown' option of the point.
Point	setIsIntermediateSum(boolean isIntermediateSum) Convenience method for setting the 'isIntermediateSum' option for a point.
Point	setIsSum(boolean isSum) Convenience method for setting the 'isSum' option for the point.
Point	setMarker(Marker marker) Override the individual point marker for the point.
Point	setName(String name) Convenience method for setting the 'name' option of the point.
Point	setParent(Point parent) Convenience method for setting the 'parent' option of the point.
Point	setParent(String parent) convenience method for setting the 'parent' option of the point, which is useful for tree map chart types.
Point	setSelected(boolean selected) Convenience method for setting the 'selected' option of the point.
Point	setSliced(boolean sliced) Convenience method for setting the 'sliced' option of the point.
Point	setText(String text) Convenience method for setting the 'text' option of the point.
Point	setTitle(String title) Convenience method for setting the 'title' option of the point.
Point	setUserData(com.google.gwt.json.client.JSONObject userData) Store some arbitrary data on the point.
Point	slice(boolean sliced) Slice out or set back in a pie chart slice, automatically redrawing the chart with the default animation options.
Point	slice(boolean sliced, boolean redraw, Animation animation) Slice out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not.
Point	slice(boolean sliced, boolean redraw, boolean animation) Slice out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not.
Point	sliceToggle() Toggle slicing out or set back in a pie chart slice, automatically redrawing the chart with the default animation options.
Point	sliceToggle(boolean redraw, Animation animation) Toggle slicing out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not.
Point	sliceToggle(boolean redraw, boolean animation) Toggle slicing out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not.
Point	update(Number y) Update the point with the new values, automatically redrawing the chart with the default animation options.
Point	update(Number y, boolean redraw) Update the point with the new values, specifying whether or not the chart should be automatically redrawn with the new values.
Point	update(Number x, Number y) Update the point with the new values, automatically redrawing the chart with the default animation options.
Point	update(Number x, Number y, boolean redraw) Update the point with the new values, specifying whether or not the chart should be automatically redrawn with the new values.
Point	update(Number x, Number low, Number high) Update the point with the new values, automatically redrawing the chart with the default animation options.
Point	update(Number x, Number low, Number high, boolean redraw) Update the point with the new values, specifying whether or not the chart should be automatically redrawn with the new values.
Point	update(Point pointOptions) Update the point with the new values and options from the given point, automatically redrawing the chart with the default animation options.
Point	update(Point pointOptions, boolean redraw, Animation animation) Update the point with the new values and options from the given point, specifying if the chart should be automatically redrawn and animated or not.
Point	update(Point pointOptions, boolean redraw, boolean animation) Update the point with the new values and options from the given point, specifying if the chart should be automatically redrawn and animated or not.

Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable

getOptions, setOption

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

Constructor Detail

Point

public Point(Number y)

Create a new point, setting only the Y axis value that the point should be rendered at within the series.

Parameters:

y - The Y value that the point should be rendered at within the series.

Point

public Point(Number x,
             Number y)

Create a new point, setting both the value that the point should be rendered at on the X and Y axis within the series.

Parameters:

x - The X value that the point should be rendered at within the series.

y - The Y value that the point should be rendered at within the series.

Point

public Point(Number x,
             Number a,
             Number b)

Create a new point for an area range / area range spline chart, setting the x and low / high y values. Or, create a new point for a heatmap, where the first and second parameters are the x/y coordinates of the point on the heatmap, and the third parameter is the value that will be used to determine the intensity of the "heat" color for that point.

Parameters:

x - The X value that the point should be rendered at within the series.

a - The "low" value that the point should be rendered at within the series for a range chart, or the Y value when used in a heatmap.

b - The "high" Y value that the point should be rendered at within the series for a range chart, or the intensity of the color in a heat map.

Since:

1.5.0

Point

public Point(Number x,
             Number open,
             Number high,
             Number low,
             Number close)

Create a new point for an OHLC chart, setting the x and all four OHLC values.

Parameters:

x - The X value that the point should be rendered at within the series.

open - The "open" Y value that the point should be rendered at within the series.

high - The "high" Y value that the point should be rendered at within the series.

low - The "low" Y value that the point should be rendered at within the series.

close - The "close" Y value that the point should be rendered at within the series.

Since:

1.2.0

Point

public Point(Number... values)

Create a new point with an arbitrary number of values. E.g. a call like "new Point(5)" would create a point with a single Y value. A call like "new Point(5, 10)" would create a point with an X and Y value, etc. See the other Point constructors for details on the purpose of point with a different count of values.

Parameters:

values - An array of numeric values to initialize the point with.

See Also:

Point(Number), Point(Number, Number), Point(Number, Number, Number), Point(Number, Number, Number, Number, Number), Point(String), Point(String, Number), Point(Number, String, String)

Point

public Point(String name,
             Number y)

Create a new point, setting the Y axis value that the point should be rendered at within the series as well as the "name" property of the point (which is often the case for pie charts.)

Parameters:

name - The value to set as the "property" of the point.

y - The Y value that the point should be rendered at within the series.

Point

public Point(String name)

Creates a new point with only a 'name' field. Only used in waterfall charts when the value is computed by setIsIntermediateSum(boolean) or (@link #setIsSum(boolean)}

Parameters:

name - The name of the point

Since:

1.6.0

Point

public Point(Number x,
             String title,
             String text)

Creates a new point of type "flag" at a given value with a title and text. Intended to be added to series whose type has been set to Series.Type.FLAGS;

Parameters:

x - Point where the flag appears

title - Title of flag displayed on the chart

text - Text displayed when the flag are highlighted.

Point

public Point(com.google.gwt.core.client.JavaScriptObject nativePoint)

This constructor is intended for internal use, and provides the ability to construct a GWT Point instance from the native JS Point instance managed within Highcharts.

Parameters:

nativePoint - The native javascript object containing the details of the point

Method Detail

getValue

public Number getValue()

Retrieves the intensity 'value' of the point as it pertains to heatmaps.

Returns:

The 'value' value of the point (should always be non-null, unless called on a point that is not part of a heatmap.)

getZ

public Number getZ()

Retrieves the Z value of where point should be rendered at within the series for 3D chart types.

Returns:

The Z value of the point (should always be non-null, unless called on a point that is not part of a 3D series.)

getY

public Number getY()

Retrieve the Y value of where point should be rendered at within the series.

Returns:

The Y value of the point (should always be non null).

getX

public Number getX()

Retrieve the X value of where point should be rendered at within the series.

Returns:

The X value of the point, or null if no X value was set.

getOpen

public Number getOpen()

For OHLC charts, return the "open" value of the data point

Returns:

The "open" value of the point, or null if no open value was set.

Since:

1.2.0

getHigh

public Number getHigh()

For OHLC charts, return the "high" value of the data point

Returns:

The "high" value of the point, or null if no high value was set.

Since:

1.2.0

getLow

public Number getLow()

For OHLC charts, return the "low" value of the data point

Returns:

The "low" value of the point, or null if no low value was set.

Since:

1.2.0

getClose

public Number getClose()

For OHLC charts, return the "close" value of the data point

Returns:

The "close" value of the point, or null if no close value was set.

Since:

1.2.0

setColor

public Point setColor(String color)

Convenience method for setting the 'color' option of the point. Equivalent to:

     point.setOption("color", "#CC0000");
 

Individual color for the point. Defaults to null.

Parameters:

color - The value to set as the point's color.

Returns:

A reference to this Point instance for convenient method chaining.

setDrilldownSeries

public Point setDrilldownSeries(Series drilldownSeries)

Convenience method for setting the 'drilldown' option of the point. Equivalent to:

     point.setOption("drilldown", "apples");
 

This method should be the primary method of adding a drilldown series to a point.

The name of a series in the drilldown.series array to use for a drilldown for this point. The name option of a point can be set via setName(String)

Parameters:

drilldownSeries - A series that will be displayed when this point is clicked

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.7.0

setIsIntermediateSum

public Point setIsIntermediateSum(boolean isIntermediateSum)

Convenience method for setting the 'isIntermediateSum' option for a point. Equivalent to:

     point.setOption("setIntermediateSum", true)
 

Used in Waterfall Charts. When this option is set to true, the point will be assigned a value that is calculated by summing all points since the last 'intermediate sum' Defaults to false.

Parameters:

isIntermediateSum - Whether the point is an intermediate sum.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.6.0

setIsSum

public Point setIsSum(boolean isSum)

Convenience method for setting the 'isSum' option for the point. Equivalent to:

     point.setOption("isSum", true);
 

Used in Waterfall charts. When this option is set to true, the point will ba assigned a value that is calculated by summing all of the points. Defaults to false.

Parameters:

isSum - Whether the point is the sum of all points

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.6.0

setMarker

public Point setMarker(Marker marker)

Override the individual point marker for the point. Defaults to null. E.g.

    new Point(10, 30)
      .setMarker(
         new Marker()
            .setEnabled(true)
            .setFillColor("#CC0000")
            .setRadius(4)
      );
 

 

Note that this method is intended to be used to override the marker options of one particular point. If you instead want to control the marker options for the entire series, use the PlotOptions.setMarker(Marker) method instead.

Parameters:

marker - The override marker options for this particular point, or null to simply use the whatever default marker options have been applied to whole series via PlotOptions.setMarker(Marker)

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

setName

public Point setName(String name)

Convenience method for setting the 'name' option of the point. Equivalent to:

     point.setOption("name", "Green Bears");
 

The name of the point as shown in the legend, tooltip, dataLabel etc. Defaults to "".

Parameters:

name - The value to set as the point's name.

Returns:

A reference to this Point instance for convenient method chaining.

getName

public String getName()

Return the name property that was set on this point, or null if no name was set.

Returns:

The 'name' property that was set on this point (likely via setName(String), or null if no name was set.

setParent

public Point setParent(Point parent)

Convenience method for setting the 'parent' option of the point. which is useful for tree map chart types. Equivalent to:

     point.setOption("parent", parentPoint.getId());
 

Sets the parent of the point to the given point.

Parameters:

parent - The point that will act as this point's 'parent'

Returns:

A reference to this Point instance or convenient method chaining.

setParent

public Point setParent(String parent)

convenience method for setting the 'parent' option of the point, which is useful for tree map chart types. Equivalent to:

     point.setOption("parent", "categoryXYZ");
 

Parameters:

parent - The ID of the point to be used as this point's parent

Returns:

A reference to this Point instance or convenient method chaining.

setSelected

public Point setSelected(boolean selected)

Convenience method for setting the 'selected' option of the point. Equivalent to:

     point.setOption("selected", true);
 

Whether the point is selected or not.

Parameters:

selected - Whether the point is selected or not.

Returns:

A reference to this Point instance for convenient method chaining.

setSliced

public Point setSliced(boolean sliced)

Convenience method for setting the 'sliced' option of the point. Equivalent to:

     point.setOption("sliced", false);
 

Pie series only. Whether to display a slice offset from the center. Defaults to false.

Parameters:

sliced - The value to set as the point's 'sliced' option.

Returns:

A reference to this Point instance for convenient method chaining.

setUserData

public Point setUserData(com.google.gwt.json.client.JSONObject userData)

Store some arbitrary data on the point. As the user interacts with the chart various events are fired (such as PointClickEvent), which include a reference to the Point instance that the event was fired on. The Point instances that are returned from the live rendered chart are actually different instances then the versions that were originally added to the chart via one of the Series addPoint() or setPoints() methods, as Highcharts has its own internal representation of all of the point objects. Therefore, if you need to track some additional information with each point (beyond its axis values) that you can later access when an event on the point is fired, this method provides a convenient way for you to store some arbitrary data on the point which will then later be available via the getUserData() method.

Parameters:

userData - Some arbitrary data that to store with the point that will be available later whenever the point instance is retrieved after the chart is rendered.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

getUserData

public com.google.gwt.json.client.JSONObject getUserData()

Retrieve any arbitrary data that was stored along with the point (via the setUserData(JSONObject) method) when it was originally added to a series

Returns:

The arbitrary data that was stored with the point when it was first added to the series, or null if no such data was set.

Since:

1.1.0

remove

public Point remove()

Remove the point from the series, automatically redrawing the chart using the default animation options.

Note that this method is only relevant on Point instance that are obtained from the chart after it has been rendered, such as via an event or dynamically retrieving the points of a series.

Also note that when using persistent chart's, you'll normally want to use the Series.removePoint(Point) method instead of this one.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

remove

public Point remove(boolean redraw,
                    boolean animation)

Remove the point from the series, explicitly controlling whether the chart is redrawn and/or animated or not.

Note that this method is only relevant on Point instance that are obtained from the chart after it has been rendered, such as via an event or dynamically retrieving the points of a series.

Also note that when using persistent chart's, you'll normally want to use the Series.removePoint(Point, boolean, boolean) method instead of this one.

Parameters:

redraw - Whether to redraw the chart after the point is removed. When removing more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the removing of points is finished.

animation - Defaults to true. When true, the graph will be animated with default animation options. Note, see the remove(boolean, Animation) method for more control over how the animation will run.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

remove

public Point remove(boolean redraw,
                    Animation animation)

Remove the point from the series, explicitly controlling whether the chart is redrawn and the details of the animation options.

Note that this method is only relevant on Point instance that are obtained from the chart after it has been rendered, such as via an event or dynamically retrieving the points of a series.

Also note that when using persistent chart's, you'll normally want to use the Series.removePoint(Point, boolean, Animation) method instead of this one.

Parameters:

redraw - Whether to redraw the chart after the point is removed. When removing more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the removing of points is finished.

animation - The custom animation to use when removing the point from the series.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

select

public Point select(boolean select,
                    boolean accumulate)

Select or unselect the point. See the selectToggle(boolean) method for other options.

Parameters:

select - When true, the point is selected. If you'd instead like to simply toggle the selection state see the selectToggle(boolean) method instead.

accumulate - When true, the selection is added to other selected points. When false, other selected points are deselected. Internally in Highcharts, selected points are accumulated on Control, Shift or Cmd clicking the point.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

selectToggle

public Point selectToggle(boolean accumulate)

Toggle the selection state of the point. See the select(boolean, boolean) method for other options.

Parameters:

accumulate - When true, the selection is added to other selected points. When false, other selected points are deselected. Internally in Highcharts, selected points are accumulated on Control, Shift or Cmd clicking the point.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

slice

public Point slice(boolean sliced)

Slice out or set back in a pie chart slice, automatically redrawing the chart with the default animation options. This is the default way of Highcharts to visualize that a pie point is selected. See the sliceToggle() method as well.

Parameters:

sliced - When true, the point is sliced out. When false, the point is set in.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

slice

public Point slice(boolean sliced,
                   boolean redraw,
                   boolean animation)

Slice out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not. This is the default way of Highcharts to visualize that a pie point is selected. See the sliceToggle(boolean, boolean) method as well.

Parameters:

sliced - When true, the point is sliced out. When false, the point is set in.

redraw - Whether to redraw the chart after the point is sliced. When slicing more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the slicing of points is finished.

animation - Defaults to true. When true, the graph will be animated with default animation options. Note, also see the slice(boolean, boolean, Animation) method

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

slice

public Point slice(boolean sliced,
                   boolean redraw,
                   Animation animation)

Slice out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not. This is the default way of Highcharts to visualize that a pie point is selected. See the sliceToggle(boolean, Animation) method as well.

Parameters:

sliced - When true, the point is sliced out. When false, the point is set in.

redraw - Whether to redraw the chart after the point is sliced. When slicing more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the slicing of points is finished.

animation - The custom animation to use when slicing the point ing the series.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

sliceToggle

public Point sliceToggle()

Toggle slicing out or set back in a pie chart slice, automatically redrawing the chart with the default animation options. This is the default way of Highcharts to visualize that a pie point is selected. See the slice(boolean) method as well.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

sliceToggle

public Point sliceToggle(boolean redraw,
                         boolean animation)

Toggle slicing out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not. This is the default way of Highcharts to visualize that a pie point is selected. See the slice(boolean, boolean, boolean) method as well.

Parameters:

redraw - Whether to redraw the chart after the point is sliced. When slicing more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the slicing of points is finished.

animation - Defaults to true. When true, the graph will be animated with default animation options. Note, also see the slice(boolean, boolean, Animation) method

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

sliceToggle

public Point sliceToggle(boolean redraw,
                         Animation animation)

Toggle slicing out or set back in a pie chart slice, controlling whether or not the chart will be automatically redraw or not. This is the default way of Highcharts to visualize that a pie point is selected. See the slice(boolean, boolean, Animation) method as well.

Parameters:

redraw - Whether to redraw the chart after the point is sliced. When slicing more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the slicing of points is finished.

animation - The custom animation to use when slicing the point ing the series.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

setText

public Point setText(String text)

Convenience method for setting the 'text' option of the point. Equivalent to:

     point.setOption("text", "Green Bears");
 

The text of the point as shown in the tooltip, defaults to "".

Parameters:

text - The value to set as the point's text.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.6.0

getText

public String getText()

Return the text property that was set on this point, or null if no text was set.

Returns:

The 'text' property that was set on this point (likely via setText(String), or null if no text was set.

Since:

1.6.0

setTitle

public Point setTitle(String title)

Convenience method for setting the 'title' option of the point. Equivalent to:

     point.setOption("title", "Green Bears");
 

The title of the point as shown in the tooltip. Defaults to "".

Parameters:

title - The value to set as the point's title.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.6.0

getTitle

public String getTitle()

Return the title property that was set on this point, or null if no name was set.

Returns:

The 'name' property that was set on this point (likely via setTitle(String), or null if no title was set.

Since:

1.6.0

update

public Point update(Number y)

Update the point with the new values, automatically redrawing the chart with the default animation options.

Parameters:

y - The new y value for the point.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

update

public Point update(Number x,
                    Number y)

Update the point with the new values, automatically redrawing the chart with the default animation options.

Parameters:

x - The new x value for the point.

y - The new value for the point.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

update

public Point update(Number x,
                    Number low,
                    Number high)

Update the point with the new values, automatically redrawing the chart with the default animation options.

Parameters:

x - The new x value for the point.

low - The new low value for the point.

high - The new high value for the point.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.5.0

update

public Point update(Number y,
                    boolean redraw)

Update the point with the new values, specifying whether or not the chart should be automatically redrawn with the new values.

Parameters:

y - The new y value for the point.

redraw - Whether to redraw the chart after the point is updated. When updating more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the updating of points is finished.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

update

public Point update(Number x,
                    Number y,
                    boolean redraw)

Update the point with the new values, specifying whether or not the chart should be automatically redrawn with the new values.

Parameters:

x - The new x value for the point.

y - The new value for the point.

redraw - Whether to redraw the chart after the point is updated. When updating more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the updating of points is finished.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

update

public Point update(Number x,
                    Number low,
                    Number high,
                    boolean redraw)

Update the point with the new values, specifying whether or not the chart should be automatically redrawn with the new values.

Parameters:

x - The new x value for the point.

low - The new low value for the point.

high - The new high value for the point.

redraw - Whether to redraw the chart after the point is updated. When updating more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the updating of points is finished.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.5.0

update

public Point update(Point pointOptions)

Update the point with the new values and options from the given point, automatically redrawing the chart with the default animation options.

Parameters:

pointOptions - The point instance from which the new values and options will be retrieved.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

update

public Point update(Point pointOptions,
                    boolean redraw,
                    boolean animation)

Update the point with the new values and options from the given point, specifying if the chart should be automatically redrawn and animated or not.

Parameters:

pointOptions - The point instance from which the new values and options will be retrieved.

redraw - Whether to redraw the chart after the point is updated. When updating more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the updating of points is finished.

animation - Defaults to true. When true, the graph will be animated with default animation options. Note, see the update(Point, boolean, Animation) method for more control over how the animation will run.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

update

public Point update(Point pointOptions,
                    boolean redraw,
                    Animation animation)

Update the point with the new values and options from the given point, specifying if the chart should be automatically redrawn and animated or not.

Parameters:

pointOptions - The point instance from which the new values and options will be retrieved.

redraw - Whether to redraw the chart after the point is updating. When updating more than one point, it is highly recommended that the redraw option be set to false, and instead BaseChart.redraw() is explicitly called after the updating of points is finished.

animation - The custom animation to use when updating the point in the series.

Returns:

A reference to this Point instance for convenient method chaining.

Since:

1.1.0

getNativePoint

public com.google.gwt.core.client.JavaScriptObject getNativePoint()

Returns a pointer to the native Highchart's JS point instance that this GWT Point instance is associated with. Note that this method will only return a non-null value if it is called on a Point instance that was retrieved from the chart after the chart has been rendered, such as via a PointEvent or Series.getPoints(). For advanced use-cases only.

Returns:

The native Highcharts JS point instance that this point is associated with, or null if the Point instance was not retrieved dynamically from a rendered chart.

Since:

1.4.0