com.highsoft.highcharts.common.hichartsclasses

Class HIPatternOptionsObject

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPatternOptionsObject

public class HIPatternOptionsObject
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPatternOptionsObject()

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getAspectRatio()
java.lang.String	getBackgroundColor()
java.lang.String	getColor()
java.lang.Number	getHeight()
java.lang.String	getId()
java.lang.String	getImage()
java.lang.Number	getOpacity()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HISVGAttributes	getPath()
java.lang.String	getPatternTransform()
java.lang.Number	getWidth()
java.lang.Number	getX()
java.lang.Number	getY()
void	setAspectRatio(java.lang.Number aspectRatio) For automatically calculated width and height on images, it is possible to set an aspect ratio.
void	setBackgroundColor(java.lang.String backgroundColor) Background color for the pattern if a `path` is set (not images).
void	setColor(java.lang.String color) Pattern color, used as defaults path stroke.
void	setHeight(java.lang.Number height) Analogous to pattern.width.
void	setId(java.lang.String id) ID to assign to the pattern.
void	setImage(java.lang.String image) URL to an image to use as the pattern.
void	setOpacity(java.lang.Number opacity) Opacity of the pattern as a float value from 0 to 1.
void	setPath(HISVGAttributes path) Either an SVG path as string, or an object.
void	setPatternTransform(java.lang.String patternTransform) SVG `patternTransform` to apply to the entire pattern.
void	setWidth(java.lang.Number width) Width of the pattern.
void	setX(java.lang.Number x) Horizontal offset of the pattern.
void	setY(java.lang.Number y) Vertical offset of the pattern.

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

HIPatternOptionsObject

public HIPatternOptionsObject()

Method Detail

getAspectRatio

public java.lang.Number getAspectRatio()

getBackgroundColor

public java.lang.String getBackgroundColor()

getColor

public java.lang.String getColor()

getHeight

public java.lang.Number getHeight()

getId

public java.lang.String getId()

getImage

public java.lang.String getImage()

getOpacity

public java.lang.Number getOpacity()

getParams

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

Specified by:

getParams in class HIFoundation

getPath

public HISVGAttributes getPath()

getPatternTransform

public java.lang.String getPatternTransform()

getWidth

public java.lang.Number getWidth()

getX

public java.lang.Number getX()

getY

public java.lang.Number getY()

setAspectRatio

public void setAspectRatio(java.lang.Number aspectRatio)

For automatically calculated width and height on images, it is possible to set an aspect ratio. The image will be zoomed to fill the bounding box, maintaining the aspect ratio defined.

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

Background color for the pattern if a `path` is set (not images).

setColor

public void setColor(java.lang.String color)

Pattern color, used as defaults path stroke.

setHeight

public void setHeight(java.lang.Number height)

Analogous to pattern.width.

setId

public void setId(java.lang.String id)

ID to assign to the pattern. This is automatically computed if not added, and identical patterns are reused. To refer to an existing pattern for a Highcharts color, use `color: "url(#pattern-id)"`.

setImage

public void setImage(java.lang.String image)

URL to an image to use as the pattern.

setOpacity

public void setOpacity(java.lang.Number opacity)

Opacity of the pattern as a float value from 0 to 1.

setPath

public void setPath(HISVGAttributes path)

Either an SVG path as string, or an object. As an object, supply the path string in the `path.d` property. Other supported properties are standard SVG attributes like `path.stroke` and `path.fill`. If a path is supplied for the pattern, the `image` property is ignored.

setPatternTransform

public void setPatternTransform(java.lang.String patternTransform)

SVG `patternTransform` to apply to the entire pattern.

setWidth

public void setWidth(java.lang.Number width)

Width of the pattern. For images this is automatically set to the width of the element bounding box if not supplied. For non-image patterns the defaults is 32px. Note that automatic resizing of image patterns to fill a bounding box dynamically is only supported for patterns with an automatically calculated ID.

setX

public void setX(java.lang.Number x)

Horizontal offset of the pattern. Defaults to 0.

setY

public void setY(java.lang.Number y)

Vertical offset of the pattern. Defaults to 0.