public class PatternOptions extends BaseOption
Maps to the Highcharts.PatternOptionsObject data type.
Example: chart.style
ref: https://api.highcharts.com/class-reference/Highcharts.PatternOptionsObject
Modifier and Type | Field and Description |
---|---|
static PatternOptions |
NULL |
Constructor and Description |
---|
PatternOptions() |
Modifier and Type | Method and Description |
---|---|
Number |
getAspectRatio()
For automatically calculated width and height on images, it is possible to set an aspect ratio.
|
Color |
getBackgroundColor()
Background color for the pattern if a path is set (not images).
|
Color |
getColor()
Pattern color, used as default path stroke.
|
Number |
getHeight()
Analogous to pattern.width.
|
String |
getId()
ID to assign to the pattern.
|
String |
getImage()
URL to an image to use as the pattern.
|
Number |
getOpacity()
Opacity of the pattern as a float value from 0 to 1.
|
SVGAttributes |
getPathAsObject()
Either an SVG path as string, or an object.
|
String |
getPathAsString()
Either an SVG path as string, or an object.
|
String |
getPatternTransform()
SVG patternTransform to apply to the entire pattern.
|
Number |
getWidth()
Width of the pattern.
|
Number |
getX()
Horizontal offset of the pattern.
|
Number |
getY()
Vertical offset of the pattern.
|
PatternOptions |
setAspectRatio(Number aspectRatio)
For automatically calculated width and height on images, it is possible to set an aspect ratio.
|
PatternOptions |
setBackgroundColor(Color backgroundColor)
Background color for the pattern if a path is set (not images).
|
PatternOptions |
setColor(Color color)
Pattern color, used as default path stroke.
|
PatternOptions |
setHeight(Number height)
Analogous to pattern.width.
|
PatternOptions |
setId(String id)
ID to assign to the pattern.
|
PatternOptions |
setImage(String image)
URL to an image to use as the pattern.
|
PatternOptions |
setOpacity(Number opacity)
Opacity of the pattern as a float value from 0 to 1.
|
PatternOptions |
setPath(String pathAsString)
Either an SVG path as string, or an object.
|
PatternOptions |
setPath(SVGAttributes pathAsObject)
Either an SVG path as string, or an object.
|
PatternOptions |
setPatternTransform(String patternTransform)
SVG patternTransform to apply to the entire pattern.
|
PatternOptions |
setWidth(Number width)
Width of the pattern.
|
PatternOptions |
setX(Number x)
Horizontal offset of the pattern.
|
PatternOptions |
setY(Number y)
Vertical offset of the pattern.
|
set_hcNulledOption
public static final PatternOptions NULL
public Number getAspectRatio()
public PatternOptions setAspectRatio(Number aspectRatio)
aspectRatio
- the value for the aspectRatio optionpublic Color getBackgroundColor()
public PatternOptions setBackgroundColor(Color backgroundColor)
backgroundColor
- the value for the backgroundColor optionpublic Color getColor()
public PatternOptions setColor(Color color)
color
- the value for the color optionpublic Number getHeight()
public PatternOptions setHeight(Number height)
height
- the value for the height optionpublic String getId()
public PatternOptions setId(String id)
id
- the value for the id optionpublic String getImage()
public PatternOptions setImage(String image)
image
- the value for the image optionpublic Number getOpacity()
public PatternOptions setOpacity(Number opacity)
opacity
- the value for the opacity optionpublic SVGAttributes getPathAsObject()
public PatternOptions setPath(SVGAttributes pathAsObject)
pathAsObject
- the value for the pathAsObject optionpublic String getPathAsString()
public PatternOptions setPath(String pathAsString)
pathAsString
- the value for the pathAsString optionpublic String getPatternTransform()
public PatternOptions setPatternTransform(String patternTransform)
patternTransform
- the value for the patternTransform optionpublic Number getWidth()
public PatternOptions setWidth(Number width)
width
- the value for the width optionpublic Number getX()
public PatternOptions setX(Number x)
x
- the value for the x optionpublic Number getY()
public PatternOptions setY(Number y)
y
- the value for the y optionCopyright © 2023. All rights reserved.