Type class
A pattern that uses an SVG path.
@since 5.2.33
Click here for more info
Sources
PathPattern can be used (imported) via one of the following packages.
// Import PathPattern import * as am5 from "@amcharts/amcharts5"; // Create PathPattern am5.PathPattern.new(root, { // ... config if applicable });
<!-- Load PathPattern --> <script src="index.js"></script> <script> // Create PathPattern am5.PathPattern.new(root, { // ... config if applicable }); </script>
Inheritance
PathPattern extends Pattern
.
PathPattern is not extended by any other symbol.
Settings
Set these settings on a PathPattern object using its set()
and setAll()
methods.
Read about settings concept.
color # |
Type Inherited from Color of the pattern shape. Click here for more info |
---|---|
colorOpacity # |
Type Inherited from Opacity of the pattern shape. Click here for more info |
fill # |
Type Inherited from Color to fill gaps between pattern shapes. Click here for more info |
fillOpacity # |
Type Inherited from Opacity of the fill for gaps between pattern shapes. Click here for more info |
height # |
Type Inherited from Width of the pattern tile, in pixels. Click here for more info |
id # |
Type Inherited from A custom string ID for the element. If set, element can be looked up via Will raise error if an element with the same ID already exists. |
repetition # |
Type Inherited from How pattern tiles are repeated when filling the area. Click here for more info |
rotation # |
Type Default Inherited from Rotation of patterm in degrees. Supported values: -90 to 90. Click here for more info |
stateAnimationDuration # |
Type Inherited from Duration of transition from one state to another. |
stateAnimationEasing # |
Type Inherited from Easing of transition from one state to another. |
strokeDasharray # |
Type Inherited from Stroke (border or line) dash settings. Click here for more information |
strokeDashoffset # |
Type Inherited from Stroke (border or line) dash offset. Click here for more information |
strokeWidth # |
Type Default Inherited from Width of the pattern's line elements. |
svgPath # |
Type Use an SVG path as pattern. Click here for more information |
themeTags # |
Type Inherited from Tags which can be used by the theme rules. Click here for more info |
themeTagsSelf # |
Type Inherited from 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 Inherited from A list of themes applied to the element. |
userData # |
Type Inherited from A storage for any custom user data that needs to be associated with the element. |
width # |
Type Inherited from Width of the pattern tile, in pixels. Click here for more info |
There are 18 inherited items currently hidden from this list. |
Private settings
Properties
adapters # |
Type Default Inherited from |
---|---|
className # |
Static
Type Default |
classNames # |
Static
Type Default |
events # |
Type Default Inherited from |
pattern # |
Type Inherited from |
root # |
Type Inherited from An instance of @readonly |
states # |
Type Default Inherited from |
template # |
Type Inherited from @todo needs description |
uid # |
Type Default Inherited from Unique ID. |
There are 7 inherited items currently hidden from this list. |
Methods
animate( options: ) |
Returns Inherited from Animates setting values from current/start values to new ones. Click here for more info |
---|---|
dispose() |
Returns Inherited from Disposes this object. |
get( key: ) |
Returns Inherited from Returns settings value for the specified If there is no value, Click here for more info |
has( key: ) |
Returns Inherited from Returns Click here for more info |
isDisposed() |
Returns Inherited from Returns |
isType( type: ) |
Returns Inherited from Checks if element is of certain class (or inherits one). |
new( root: ) |
Static Returns Inherited from Use this method to create an instance of this class. Click here for more info |
off( key: ) |
Returns Inherited from Removes a callback for when value of a setting changes. Click here for more info |
offPrivate( key: ) |
Returns Inherited from Removes a callback for when value of a private setting changes. Click here for more info |
on( key: ) |
Returns Inherited from Sets a callback function to invoke when specific key of settings changes or is set. Click here for more info |
onPrivate( key: ) |
Returns Inherited from Sets a callback function to invoke when specific key of private settings changes or is set. Click here for more info |
remove( key: ) |
Returns Inherited from Removes a setting value for the specified Click here for more info |
removeAll() |
Returns Inherited from Removes all keys; Click here for more info |
set( key: ) |
Returns Inherited from Sets a setting Click here for more info |
setAll( settings: ) |
Returns Inherited from Sets multiple settings at once. Click here for more info |
setTimeout( fn: () => ) |
Returns Inherited from Creates and returns a "disposable" timeout. |
There are 16 inherited items currently hidden from this list. |
Events
PathPattern does not have any events.