IDropdownListControlSettings – amCharts 5 Documentation

Type interface

Inheritance

IDropdownListControlSettings extends IStockControlSettings.

IDropdownListControlSettings is extended by IIndicatorControlSettings, ISeriesTypeControlSettings, IIntervalControlSettings, IDataSaveControlSettings, ISettingsControlSettings, IComparisonControlSettings.

Properties

active #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IStockControlSettings` Turns the control on; its button shows as active.
align #	Type `"left"` \| `"right"` Default `"left"` Inherited from `IStockControlSettings` Side of the toolbar the control is placed on.
animations #	Type `Array` Inherited from `IEntitySettings` 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" } ]); @since 5.20.8
currentItem #	Type `string` \| `IDropdownListItem` Item (or its ID) shown as selected when the control is created. It is not updated when another item is picked.
description #	Type `undefined` \| `string` Inherited from `IStockControlSettings` What the control does, shown as the button's tooltip. Falls back to `name`.
exclude #	Type `string[]` IDs of items to leave out of the list. @since 5.7.0
fixedLabel #	Type `undefined` \| `false` \| `true` Keeps the button's label and icon when an item is picked, instead of showing that item.
forceHidden #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IStockControlSettings` Keeps the control hidden, even when `show()` is called. @since 5.8.5
icon #	Type `HTMLElement` \| `SVGElement` \| `"none"` Inherited from `IStockControlSettings` Icon element of the button, or `"none"` for no icon. Each control has its own default icon.
id #	Type `undefined` \| `string` Inherited 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` \| `true` Default `false` Inherited from `IEntitySettings` Ignores themes: no theme rule applies to the element, not even one of the default theme. @since 5.15.6
items #	Type `Array` Items of the dropdown: strings, or objects with an `id` and a `label`.
maxSearchItems #	Type `undefined` \| `number` Most results of `searchCallback` to show; the rest are cut off with a note.
name #	Type `undefined` \| `string` Inherited from `IStockControlSettings` Label text of the control's button.
scrollable #	Type `undefined` \| `false` \| `true` Limits the list's height to the chart's height minus 100 pixels, scrolling the rest.
searchCallback #	Type `undefined` \| ( query: `string`) => `IDropdownListItem[]` Returns the items to show for a search query.
searchable #	Type `undefined` \| `false` \| `true` Shows a search field above the list. Typing filters the items or, with `searchCallback`, replaces them with its results.
stateAnimationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IEntitySettings` How long, in milliseconds, a switch from one state to another animates. `0` switches at once.
stateAnimationEasing #	Type `$ease.Easing` Default `out(cubic)` Inherited from `IEntitySettings` Easing of the animated switch from one state to another.
stockChart #	Type `StockChart` Inherited from `IStockControlSettings` The `StockChart` the control acts on.
themeTags #	Type `Array` Inherited 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. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target, like `themeTags`, but only for this element, not its children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` Themes applied to the element and everything inside it.
togglable #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IStockControlSettings` A click on the button toggles `active`.
userData #	Type `any` Inherited from `IEntitySettings` Any data of your own to keep with the element.
visible #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IStockControlSettings` Shows the control's button; `false` hides it.
There are 18 inherited items currently hidden from this list.