RectPattern

Type class

Rectangular pattern

Sources

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

TypeScript

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

JavaScript

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

Inheritance

RectPattern extends Pattern.

RectPattern is not extended by any other symbol.

Properties

#rectHeight

Type number

Rectangle height in pixels.

#rectWidth

Type number

Rectangle width in pixels.

21 inherited items

#backgroundFill

Type ColorInherited from Pattern

Pattern background fill color.

#backgroundOpacity

Type numberInherited from Pattern

Pattern backgorund opacity. (0-1)

#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.

#element

Type GroupInherited from Pattern

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

#elements

Type List <AMElement>Inherited from Pattern

Returns the list of SVG elements comprising the pattern.

#fill

Type ColorInherited from Pattern

Fill color of the pattern.

#fillOpacity

Type numberInherited from Pattern

Pattern fill opacity. (0-1)

#height

Type numberInherited from Pattern

Pattern height in pixels.

#id

Type $type.Optional <string>Inherited from BaseObject

Sets the user-defined id of the element.

#patternUnits

Type "userSpaceOnUse" | "objectBoundingBox"Inherited from Pattern

Pattern measuring units.

Available options: "userSpaceOnUse" | "objectBoundingBox".

#rotation

Type numberInherited from Pattern

Pattern rotation in degrees.

#shapeRendering

Type ShapeRenderingInherited from Pattern

Shape rendering

#stroke

Type ColorInherited from Pattern

Pattern stroke (border) color.

#strokeDasharray

Type stringInherited from Pattern

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 numberInherited from Pattern

Pattern stroke opacity. (0-1)

#strokeWidth

Type numberInherited from Pattern

Pattern stroke thickness in pixels.

#uid

Type stringInherited from BaseObject

Returns object's internal unique ID.

#width

Type numberInherited from Pattern

Pattern width in pixels.

#x

Type numberInherited from Pattern

X position. (pixels)

#y

Type numberInherited from Pattern

Y position (px).

Methods

#constructor()

Returns RectPattern

Constructor

8 inherited items

#addElement(element: AMElement)

Returns voidInherited from Pattern

Adds an element to the pattern.

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

Returns AnimationInherited from Pattern

Animate pattern properties.

More info: Animation

#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.

#copyFrom(source: this)

Returns voidInherited from Pattern

Copies properties from another Pattern instance.

#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.

#removeElement(element: AMElement)

Returns voidInherited from Pattern

Remove an element from the pattern.

Events

RectPattern does not have any events.