IntervalControl

Type class

A dropdown control for picking the data interval of a StockChart, such as 1 day or 1 week. Applying the picked interval is up to a selected event handler.

Sources

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

TypeScript

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

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

JavaScript

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

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

Inheritance

IntervalControl extends DropdownListControl.

IntervalControl is not extended by any other symbol.

Settings

Set these settings on a IntervalControl object using its set() and setAll() methods. Read about settings concept.

#currentItem

Type string | IIntervalControlItem

#items

Type Array

24 inherited items

#active

Type undefined | false | trueDefault falseInherited 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 ArrayInherited from IEntitySettingsSince 5.20.8

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" }
]);

#description

Type undefined | stringInherited from IStockControlSettings

What the control does, shown as the button's tooltip. Falls back to name.

#exclude

Type string[]Inherited from IDropdownListControlSettingsSince 5.7.0

IDs of items to leave out of the list.

#fixedLabel

Type undefined | false | trueInherited from IDropdownListControlSettings

Keeps the button's label and icon when an item is picked, instead of showing that item.

#forceHidden

Type undefined | false | trueDefault falseInherited from IStockControlSettingsSince 5.8.5

Keeps the control hidden, even when show() is called.

#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 | stringInherited 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 | trueDefault falseInherited from IEntitySettingsSince 5.15.6

Ignores themes: no theme rule applies to the element, not even one of the default theme.

#maxSearchItems

Type undefined | numberInherited from IDropdownListControlSettings

Most results of searchCallback to show; the rest are cut off with a note.

#name

Type undefined | stringInherited from IStockControlSettings

Label text of the control's button.

#scrollable

Type undefined | false | trueInherited from IDropdownListControlSettings

Limits the list's height to the chart's height minus 100 pixels, scrolling the rest.

#searchable

Type undefined | false | trueInherited from IDropdownListControlSettings

Shows a search field above the list. Typing filters the items or, with searchCallback, replaces them with its results.

#searchCallback

Type undefined | (query: string) => IDropdownListItem[]Inherited from IDropdownListControlSettings

Returns the items to show for a search query.

#stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

#stockChart

Type StockChartInherited from IStockControlSettings

The StockChart the control acts on.

#themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

#themeTags

Type ArrayInherited 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.

More info: Themes

#themeTagsSelf

Type ArrayInherited from IEntitySettings

Tags that theme rules can target, like themeTags, but only for this element, not its children.

More info: Themes

#togglable

Type undefined | false | trueDefault trueInherited from IStockControlSettings

A click on the button toggles active.

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.

#visible

Type undefined | false | trueDefault trueInherited from IStockControlSettings

Shows the control's button; false hides it.

Private settings

These are read-only settings accessible from a IntervalControl object using its getPrivate() method. Read about private settings.

5 inherited items

#button

Read onlyType HTMLDivElementInherited from IStockControlPrivate

#dropdown

Read onlyType DropdownListInherited from IDropdownListControlPrivate

#icon

Read onlyType HTMLElementInherited from IStockControlPrivate

#label

Read onlyType HTMLDivElementInherited from IStockControlPrivate

#toolbar

Read onlyType StockToolbarInherited from IStockControlPrivate

Properties

#className

StaticType stringDefault "IntervalControl"

#classNames

StaticType ArrayDefault DropdownListControl.classNames.concat([IntervalControl.className])

7 inherited items

#adapters

Type AdaptersDefault new Adapters(this)Inherited from Entity

#enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

#events

Type EventDispatcherDefault this._createEvents()Inherited from Entity

#root

Type RootInherited from EntitySince 5.0.6

The Root the object belongs to.

#states

Type StatesDefault new States(this)Inherited from Entity

#template

Type Template | undefinedInherited from Entity

A Template applied to the object. Its settings apply where the object has none set of its own.

#uid

Type numberDefault ++counterInherited from Settings

A unique number, given to each object as it is created.

Methods

28 inherited items

#animate(options: AnimationOptions)

Returns AnimationInherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

More info: Animations: animating settings

#dispose()

Returns voidInherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

#get(key: Key,
fallback: F)

Returns NonNullable | FInherited from Entity

Returns the value of setting key, run through any adapters, or fallback if it is not set.

More info: Settings

#getItemById(id: string)

Returns IDropdownListItem | string | undefinedInherited from DropdownListControlSince 5.9.0

Returns the item with an ID from items.

#has(key: Key)

Returns booleanInherited from Settings

Returns true if setting key is set.

More info: Settings

#hide()

Returns voidInherited from StockControl

Hides the control's button.

#isAccessible()

Returns booleanInherited from StockControl

#isDisposed()

Returns booleanInherited from Settings

Returns true if the object has been disposed.

#isType(type: string)

Returns thisInherited from Entity

Returns true if the object is of class type or extends it.

#new(root: Root,
settings: ITSettings,
template?: Template)

StaticReturns TInherited from Entity

Creates an instance of the class. Use it instead of new Class().

More info: Getting started: new element syntax

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

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with on(). Without callback, removes all of them for key.

More info: Events: settings value change

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

Returns voidInherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

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

Returns voidInherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

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

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

More info: Events: settings value change

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

Returns IDisposerInherited from SettingsSince 5.20.4

Like on(), but the callback is removed after it is called once.

More info: Events: settings value change

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

Returns IDisposerInherited from SettingsSince 5.20.4

Like onDebounced(), but the callback is removed after it is called once.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Calls callback each time the value of private setting key changes.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#remove(key: Key)

Returns voidInherited from Entity

Removes the value set for setting key. The setting goes back to the value from a theme or template, if one has it.

More info: Settings

#removeAll()

Returns voidInherited from Settings

Removes all settings, as remove() does for each one.

More info: Settings

#set(key: Key,
value: Value)

Returns ValueInherited from Entity

Sets setting key to value and returns value. A value set this way overrides themes and templates, and stops any animation of the setting.

More info: Settings

#setAll(settings: Partial)

Returns voidInherited from Settings

Sets several settings at once, from an object of key-value pairs.

More info: Settings

#setItem(item: string | IDropdownListItem)

Returns voidInherited from DropdownListControl

Shows an item on the button as the selected one, unless fixedLabel is set. Does not dispatch selected.

#setItemById(id: string)

Returns voidInherited from DropdownListControlSince 5.9.0

Selects an item by its ID: shows it on the button and dispatches selected.

#setTimeout(fn: () => void,
delay: number)

Returns IDisposerInherited from Entity

Calls fn after delay milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.

#show()

Returns voidInherited from StockControl

Shows the control's button, unless forceHidden is set.

Events

Add event handlers to IntervalControl object using its events.on() method. Read about adding event handlers.

2 inherited items

#click

Param { type: "click", target: IntervalControl, originalEvent: IPointerEvent }Inherited from IStockControlEvents

The control's button was clicked.

#selected

Param { type: "selected", target: IntervalControl, item: string | IDropdownListItem }Inherited from IDropdownListControlEvents

An item was picked from the list, or selected with setItemById().