com.highsoft.highcharts.common.hichartsclasses

Class HIShapes

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIShapes

public class HIShapes
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIShapes()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDashStyle()
HIColor	getFill()
java.lang.Number	getHeight()
java.lang.String	getMarkerEnd()
java.lang.String	getMarkerStart()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIAnnotationMockPointOptionsObject	getPoint()
java.util.ArrayList<HIAnnotationMockPointOptionsObject>	getPoints()
java.lang.Number	getR()
java.lang.Number	getRy()
java.lang.Number	getSnap()
java.lang.String	getSrc()
HIColor	getStroke()
java.lang.Number	getStrokeWidth()
java.lang.String	getType()
java.lang.Number	getWidth()
java.lang.Number	getXAxis()
java.lang.Number	getYAxis()
void	setDashStyle(java.lang.String dashStyle) Name of the dash style to use for the shape's stroke.
void	setFill(HIColor fill) The color of the shape's fill.
void	setHeight(java.lang.Number height) The height of the shape.
void	setMarkerEnd(java.lang.String markerEnd) Id of the marker which will be drawn at the final vertex of the path.
void	setMarkerStart(java.lang.String markerStart) Id of the marker which will be drawn at the first vertex of the path.
void	setPoint(HIAnnotationMockPointOptionsObject point) This option defines the point to which the shape will be connected.
void	setPoints(java.util.ArrayList<HIAnnotationMockPointOptionsObject> points) An array of points for the shape or a callback function that returns that shape point.
void	setR(java.lang.Number r) The radius of the shape.
void	setRy(java.lang.Number ry) The radius of the shape in y direction.
void	setSnap(java.lang.Number snap) Defines additional snapping area around an annotation making this annotation to focus.
void	setSrc(java.lang.String src) /** * description: The URL for an image to use as the annotation shape.
void	setStroke(HIColor stroke) The color of the shape's stroke.
void	setStrokeWidth(java.lang.Number strokeWidth) The pixel stroke width of the shape.
void	setType(java.lang.String type) The type of the shape.
void	setWidth(java.lang.Number width) The width of the shape.
void	setXAxis(java.lang.Number xAxis) The xAxis index to which the points should be attached.
void	setYAxis(java.lang.Number yAxis) The yAxis index to which the points should be attached.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

HIShapes

public HIShapes()

Method Detail

getDashStyle

public java.lang.String getDashStyle()

getFill

public HIColor getFill()

getHeight

public java.lang.Number getHeight()

getMarkerEnd

public java.lang.String getMarkerEnd()

getMarkerStart

public java.lang.String getMarkerStart()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

getPoint

public HIAnnotationMockPointOptionsObject getPoint()

getPoints

public java.util.ArrayList<HIAnnotationMockPointOptionsObject> getPoints()

getR

public java.lang.Number getR()

getRy

public java.lang.Number getRy()

getSnap

public java.lang.Number getSnap()

getSrc

public java.lang.String getSrc()

getStroke

public HIColor getStroke()

getStrokeWidth

public java.lang.Number getStrokeWidth()

getType

public java.lang.String getType()

getWidth

public java.lang.Number getWidth()

getXAxis

public java.lang.Number getXAxis()

getYAxis

public java.lang.Number getYAxis()

setDashStyle

public void setDashStyle(java.lang.String dashStyle)

Name of the dash style to use for the shape's stroke.

setFill

public void setFill(HIColor fill)

The color of the shape's fill.

defaults:

 rgba(0, 0, 0, 0.75)

setHeight

public void setHeight(java.lang.Number height)

The height of the shape.

setMarkerEnd

public void setMarkerEnd(java.lang.String markerEnd)

Id of the marker which will be drawn at the final vertex of the path. Custom markers can be defined in defs property.

setMarkerStart

public void setMarkerStart(java.lang.String markerStart)

Id of the marker which will be drawn at the first vertex of the path. Custom markers can be defined in defs property.

setPoint

public void setPoint(HIAnnotationMockPointOptionsObject point)

This option defines the point to which the shape will be connected. It can be either the point which exists in the series - it is referenced by the point's id - or a new point with defined x, y properties and optionally axes.

setPoints

public void setPoints(java.util.ArrayList<HIAnnotationMockPointOptionsObject> points)

An array of points for the shape or a callback function that returns that shape point. This option is available for shapes which can use multiple points such as path. A point can be either a point object or a point's id.

setR

public void setR(java.lang.Number r)

The radius of the shape.

setRy

public void setRy(java.lang.Number ry)

The radius of the shape in y direction. Used for the ellipse.

setSnap

public void setSnap(java.lang.Number snap)

Defines additional snapping area around an annotation making this annotation to focus. Defined in pixels.

defaults:

 2

setSrc

public void setSrc(java.lang.String src)

/** * description: The URL for an image to use as the annotation shape. Note, type has to be set to `'image'`. * demo: * [Define a marker image url for annotations](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/annotations/shape-src/)

setStroke

public void setStroke(HIColor stroke)

The color of the shape's stroke.

defaults:

 rgba(0, 0, 0, 0.75)

setStrokeWidth

public void setStrokeWidth(java.lang.Number strokeWidth)

The pixel stroke width of the shape.

defaults:

 1

setType

public void setType(java.lang.String type)

The type of the shape. Available options are circle, rect and ellipse.

defaults:

 rect

setWidth

public void setWidth(java.lang.Number width)

The width of the shape.

setXAxis

public void setXAxis(java.lang.Number xAxis)

The xAxis index to which the points should be attached. Used for the ellipse.

setYAxis

public void setYAxis(java.lang.Number yAxis)

The yAxis index to which the points should be attached. Used for the ellipse.