Documentation

RectPattern

Type class

Rectangular pattern

Sources

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

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


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

Inheritance

RectPattern extends Pattern.

RectPattern is not extended by any other symbol.

Properties

backgroundFill
#

Type Color

Inherited from Pattern

Pattern background fill color.
backgroundOpacity
#

Type number

Inherited 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 object

Inherited 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 Group

Inherited 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 Color

Inherited from Pattern

Fill color of the pattern.
fillOpacity
#

Type number

Inherited from Pattern

Pattern fill opacity. (0-1)
height
#

Type number

Inherited 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".
rectHeight
#

Type number

Rectangle height in pixels.
rectWidth
#

Type number

Rectangle width in pixels.
rotation
#

Type number

Inherited from Pattern

Pattern rotation in degrees.
shapeRendering
#

Type ShapeRendering

Inherited from Pattern

Shape rendering
stroke
#

Type Color

Inherited from Pattern

Pattern stroke (border) color.
strokeDasharray
#

Type string

Inherited from Pattern

A stroke-dasharray for the stroke (outline).

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

Click here for more info on stroke-dasharray

strokeOpacity
#

Type number

Inherited from Pattern

Pattern stroke opacity. (0-1)
strokeWidth
#

Type number

Inherited from Pattern

Pattern stroke thickness in pixels.
uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.
width
#

Type number

Inherited from Pattern

Pattern width in pixels.
x
#

Type number

Inherited from Pattern

X position. (pixels)
y
#

Type number

Inherited from Pattern

Y position (px).
There are 21 inherited items currently hidden from this list.

Methods

addElement(

element: AMElement

)

#

Returns void

Inherited from Pattern

Adds an element to the pattern.

animate(

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

)

#

Returns Animation

Inherited from Pattern

Animate pattern properties.

Animation

clone(

cloneId?: string

)

#

Returns this

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

constructor()

#

Returns RectPattern

Constructor

copyFrom(

source: this

)

#

Returns void

Inherited from Pattern

Copies properties from another Pattern instance.

dispose()

#

Returns void

Inherited 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 boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

removeElement(

element: AMElement

)

#

Returns void

Inherited from Pattern

Remove an element from the pattern.
There are 8 inherited items currently hidden from this list.

Events

RectPattern does not have any events.

Adapters

RectPattern does not have any adapters.