TrianglePattern

Type class

Triangle pattern.

More info: Patterns

Sources

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

TypeScript

// Import TrianglePattern
import * as am5 from "@amcharts/amcharts5";

// Create TrianglePattern
am5.TrianglePattern.new(root, {
  // ... config if applicable
});

JavaScript

<!-- Load TrianglePattern -->
<script src="index.js"></script>

<script>
// Create TrianglePattern
am5.TrianglePattern.new(root, {
  // ... config if applicable
});
</script>

Inheritance

TrianglePattern extends Pattern.

TrianglePattern is not extended by any other symbol.

Settings

Set these settings on a TrianglePattern object using its set() and setAll() methods. Read about settings concept.

#centered

Type undefined | false | trueDefault true

Center triangles in their grid cell.

#checkered

Type undefined | false | trueDefault false

If set to true, will place every second triangle, creating a checkered pattern.

#gap

Type undefined | numberDefault 0

Gap between triangles, in pixels.

#maxHeight

Type undefined | numberDefault 8

Height of the triangle, in pixels.

#maxWidth

Type undefined | numberDefault 8

Width of the triangle, in pixels.

#rotateShapes

Type undefined | false | trueDefault false

If set to true, rotation rotates each triangle around its own center while the grid/tile stays axis-aligned, instead of rotating the whole pattern. This tiles seamlessly (a small width/height is enough) and is much faster than rotating the whole pattern on large tiles.

20 inherited items

#animations

Type ArrayInherited from IEntitySettingsSince 5.20.8

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" }
]);

#color

Type ColorInherited from IPatternSettings

Color of the pattern shape.

More info: Patterns: colors

#colorOpacity

Type undefined | numberInherited from IPatternSettings

Opacity of the pattern shape.

More info: Patterns: colors

#fill

Type ColorInherited from IPatternSettings

Color to fill gaps between pattern shapes.

More info: Patterns: colors

#fillOpacity

Type undefined | numberDefault 1Inherited from IPatternSettings

Opacity of the fill for gaps between pattern shapes.

More info: Patterns: colors

#height

Type undefined | numberDefault 50Inherited from IPatternSettings

Height of the pattern tile, in pixels.

More info: Patterns: sizing patterns

#id

Type undefined | stringInherited 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 | trueDefault falseInherited from IEntitySettingsSince 5.15.6

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

#repetition

Type "repeat" | "repeat-x" | "repeat-y" | "no-repeat"Default "repeat"Inherited from IPatternSettings

How pattern tiles are repeated when filling the area.

More info: Patterns: repetition

#rotation

Type undefined | numberDefault 0Inherited from IPatternSettings

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

More info: Patterns: rotation

#stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

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

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

#strokeDasharray

Type number[] | numberInherited from IPatternSettings

Stroke (border or line) dash settings.

More info: Colors, gradients, and patterns: dashed linesrmation

#strokeDashoffset

Type undefined | numberInherited from IPatternSettings

Stroke (border or line) dash offset.

More info: Colors, gradients, and patterns: dashed linesrmation

#strokeWidth

Type undefined | numberDefault 1Inherited from IPatternSettings

Width of the pattern's line elements.

#themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

#themeTags

Type ArrayInherited 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.

More info: Themes

#themeTagsSelf

Type ArrayInherited from IEntitySettings

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

More info: Themes

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.

#width

Type undefined | numberDefault 50Inherited from IPatternSettings

Width of the pattern tile, in pixels.

More info: Patterns: sizing patterns

Private settings

These are read-only settings accessible from a TrianglePattern object using its getPrivate() method. Read about private settings.

TrianglePattern does not have any private settings.

Properties

#className

StaticType stringDefault "TrianglePattern"

#classNames

StaticType ArrayDefault Pattern.classNames.concat([TrianglePattern.className])

8 inherited items

#adapters

Type AdaptersDefault new Adapters(this)Inherited from Entity

#enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

#events

Type EventDispatcherDefault this._createEvents()Inherited from Entity

#pattern

Type IPattern | undefined | nullInherited from Pattern

#root

Type RootInherited from EntitySince 5.0.6

The Root the object belongs to.

#states

Type StatesDefault new States(this)Inherited from Entity

#template

Type Template | undefinedInherited from Entity

A Template applied to the object. Its settings apply where the object has none set of its own.

#uid

Type numberDefault ++counterInherited from Settings

A unique number, given to each object as it is created.

Methods

22 inherited items

#animate(options: AnimationOptions)

Returns AnimationInherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

More info: Animations: animating settings

#dispose()

Returns voidInherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

#get(key: Key,
fallback: F)

Returns NonNullable | FInherited from Entity

Returns the value of setting key, run through any adapters, or fallback if it is not set.

More info: Settings

#has(key: Key)

Returns booleanInherited from Settings

Returns true if setting key is set.

More info: Settings

#isDisposed()

Returns booleanInherited from Settings

Returns true if the object has been disposed.

#isType(type: string)

Returns thisInherited from Entity

Returns true if the object is of class type or extends it.

#new(root: Root,
settings: ITSettings,
template?: Template)

StaticReturns TInherited from Entity

Creates an instance of the class. Use it instead of new Class().

More info: Getting started: new element syntax

#off(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with on(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebounced(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebouncedPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

More info: Events: settings value change

#on(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

More info: Events: settings value change

#once(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from SettingsSince 5.20.4

Like on(), but the callback is removed after it is called once.

More info: Events: settings value change

#onceDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from SettingsSince 5.20.4

Like onDebounced(), but the callback is removed after it is called once.

More info: Events: settings value change

#onDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#onPrivate(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of private setting key changes.

More info: Events: settings value change

#onPrivateDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#remove(key: Key)

Returns voidInherited from Entity

Removes the value set for setting key. The setting goes back to the value from a theme or template, if one has it.

More info: Settings

#removeAll()

Returns voidInherited from Settings

Removes all settings, as remove() does for each one.

More info: Settings

#set(key: Key,
value: Value)

Returns ValueInherited from Entity

Sets setting key to value and returns value. A value set this way overrides themes and templates, and stops any animation of the setting.

More info: Settings

#setAll(settings: Partial)

Returns voidInherited from Settings

Sets several settings at once, from an object of key-value pairs.

More info: Settings

#setTimeout(fn: () => void,
delay: number)

Returns IDisposerInherited from Entity

Calls fn after delay milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.

Events

TrianglePattern does not have any events.