Type class
A dropdown used for color picker control.
Should not be used as standalone control.
Sources
DropdownColors can be used (imported) via one of the following packages.
// Import DropdownColors import * as am5stock from "@amcharts/amcharts5/stock"; // Create DropdownColors am5stock.DropdownColors.new(root, { // ... config if applicable });
<!-- Load DropdownColors --> <script src="stock.js"></script> <script> // Create DropdownColors am5stock.DropdownColors.new(root, { // ... config if applicable }); </script>
Inheritance
DropdownColors extends Dropdown
.
DropdownColors is not extended by any other symbol.
Settings
Set these settings on a DropdownColors object using its set()
and setAll()
methods.
Read about settings concept.
colors # |
Type |
---|---|
control # |
Type Inherited from |
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. |
parent # |
Type Inherited from |
scrollable # |
Type Inherited from |
stateAnimationDuration # |
Type Inherited from Duration of transition from one state to another. |
stateAnimationEasing # |
Type Inherited from Easing of transition from one state to another. |
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. |
useOpacity # |
Type |
userData # |
Type Inherited from A storage for any custom user data that needs to be associated with the element. |
There are 10 inherited items currently hidden from this list. |
Private settings
These are read-only settings accessible from a DropdownColors object using its getPrivate()
method.
Read about private settings.
arrow # |
Read only
Type Inherited from |
---|---|
color # |
Read only
Type |
container # |
Read only
Type Inherited from |
list # |
Read only
Type |
opacity # |
Read only
Type |
There are 2 inherited items currently hidden from this list. |
Properties
adapters # |
Type Default Inherited from |
---|---|
className # |
Static
Type Default |
classNames # |
Static
Type Default |
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 6 inherited items currently hidden from this list. |
Methods
addItem( color: ) |
Returns |
---|---|
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 |
isOpen() |
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 |
toggle() |
Returns Inherited from |
There are 21 inherited items currently hidden from this list. |
Events
Add event handlers to DropdownColors object using its events.on()
method.
Read about adding event handlers.
#closed |
Param { type: Inherited from |
---|---|
#invoked |
Param { color: |
#invokedOpacity |
Param { opacity: |
#opened |
Param { type: Inherited from |
There are 2 inherited items currently hidden from this list. |