IGrainPatternSettings

Type interface

Inheritance

IGrainPatternSettings extends IPatternSettings.

IGrainPatternSettings is not extended by any other symbol.

Properties

color
#

Type Color

Inherited from IPatternSettings

Color of the pattern shape.

Click here for more info

colorOpacity
#

Type undefined | number

Inherited from IPatternSettings

Opacity of the pattern shape.

Click here for more info

colors
#

Type Array

Default [color(0x000000)]

An array of colors to randomly use for pixels.

density
#

Type undefined | number

Default 1

Density of noise.

Value range: 0 (no noise applied) to 1 (noise is applied to every pixel).

The bigger the value, the higher chance that pixel will have another pixel painted over with random opacity from minOpacity to maxOpacity.

fill
#

Type Color

Inherited from IPatternSettings

Color to fill gaps between pattern shapes.

Click here for more info

fillOpacity
#

Type undefined | number

Inherited from IPatternSettings

Opacity of the fill for gaps between pattern shapes.

Click here for more info

height
#

Type undefined | number

Inherited from IPatternSettings

Width of the pattern tile, in pixels.

Click here for more info

horizontalGap
#

Type undefined | number

Default 0

Horizontal gap between noise pixels measured in size.

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.

maxOpacity
#

Type undefined | number

Default 0.3

Maximum opacity of a noise pixel.

minOpacity
#

Type undefined | number

Default 0

Minimum opacity of a noise pixel.

repetition
#

Type "repeat" | "repeat-x" | "repeat-y" | "no-repeat"

Inherited from IPatternSettings

How pattern tiles are repeated when filling the area.

Click here for more info

rotation
#

Type undefined | number

Default 0

Inherited from IPatternSettings

Rotation of patterm in degrees. Supported values: -90 to 90.

Click here for more info

size
#

Type undefined | number

Default 1

Size of a grain in pixels.

stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.

stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.

strokeDasharray
#

Type number[] | number

Inherited from IPatternSettings

Stroke (border or line) dash settings.

Click here for more information

strokeDashoffset
#

Type undefined | number

Inherited from IPatternSettings

Stroke (border or line) dash offset.

Click here for more information

strokeWidth
#

Type undefined | number

Default 1

Inherited from IPatternSettings

Width of the pattern's line elements.

themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.

userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.

verticalGap
#

Type undefined | number

Default 0

Vertical gap between noise pixels measured in size.

width
#

Type undefined | number

Inherited from IPatternSettings

Width of the pattern tile, in pixels.

Click here for more info

There are 18 inherited items currently hidden from this list.