Pattern

Type class

Base class to define patterns.

Sources

Pattern can be used (imported) via one of the following packages.

TypeScript

/**
 * Import from: "core.ts"
 * Use like: am4core.Pattern
 */
import * as am4core from "@amcharts/amcharts4/core";

JavaScript

/**
 * Include via: <script src="core.js"></script>
 * Access items like: am4core.Pattern
 */

Inheritance

Pattern extends BaseObject.

Pattern is extended by LinePattern, RectPattern, CirclePattern.

Properties

#backgroundFill

Type Color

Pattern background fill color.

#backgroundOpacity

Type number

Pattern backgorund opacity. (0-1)

#element

Type Group

An SVG <group> element to put sub-elements into.

#elements

Type List <AMElement>

Returns the list of SVG elements comprising the pattern.

#fill

Type Color

Fill color of the pattern.

#fillOpacity

Type number

Pattern fill opacity. (0-1)

#height

Type number

Pattern height in pixels.

#patternUnits

Type "userSpaceOnUse" | "objectBoundingBox"

Pattern measuring units.

Available options: "userSpaceOnUse" | "objectBoundingBox".

#rotation

Type number

Pattern rotation in degrees.

#shapeRendering

Type ShapeRendering

Shape rendering

#stroke

Type Color

Pattern stroke (border) color.

#strokeDasharray

Type string

A stroke-dasharray for the stroke (outline).

"Dasharray" allows setting rules to make lines dashed, dotted, etc.

More info: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray on stroke-dasharray

#strokeOpacity

Type number

Pattern stroke opacity. (0-1)

#strokeWidth

Type number

Pattern stroke thickness in pixels.

#width

Type number

Pattern width in pixels.

#x

Type number

X position. (pixels)

#y

Type number

Y position (px).

4 inherited items

#clonedFrom

Type $type.Optional <this>Inherited from BaseObject

Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.

#config

Type objectInherited from BaseObject

Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc.

Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.

#id

Type $type.Optional <string>Inherited from BaseObject

Sets the user-defined id of the element.

#uid

Type stringInherited from BaseObject

Returns object's internal unique ID.

Methods

#addElement(element: AMElement)

Returns void

Adds an element to the pattern.

#animate(animationOptions: IAnimationOptions[] | IAnimationOptions,
duration: number,
easing?: (value: number) => number)

Returns Animation

Animate pattern properties.

More info: Animation

#constructor()

Returns Pattern

Constructor

#copyFrom(source: this)

Returns void

Copies properties from another Pattern instance.

#removeElement(element: AMElement)

Returns void

Remove an element from the pattern.

4 inherited items

#clone(cloneId?: string)

Returns thisInherited from BaseObject

Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.

#dispose()

Returns voidInherited from BaseObject

Destroys this object and all related data.

#getCurrentThemes()

Returns ITheme[]Inherited from BaseObject

Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide.

#isDisposed()

Returns booleanInherited from BaseObject

Returns if this object has been already been disposed.

Events

Pattern does not have any events.