Class Point

    • Constructor Detail

      • Point

        public Point()
        Default constructor
      • Point

        public Point​(Number y)
        Constructs with a number
      • Point

        public Point​(Number x,
                     Number y)
        Constructs with a pair number (x, y)
      • Point

        public Point​(String name,
                     Number y)
        Constructs with a name and number
        Parameters:
        name -
        y -
      • Point

        public Point​(String name,
                     Number y,
                     Number x)
        Constructs with a name, Y number, and X index
        Parameters:
        name -
        y -
        x -
        Since:
        1.1
      • Point

        public Point​(String name,
                     Number y,
                     String drilldown)
        Constructs with a name, number, and the id of the drilldown data
        Parameters:
        name -
        y -
        drilldown -
      • Point

        public Point​(Number x,
                     Number low,
                     Number high)
        Constructs with three numbers, x, low, and high.
      • Point

        public Point​(String from,
                     String to)
        Constructs with from and to. Suitable for networkgraph.
        Since:
        7.2.1.0
      • Point

        public Point​(String from,
                     String to,
                     Number weight)
        Constructs with from, to and weight. Suitable for sankey.
        Since:
        7.2.1.0
      • Point

        public Point​(String id,
                     String parent,
                     String name)
        Constructs with id, parent and name. Suitable for treegraph.
        Since:
        11.2.0.0
    • Method Detail

      • ofXYZ

        public static Point ofXYZ​(Number x,
                                  Number y,
                                  Number z)
        Constructs with three numbers, x, y, and z.
        Returns:
        a new Point
        Since:
        7.2.1.2
      • ofLow

        public static Point ofLow​(String name,
                                  Number low)
        Constructs with name and low value.
        Since:
        10.2.1.0
      • ofLowHigh

        public static Point ofLowHigh​(String name,
                                      Number low,
                                      Number high)
        Constructs with name, low, and high value.
        Since:
        10.2.1.0
      • of

        public static <T> Point of​(T... any)
        Returns a point with an array like data structure.
        Since:
        10.2.1.0
      • ofMap

        public static <T> Point ofMap​(Map<String,​T> map)
        Returns a point with a given map data structure.

        Note: each of the key is not a dynamical attribute, so it won't trigger a change event.

        Since:
        10.2.1.0
      • getDataLabels

        public DataLabels getDataLabels()
        Returns the first or single option of data labels.
      • getAccessibility

        public PointAccessibility getAccessibility()
        Returns an accessibility options for a data point, if null, it will create new one.
        Since:
        10.2.1.0
      • setAccessibility

        public void setAccessibility​(PointAccessibility accessibility)
        Sets an accessibility options for a data point.
        Since:
        10.2.1.0
      • setDataLabels

        public void setDataLabels​(DataLabels dataLabels)
        Sets the first or single option of data labels.
        See Also:
        DataLabels
      • getDataLabelsList

        public List<DataLabels> getDataLabelsList()
        Returns the list of options of data labels.
        Since:
        7.2.2.0
      • setDataLabels

        public void setDataLabels​(List<DataLabels> dataLabels)
        Sets the list of options of data labels.
        Since:
        7.2.2.0
        See Also:
        DataLabels
      • addDataLabels

        public void addDataLabels​(DataLabels dataLabels)
        Add an option of data labels to the list.
        Since:
        7.2.2.0
        See Also:
        DataLabels
      • getDashStyle

        public String getDashStyle()
        Returns a name for the dash style to use for the graph, or for some series types the outline of each shape.

        Default: "Solid"

        Since:
        7.2.1.0
      • setDashStyle

        public void setDashStyle​(String dashStyle)
        Sets a name for the dash style to use for the graph, or for some series types the outline of each shape.
        Since:
        7.2.1.0
      • getDescription

        public String getDescription()
        Returns the description. This description will be shown in tooltip.

        Default: null

        Since:
        7.2.1.0
      • setDescription

        public void setDescription​(String description)
        Sets the description. This description will be shown in tooltip.
        Since:
        7.2.1.0
      • getDirection

        public Number getDirection()
        Returns the vector direction in degrees, where 0 is north (pointing towards south).

        Default: null

        Since:
        7.2.1.0
      • setDirection

        public void setDirection​(Number direction)
        Sets the vector direction in degrees, where 0 is north (pointing towards south).
        Since:
        7.2.1.0
      • getDragDrop

        public DragDrop getDragDrop()
        Returns the options of point specific options for the draggable-points module, if any. Otherwise, create a new one.
        Since:
        7.2.1.0
      • setDragDrop

        public void setDragDrop​(DragDrop dragDrop)
        Sets the options of point specific options for the draggable-points module.
        Since:
        7.2.1.0
      • isVisible

        public boolean isVisible()
        Returns whether the series is visible or not.

        Default: true

      • setVisible

        public void setVisible​(boolean visible)
        Sets whether the serries is visible.
      • setLow

        public void setLow​(Number low)
        Sets the low number, if any.
      • getLow

        public Number getLow()
        Returns the low number, if any.

        Default: null

      • setHigh

        public void setHigh​(Number high)
        Sets the high number, if any.
      • getHigh

        public Number getHigh()
        Returns the high number, if any.

        Default: null

      • setDial

        public void setDial​(GaugeDialPlotOptions dial)
        Sets the dial data for gauge chart type only.
      • setDrilldown

        public void setDrilldown​(boolean enable)
        Sets to enable the drilldown.
      • setDrilldown

        public void setDrilldown​(String seriesId)
        Sets the id of the drilldown data.
      • getDrilldown

        public String getDrilldown()
        Returns the id of drilldown

        Default: null

      • getColor

        public Color getColor()
        Returns individual color for the point. By default the color is pulled from the global colors array.

        Default: null.

      • setColor

        public void setColor​(Color color)
        Sets individual color for the point. By default the color is pulled from the global colors array.
      • setColor

        public void setColor​(String color)
        Sets individual color for the point. By default the color is pulled from the global colors array.
      • setColor

        public void setColor​(LinearGradient color)
        Sets individual color for the point. By default the color is pulled from the global colors array.
      • setColor

        public void setColor​(RadialGradient color)
        Sets individual color for the point. By default the color is pulled from the global colors array.
      • getColorIndex

        public Number getColorIndex()
        Returns the specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}.

        Default: null

        Since:
        7.2.2.0
      • setColorIndex

        public void setColorIndex​(Number colorIndex)
        Sets the specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}.
        Since:
        7.2.2.0
      • getFrom

        public String getFrom()
        Returns the node that the link runs from.

        Default: null

        Since:
        7.2.1.0
      • setFrom

        public void setFrom​(String from)
        Sets the node that the link runs from.
        Since:
        7.2.1.0
      • getId

        public String getId()
        Returns an id for the point.

        Default: null.

      • setId

        public void setId​(String id)
        Sets an id for the point.
      • getInnerRadius

        public Object getInnerRadius()
        Returns the inner radius for points in a solid gauge. Can be given as a number (pixels) or percentage string.

        Default: 60

        Since:
        7.2.1.0
      • setInnerRadius

        public void setInnerRadius​(Number innerRadius)
        Sets the inner radius for points in a solid gauge. Can be given as a number (pixels).
        Since:
        7.2.1.0
      • setInnerRadius

        public void setInnerRadius​(String innerRadius)
        Sets the inner radius for points in a solid gauge. Can be given as a percentage string.
        Since:
        7.2.1.0
      • isIntermediateSum

        public boolean isIntermediateSum()
        Returns waterfall series only. Whether to acts as a summary column for the values added or subtracted since the last intermediate sum.

        Default: false.

      • setIntermediateSum

        public void setIntermediateSum​(boolean sum)
        Sets waterfall series only. Whether to acts as a summary column for the values added or subtracted since the last intermediate sum.
      • getLabel

        public String getLabel()
        Returns the label.

        Default: null

        Since:
        7.2.1.0
      • setLabel

        public void setLabel​(String label)
        Sets the label.
        Since:
        7.2.1.0
      • getLabelrank

        public Number getLabelrank()
        Returns the rank for this point's data label in case of collision. If two data labels are about to overlap, only the one with the highest labelrank will be drawn.

        Default: null

        Since:
        7.2.1.0
      • setLabelrank

        public void setLabelrank​(Number labelrank)
        Sets the rank for this point's data label in case of collision. If two data labels are about to overlap, only the one with the highest labelrank will be drawn.
        Since:
        7.2.1.0
      • getLength

        public Number getLength()
        Returns the length of the vector. The rendered length will relate to the vectorLength setting.

        Default: null

        Since:
        7.2.1.0
      • setLength

        public void setLength​(Number length)
        Sets the length of the vector. The rendered length will relate to the vectorLength setting.
        Since:
        7.2.1.0
      • isSum

        public boolean isSum()
        Returns waterfall series only. Whether to display the total sum across the entire series.

        Default: false.

      • setSum

        public void setSum​(boolean sum)
        Sets waterfall series only. Whether to display the total sum across the entire series.
      • getLegendIndex

        public int getLegendIndex()
        Returns pies only. The sequential index of the pie slice in the legend.

        Default: 0.

      • setLegendIndex

        public void setLegendIndex​(int legendIndex)
        Sets pies only. The sequential index of the pie slice in the legend.
      • getMarker

        public Marker getMarker()
        Returns the data marker

        Default: null.

      • setMarker

        public void setMarker​(Marker marker)
        Sets the data marker
      • getName

        public String getName()
        Returns the name of the point as shown in the legend, tooltip, dataLabel etc.

        Default: null.

      • setName

        public void setName​(String name)
        Sets the name of the point as shown in the legend, tooltip, dataLabel etc.
      • isOutgoing

        public boolean isOutgoing()
        Returns whether the link goes out of the system.

        Default: false

        Since:
        7.2.1.0
      • setOutgoing

        public void setOutgoing​(boolean outgoing)
        Set whether the link goes out of the system.
        Since:
        7.2.1.0
      • getPartialFill

        public XRangePartialFill getPartialFill()
        Returns a partial fill for each point, if any. Otherwise, create a new one. Typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.
        Since:
        7.2.1.0
      • setPartialFill

        public void setPartialFill​(XRangePartialFill partialFill)
        Sets a partial fill for each point. Typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.
        Since:
        7.2.1.0
      • setPartialFill

        public void setPartialFill​(Number amount)
        Sets a partial fill with an amount for each point. Typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.
        Since:
        7.2.1.0
      • getRadius

        public Object getRadius()
        Returns the outer radius for points in a solid gauge. Can be given as a number (pixels) or percentage string.

        Default: 100

        Since:
        7.2.1.0
      • setRadius

        public void setRadius​(Number radius)
        Sets the outer radius for points in a solid gauge. Can be given as a number (pixels).
        Since:
        7.2.1.0
      • setRadius

        public void setRadius​(String radius)
        Sets the outer radius for points in a solid gauge. Can be given as a percentage string.
        Since:
        7.2.1.0
      • isSelected

        public boolean isSelected()
        Returns whether the point is selected or not.

        Default: false.

      • setSelected

        public void setSelected​(boolean selected)
        Sets whether the point is selected or not.
      • setSelectedDirectly

        public void setSelectedDirectly​(boolean selected)
        Sets whether the point is selected or not.
      • getSets

        public Set<String> getSets()
        Returns the set or sets the options will be applied to, if any. Otherwise, create a new one. If a single entry is defined, then it will create a new set. If more than one entry is defined, then it will define the overlap between the sets in the array.
        Since:
        7.2.1.0
      • setSets

        public void setSets​(Set<String> sets)
        Sets the set or sets the options will be applied to. If a single entry is defined, then it will create a new set. If more than one entry is defined, then it will define the overlap between the sets in the array.
        Since:
        7.2.1.0
      • setSets

        public void setSets​(String... sets)
        Sets the set or sets the options will be applied to. If a single entry is defined, then it will create a new set. If more than one entry is defined, then it will define the overlap between the sets in the array.
        Since:
        7.2.1.0
      • isSliced

        public boolean isSliced()
        Returns pie series only. Whether to display a slice offset from the center.

        Default: false.

      • setSliced

        public void setSliced​(boolean sliced)
        Sets pie series only. Whether to display a slice offset from the center.
      • setSlicedDirectly

        public void setSlicedDirectly​(boolean sliced)
        Sets pie series only. Whether to display a slice offset from the center.
      • getTarget

        public Number getTarget()
        Returns the target value of a point.

        Default: null

        Since:
        7.2.1.0
      • setTarget

        public void setTarget​(Number target)
        Sets the target value of a point.
        Since:
        7.2.1.0
      • getTargetOptions

        public TargetOptions getTargetOptions()
        Returns individual target options for each point, if any. Otherwise, create a new one.
        Since:
        7.2.1.0
      • setTargetOptions

        public void setTargetOptions​(TargetOptions targetOptions)
        Sets individual target options for each point.
        Since:
        7.2.1.0
      • getTo

        public String getTo()
        Returns the node that the link runs to.

        Default: null

        Since:
        7.2.1.0
      • setTo

        public void setTo​(String to)
        Sets the node that the link runs to.
        Since:
        7.2.1.0
      • getWeight

        public Number getWeight()
        Returns the weight of the link.

        Default: null

        Since:
        7.2.1.0
      • setWeight

        public void setWeight​(Number weight)
        Sets the weight of the link.
        Since:
        7.2.1.0
      • getWidth

        public Number getWidth()
        Returns the width of the point.

        Default: null

        Since:
        7.2.1.0
      • setWidth

        public void setWidth​(Number width)
        Sets the width of the point.
        Since:
        7.2.1.0
      • getPointWidth

        public Number getPointWidth()
        Returns pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.

        Default: null

        Since:
        7.2.2.0
      • setPointWidth

        public void setPointWidth​(Number pointWidth)
        Sets pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
        Since:
        7.2.2.0
      • getX

        public Number getX()
        Returns the x value of the point.

        Default: null.

      • setX

        public void setX​(Number x)
        Sets the x value of the point.
      • getX2

        public Number getX2()
        Returns the x2 value of the point.

        Default: null.

        Since:
        7.2.1.0
      • setX2

        public void setX2​(Number x2)
        Sets the x2 value of the point.
        Since:
        7.2.1.0
      • getY

        public Number getY()
        Returns the y value of the point.

        Default: null.

      • setY

        public void setY​(Number y)
        Sets the y value of the point.
      • getZ

        public Number getZ()
        Returns the z value of the point.

        Default: null.

        Since:
        7.2.1.0
      • setZ

        public void setZ​(Number z)
        Sets the z value of the point.
        Since:
        7.2.1.0
      • remove

        public void remove()
        Removes the point from the series
      • select

        public void select()
        Toggle select or unselect the point.
      • select

        public void select​(boolean select,
                           boolean accumulate)
        Select or unselect the point.
        Parameters:
        select - when true, the point is selected. When false, the point is unselected.
        accumulate - when true, the selection is added to other selected points. When false, other selected points are deselected. Selected points are accumulated on Control, Shift or Cmd clicking the point.
      • slice

        public void slice()
        Pie series only. Slice out or set back in a pie chart slice.
      • slice

        public void slice​(boolean sliced)
        Pie series only. Slice out or set back in a pie chart slice.
      • update

        public void update​(Number x,
                           Number low,
                           Number high)
        Updates with the given values, x, low, and high.
        Parameters:
        x -
        low -
        high -
      • update

        public void update​(Number x,
                           Number y)
        Updates with the given values, x, and y.
        Parameters:
        x -
        y -
      • update

        public void update​(Number value)
        Updates with the given new value.
      • update

        public void update​(String from,
                           String to)
        Updates with the given values, from and to.
        Since:
        7.2.1.0
      • update

        public void update​(String from,
                           String to,
                           Number weight)
        Updates with the given values, from, to and weight.
        Since:
        7.2.1.0
      • update

        public void update​(String name,
                           Number weight)
        Updates with the given values, name and weight.
        Since:
        7.2.1.0
      • getValue

        public Number getValue()
        Get the "value" value of this point
        Returns:
        value or null if not set
        Since:
        2.1.0
      • setValue

        public void setValue​(Number number)
        Set the "value" value. As some plots use value instead of y.
        Parameters:
        number -
        Since:
        2.1.0
      • getParent

        public String getParent()
        Get the parent point of this point. Only valid for tree maps.
        Returns:
        parent id or null if not set
        Since:
        2.1.0
      • setParent

        public void setParent​(String parent)
        Set the parent point of this point. Only valid for tree maps.
        Parameters:
        parent - id of parent point
        Since:
        2.1.0
      • getColorValue

        public Number getColorValue()
        Get the color value of this point. Only valid for plots with color axis.
        Returns:
        the color value or null if not set
        Since:
        2.1.0
      • setColorValue

        public void setColorValue​(Number colorValue)
        Set the color value for this point. Only valid for plots with color axis.
        Parameters:
        colorValue -
        Since:
        2.1.0
      • getQ1

        public Number getQ1()
        Get the Q1 (first quartile) value of this point. Only valid for box plot.
        Returns:
        the Q1 value or null if not set
        Since:
        2.1.0
      • setQ1

        public void setQ1​(Number q1)
        Set the Q1 (first quartile) value for this point. Only valid for box plot.
        Parameters:
        q1 - the first quartile value or null if not set
        Since:
        2.1.0
      • getMedian

        public Number getMedian()
        Get the median value of this point. Only valid for box plot.
        Returns:
        the median value or null if not set
        Since:
        2.1.0
      • setMedian

        public void setMedian​(Number median)
        Set the median value for this point. Only valid for box plot.
        Parameters:
        median - the median value
        Since:
        2.1.0
      • getQ3

        public Number getQ3()
        Get the Q3 (third quartile) of this point. Only valid for box plot.
        Returns:
        the Q3 value or null if not set
        Since:
        2.1.0
      • setQ3

        public void setQ3​(Number q3)
        Set the Q3 (third quartile) value for this point. Only valid for box plot.
        Parameters:
        q3 - the third quartile value
        Since:
        2.1.0