Type class
Reset control.
Removes all drawings and indicators when clicked.
Click here for more info
Sources
ResetControl can be used (imported) via one of the following packages.
// Import ResetControl import * as am5stock from "@amcharts/amcharts5/stock"; // Create ResetControl am5stock.ResetControl.new(root, { // ... config if applicable });
<!-- Load ResetControl --> <script src="stock.js"></script> <script> // Create ResetControl am5stock.ResetControl.new(root, { // ... config if applicable }); </script>
Inheritance
ResetControl extends StockControl
.
ResetControl is not extended by any other symbol.
Settings
Set these settings on a ResetControl object using its set()
and setAll()
methods.
Read about settings concept.
active # |
Type Default Inherited from Indicates if control is active. |
---|---|
align # |
Type Default Inherited from Alignment of the control in a toolbar. |
description # |
Type Inherited from Description of what the button does. |
forceHidden # |
Type Inherited from Force this control to always be invisible. @since 5.8.5 |
icon # |
Type Inherited from An element with control icon. If not set, each control will aytomatically create an icon. |
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. |
name # |
Type Inherited from Name of the control. Used for the label. |
stateAnimationDuration # |
Type Inherited from Duration of transition from one state to another. |
stateAnimationEasing # |
Type Inherited from Easing of transition from one state to another. |
stockChart # |
Type Inherited from A |
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. |
togglable # |
Type Default Inherited from If set to |
userData # |
Type Inherited from A storage for any custom user data that needs to be associated with the element. |
visible # |
Type Default Inherited from Is control visible? |
There are 16 inherited items currently hidden from this list. |
Private settings
These are read-only settings accessible from a ResetControl object using its getPrivate()
method.
Read about private settings.
button # |
Read only
Type Inherited from |
---|---|
icon # |
Read only
Type Inherited from |
label # |
Read only
Type Inherited from |
toolbar # |
Read only
Type Inherited from |
There are 4 inherited items currently hidden from this list. |
Properties
adapters # |
Type Default Inherited from |
---|---|
className # |
Static
Type Default |
classNames # |
Static
Type Default |
enableDispose # |
Type Default Inherited from If this is set to |
events # |
Type Default 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 |
hide() |
Returns Inherited from |
isAccessible() |
Returns Inherited from |
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. |
show() |
Returns Inherited from |
There are 19 inherited items currently hidden from this list. |
Events
Add event handlers to ResetControl object using its events.on()
method.
Read about adding event handlers.
#click |
Param { originalEvent: Inherited from |
---|---|
There is 1 inherited item currently hidden from this list. |