HCPatternOptionsObject class

Pattern options

Implemented types

Constructors

HCPatternOptionsObject({bool? anchorToPoint, num? aspectRatio, String? backgroundColor, String? color, num? height, String? id, String? image, num? opacity, dynamic path, String? patternTransform, num? width, num? x, num? y})
const

Properties

anchorToPoint → bool?
When true, the pattern is anchored to each individual point rather than using a global pattern grid. This ensures consistent pattern rendering across points of different sizes and improves accessibility for narrow columns. Defaults to false for backward compatibility.
final
aspectRatio → num?
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.
final
backgroundColor → String?
Background color for the pattern if a path is set (not images).
final
color → String?
Pattern color, used as default path stroke.
final
hashCode → int
The hash code for this object.
no setterinherited
height → num?
Analogous to pattern.width.
final
id → String?
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)".
final
image → String?
URL to an image to use as the pattern.
final
opacity → num?
Opacity of the pattern as a float value from 0 to 1.
final
path → dynamic
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.
final
patternTransform → String?
SVG patternTransform to apply to the entire pattern.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
width → num?
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 default is 32px. Note that automatic resizing of image patterns to fill a bounding box dynamically is only supported for patterns with an automatically calc
final
x → num?
Horizontal offset of the pattern.
final
y → num?
Vertical offset of the pattern.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited