IndicatorControl – amCharts 5 Documentation

Type class

A StockToolbar control for adding indicators to a StockChart.

Sources

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

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

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

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

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

Inheritance

IndicatorControl extends DropdownListControl.

IndicatorControl is not extended by any other symbol.

Settings

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

Read about settings concept.

active #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IStockControlSettings` Indicates if control is active.
align #	Type `"left"` \| `"right"` Default `"left"` Inherited from `IStockControlSettings` Alignment of the control in a toolbar.
currentItem #	Type `string` \| `IDropdownListItem` Inherited from `IDropdownListControlSettings` Currently selected item.
description #	Type `undefined` \| `string` Inherited from `IStockControlSettings` Description of what the button does.
exclude #	Type `string[]` Inherited from `IDropdownListControlSettings` An array of item IDs to not show in the list. @since 5.7.0
fixedLabel #	Type `undefined` \| `false` \| `true` Inherited from `IDropdownListControlSettings` Label does not change when item is selected in the list.
forceHidden #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IStockControlSettings` Force this control to always be invisible. @since 5.8.5
icon #	Type `HTMLElement` \| `SVGElement` \| `"none"` Inherited from `IStockControlSettings` An element with control icon. If not set, each control will automatically create an icon.
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.
ignoreThemes #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IEntitySettings` If set to `true` the themes will be ignored when applying settings. @since 5.15.6
indicators #	Type `Array`
items #	Type `Array` Inherited from `IDropdownListControlSettings` A list of items in the dropdown.
legend #	Type `StockLegend`
maxSearchItems #	Type `undefined` \| `number` Inherited from `IDropdownListControlSettings` Maximum search items to show.
name #	Type `undefined` \| `string` Inherited from `IStockControlSettings` Name of the control. Used for the label.
scrollable #	Type `undefined` \| `false` \| `true` Inherited from `IDropdownListControlSettings` If set to `true`, the dropdown will fix the height to fit within chart's area, with scroll if the contents do not fit.
searchCallback #	Type `undefined` \| ( query: `string`) => `IDropdownListItem[]` Inherited from `IDropdownListControlSettings` A callback function which returns a list of items based on a search query.
searchable #	Type `undefined` \| `false` \| `true` Inherited from `IDropdownListControlSettings` Is the list searchable? If `true` shows search field and calls `searchCallback` function for a list of items.
stateAnimationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IEntitySettings` Duration of transition from one state to another.
stateAnimationEasing #	Type `$ease.Easing` Default `out(cubic)` Inherited from `IEntitySettings` Easing of transition from one state to another.
stockChart #	Type `StockChart` Inherited from `IStockControlSettings` A `StockChart` the toolbar is for.
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.
togglable #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IStockControlSettings` If set to `true`, control can be toggle on and off by clicking on it.
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
visible #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IStockControlSettings` Is control visible?
There are 25 inherited items currently hidden from this list.

Private settings

These are read-only settings accessible from a IndicatorControl object using its getPrivate() method.

Read about private settings.

button #	Read only Type `HTMLDivElement` Inherited from `IStockControlPrivate`
dropdown #	Read only Type `DropdownList` Inherited from `IDropdownListControlPrivate`
icon #	Read only Type `HTMLElement` Inherited from `IStockControlPrivate`
label #	Read only Type `HTMLDivElement` Inherited from `IStockControlPrivate`
toolbar #	Read only Type `StockToolbar` Inherited from `IStockControlPrivate`
There are 5 inherited items currently hidden from this list.

Properties

adapters #	Type `Adapters` Default `new Adapters(this)` Inherited from `Entity`
className #	Static Type `string` Default `"IndicatorControl"`
classNames #	Static Type `Array` Default `"IndicatorControl", "DropdownListControl", "StockControl", "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

