Documentation

PatternSet

Type class

Defines an interable list of distinctive patterns that can be used in conjunction to colors to generate various fill patterns.

@since 4.7.5
Click here for color-related info

Sources

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

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


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

Inheritance

PatternSet extends BaseObject.

PatternSet is not extended by any other symbol.

Properties

baseColor
#

Type Color

Default new Color({
  
r: 103,
  
g: 183,
  
b: 220

})

A base color. If there are no colors pre-set in the color list, ColorSet will use this color as a base when generating new ones, applying stepOptions and passOptions to this base color.
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.
currentStep
#

Type number

Sets current color iteration. You can use this property to skip some colors from iteration. E.g. setting it to 10 will skip first ten colors.

Please note that the number is zero-based.
id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.
list
#

Type Pattern[]

List of pre-defined patterns to be used in set.
startIndex
#

Type number

Default 0

If set to non-zero value, the ColorSet will start iterating colors from that particular index, not the first color in the list.
uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.
There are 4 inherited items currently hidden from this list.

Methods

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 PatternSet

Constructor

copyFrom(

object: this

)

#

Returns void

Inherited from BaseObject

Copies all properties and related data from different element.

dispose()

#

Returns void

Inherited from BaseObject

Destroys this object and all related data.

getCirclePattern(

size: number,
radius: number,
outline: boolean

)

#

Returns CirclePattern

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.

getIndex(

i: number

)

#

Returns Pattern

Returns a color at specific index in the list.

getLinePattern(

size: number,
rotation: number,
thickness: number,
gap?: number,
strokeDashArray?: string

)

#

Returns LinePattern

getRectPattern(

size: number,
rotation: number,
thickness: number,
outline?: boolean

)

#

Returns RectPattern

isDisposed()

#

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

next()

#

Returns Pattern

Returns the next pattern in list.

reset()

#

Returns void

Resets internal iterator.

Calling next() after this will return the very first color in the color list, even if it was already returned before.
There are 5 inherited items currently hidden from this list.

Events

PatternSet does not have any events.

Adapters

PatternSet does not have any adapters.