Documentation

DropdownList

Type class

A dropdown control for StockToolbar.

Click here for more info

Sources

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

// Import DropdownList
import * as am5stock from "@amcharts/amcharts5/stock";

// Create DropdownList
am5stock.DropdownList.new(root, {
  // ... config if applicable
});

<!-- Load DropdownList -->
<script src="stock.js"></script>

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

Inheritance

DropdownList extends Dropdown.

DropdownList is not extended by any other symbol.

Settings

Set these settings on a DropdownList object using its set() and setAll() methods.

Read about settings concept.

control
#

Type StockControl

Inherited from IDropdownSettings
exclude
#

Type string[]

An array of item IDs to now show in the list.

@since 5.7.0

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via root.entitiesById.

Will raise error if an element with the same ID already exists.
items
#

Type IDropdownListItem[]

A list of items in the dropdown.
maxSearchItems
#

Type undefined | number

Maximum search items to show.
parent
#

Type HTMLElement

Inherited from IDropdownSettings
scrollable
#

Type undefined | false | true

Inherited from IDropdownSettings
searchCallback
#

Type undefined | ( query: string) => Promise

A callback function which returns a list of items based on a search query.
searchable
#

Type undefined | false | true

Is the list searchable? If true shows search field and calls searchCallback function for a list of items.
stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.
stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.
themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

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 Array

Inherited from IEntitySettings

A list of themes applied to the element.
userData
#

Type any

Inherited from IEntitySettings

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 DropdownList object using its getPrivate() method.

Read about private settings.

arrow
#

Read only

Type HTMLDivElement

Inherited from IDropdownPrivate
container
#

Read only

Type HTMLDivElement

Inherited from IDropdownPrivate
currentId
#

Read only

Type undefined | string

list
#

Read only

Type HTMLUListElement

search
#

Read only

Type HTMLDivElement

There are 2 inherited items currently hidden from this list.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity
className
#

Static

Type string

Default "DropdownList"
classNames
#

Static

Type Array

Default "DropdownList", "Dropdown", "Entity"
enableDispose
#

Type boolean

Default true

Inherited from Settings

If this is set to false then disposing does nothing, it's a no-op.
events
#

Type EventDispatcher

Default this._createEvents()

Inherited from Entity
root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity
template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.
There are 7 inherited items currently hidden from this list.

Methods

addItem(

info: IDropdownListItem

)

#

Returns void

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

has(

key: Key

)

#

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

hide()

#

Returns void

isAccessible()

#

Returns boolean

Inherited from Dropdown

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isOpen()

#

Returns boolean

Inherited from Dropdown

Returns true if dropdown is currently open.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

off(

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

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

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

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

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

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

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

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

rebuildList()

#

Returns void

Rebuilds the list.

Useful when changing item data within item list.

@since 5.7.0

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

show()

#

Returns void

Inherited from Dropdown

toggle()

#

Returns void

Inherited from Dropdown
There are 20 inherited items currently hidden from this list.

Events

Add event handlers to DropdownList object using its events.on() method.

Read about adding event handlers.

#changed

Param { item: IDropdownListItem,
  value: string | boolean,
  type: "changed",
  target: this }
#closed

Param { type: "closed",
  target: this }

Inherited from IDropdownEvents
#invoked

Param { item: IDropdownListItem,
  type: "invoked",
  target: this }
#opened

Param { type: "opened",
  target: this }

Inherited from IDropdownEvents
There are 2 inherited items currently hidden from this list.