addIndicator( indicatorId: `Indicators` ) #	Returns `Indicator` \| `undefined` Creates a specific indicator, adds it to chart, and returns the instance.
animate( options: `AnimationOptions` ) #	Returns `Animation` Inherited from `Settings` Animates setting values from current/start values to new ones. Click here for more info
clearIndicators() #	Returns `void` Removes all indicators from the stock chart. @since 5.9.3
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
getItemById( id: `string` ) #	Returns `IDropdownListItem` \| `string` \| `undefined` Inherited from `DropdownListControl` Returns list item by ID. @since 5.9.0
has( key: `Key` ) #	Returns `boolean` Inherited from `Settings` Returns `true` if the setting exists. Click here for more info
hide() #	Returns `void` Inherited from `StockControl`
isAccessible() #	Returns `boolean` Inherited from `StockControl`
isDisposed() #	Returns `boolean` Inherited from `Settings` Returns `true` if this element is disposed.
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
offDebounced( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a debounced callback for when value of a setting changes. Click here for more info
offDebouncedPrivate( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a debounced callback for when value of a private setting changes. Click here for more info
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
onDebounced( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void`, debounceDelay: `number` ) #	Returns `IDisposer` Inherited from `Settings` Sets a debounced callback function to invoke when specific key of settings changes or is set. The callback fires only once even if the setting is changed multiple times within the debounce delay. 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
onPrivateDebounced( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void`, debounceDelay: `number` ) #	Returns `IDisposer` Inherited from `Settings` Sets a debounced callback function to invoke when specific key of private settings changes or is set. The callback fires only once even if the setting is changed multiple times within the debounce delay. Click here for more info
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
serializeIndicators( output: `"object"` \| `"string"`, indent?: `undefined` \| `string` ) #	Returns `Array` \| `string` Serializes all available indicators into an array of simple objects or JSON. `output` parameter can either be `"object"` or `"string"` (default). Click here for more info @since 5.3.0
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
setItem( item: `string` \| `IDropdownListItem` ) #	Returns `void` Inherited from `DropdownListControl`
setItemById( id: `string` ) #	Returns `void` Inherited from `DropdownListControl` Selects an item by its id. @since 5.9.0
setTimeout( fn: () => `void`, delay: `number` ) #	Returns `IDisposer` Inherited from `Entity` Creates and returns a "disposable" timeout.
show() #	Returns `void` Inherited from `StockControl`
supportsIndicator( indicatorId: `Indicators` ) #	Returns `boolean` Returns `true` if the indicator is supported in current chart setup.
unserializeIndicators( data: `string` \| `Array` ) #	Returns `void` Parses data serialized with `serializeIndicators()` and adds indicators to the chart. Click here for more info @since 5.3.0
There are 26 inherited items currently hidden from this list.

addIndicator(

indicatorId: Indicators

)

Returns Indicator | undefined

Creates a specific indicator, adds it to chart, and returns the instance.

animate(

options: AnimationOptions

)

Returns Animation

Inherited from Settings

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

Click here for more info

clearIndicators()

Returns void

Removes all indicators from the stock chart.

@since 5.9.3

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

getItemById(

id: string

)

Returns IDropdownListItem | string | undefined

Inherited from DropdownListControl

Returns list item by ID.

@since 5.9.0

has(

key: Key

)

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

hide()

Returns void

Inherited from StockControl

isAccessible()

Returns boolean

Inherited from StockControl

isDisposed()

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

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

offDebounced(

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

)

Returns void

Inherited from Settings

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

Click here for more info

offDebouncedPrivate(

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

)

Returns void

Inherited from Settings

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

Click here for more info

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

onDebounced(

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

)

Returns IDisposer

Inherited from Settings

Sets a debounced callback function to invoke when specific key of settings changes or is set. The callback fires only once even if the setting is changed multiple times within the debounce delay.

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

onPrivateDebounced(

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

)

Returns IDisposer

Inherited from Settings

Sets a debounced callback function to invoke when specific key of private settings changes or is set. The callback fires only once even if the setting is changed multiple times within the debounce delay.

Click here for more info

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

serializeIndicators(

output: "object" | "string",
indent?: undefined | string

)

Returns Array | string

Serializes all available indicators into an array of simple objects or JSON.

output parameter can either be "object" or "string" (default).

Click here for more info
@since 5.3.0

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

setItem(

item: string | IDropdownListItem

)

Returns void

Inherited from DropdownListControl

setItemById(

id: string

)

Returns void

Inherited from DropdownListControl

Selects an item by its id.

@since 5.9.0

setTimeout(

fn: () => void,
delay: number

)

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

show()

Returns void

Inherited from StockControl

supportsIndicator(

indicatorId: Indicators

)

Returns boolean

Returns true if the indicator is supported in current chart setup.

unserializeIndicators(

data: string | Array

)

Returns void

Parses data serialized with serializeIndicators() and adds indicators to the chart.

Click here for more info
@since 5.3.0

There are 26 inherited items currently hidden from this list.

Events

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

Read about adding event handlers.

#click	Param { originalEvent: `IPointerEvent`, type: `"click"`, target: `this` } Inherited from `IStockControlEvents`
#selected	Param { indicator: `Indicator` \| `IIndicator`, item: `string` \| `IDropdownListItem`, type: `"selected"`, target: `this` }
There is 1 inherited item currently hidden from this list.

#click

Param { originalEvent: IPointerEvent,
type: "click",
target: this }

Inherited from IStockControlEvents

#selected

Param { indicator: Indicator | IIndicator,
  item: string | IDropdownListItem,
  type: "selected",
  target: this }

There is 1 inherited item currently hidden from this list.