Documentation

IPicturePatternSettings

Type interface

Inheritance

IPicturePatternSettings extends IPatternSettings.

IPicturePatternSettings is not extended by any other symbol.

Properties

animations
#

Type Array

Inherited from IEntitySettings

Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it.

Each one animates a setting of the element (or, with target: "dataItem", a value of its data item - a map point's positionOnLine, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation.

sprite.set("animations", [
  { key: "rotation", to: 360, duration: 4000, loops: 0 },
  { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" }
]);

@since 5.20.8

canvas
#

Type HTMLCanvasElement

centered
#

Type undefined | false | true

Default true

Center images.
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

fill
#

Type Color

Inherited from IPatternSettings

Color to fill gaps between pattern shapes.

Click here for more info

fillOpacity
#

Type undefined | number

Default 1

Inherited from IPatternSettings

Opacity of the fill for gaps between pattern shapes.

Click here for more info

fit
#

Type "image" | "pattern" | "none"

Default "image"

How pattern should be sized:

  • "image" (default) - pattern will be sized to actual image dimensions.
  • "pattern" - image will be sized to pattern dimensions.
  • "none" - image will be placed in the pattern, regardless of either dimensions.
height
#

Type undefined | number

Default 50

Inherited from IPatternSettings

Height of the pattern tile, in pixels.

Click here for more info

id
#

Type undefined | string

Inherited from IEntitySettings

A unique ID for looking the element up in root.entitiesById. Setting an ID that another element already has throws an error.
ignoreThemes
#

Type undefined | false | true

Default false

Inherited from IEntitySettings

Ignores themes: no theme rule applies to the element, not even one of the default theme.

@since 5.15.6

repetition
#

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

Default "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 pattern in degrees. Supported values: -90 to 90.

Click here for more info

src
#

Type undefined | string

A source URI of the image.

Can be relative or absolute URL, or data-uri.
stateAnimationDuration
#

Type undefined | number

Default 0

Inherited from IEntitySettings

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.
stateAnimationEasing
#

Type $ease.Easing

Default out(cubic)

Inherited from IEntitySettings

Easing of the animated switch 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 that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags that theme rules can target, like themeTags, but only for this element, not its children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

Themes applied to the element and everything inside it.
userData
#

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.
width
#

Type undefined | number

Default 50

Inherited from IPatternSettings

Width of the pattern tile, in pixels.

Click here for more info

There are 20 inherited items currently hidden from this list.