PeriodSelector – amCharts 5 Documentation

Type class

A pre-defined period selector control for StockToolback.

Sources

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

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

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

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

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

Inheritance

PeriodSelector extends StockControl.

PeriodSelector is not extended by any other symbol.

Settings

Set these settings on a PeriodSelector 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.
description #	Type `undefined` \| `string` Inherited from `IStockControlSettings` Description of what the button does.
forceHidden #	Type `undefined` \| `false` \| `true` Inherited from `IStockControlSettings` Force this control to always be invisible. @since 5.8.5 @defaul false
hideLongPeriods #	Type `undefined` \| `false` \| `true` Default `false` Hide periods that are longer than the actual data. @since 5.3.9
icon #	Type `HTMLElement` \| `SVGElement` \| `"none"` Inherited from `IStockControlSettings` An element with control icon. If not set, each control will aytomatically 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 `am5.registry.entitiesById`. Will raise error if an element with the same ID already exists.
name #	Type `undefined` \| `string` Inherited from `IStockControlSettings` Name of the control. Used for the label.
periods #	Type `IPeriod[]` A list periods to choose from.
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.
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?
zoomTo #	Type `"end"` \| `"start"` Default `"end"` Indicates whether to select periods from the start or end of the axis scale. @since 5.5.0 Click here for more info
There are 16 inherited items currently hidden from this list.

Private settings

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

Read about private settings.

button #	Read only Type `HTMLDivElement` Inherited from `IStockControlPrivate`
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 4 inherited items currently hidden from this list.

Properties

adapters #	Type `Adapters` Default `new Adapters(this)` Inherited from `Entity`
className #	Static Type `string` Default `"PeriodSelector"`
classNames #	Static Type `Array` Default `"PeriodSelector", "StockControl", "Entity"`
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 6 inherited items currently hidden from this list.

Methods

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` 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
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
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
selectPeriod( period: `IPeriod` ) #	Returns `void`
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 `StockControl`
There are 19 inherited items currently hidden from this list.

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

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

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

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

selectPeriod(

period: IPeriod

)

Returns void

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 StockControl

There are 19 inherited items currently hidden from this list.

Events

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

Read about adding event handlers.

#click	Param { originalEvent: `IPointerEvent`, type: `"click"`, target: `this` } Inherited from `IStockControlEvents`
#periodselected	Param { period: `IPeriod`, type: `"periodselected"`, target: `this` } Invoked when user selects certain period via control. @from 5.8.5
There is 1 inherited item currently hidden from this list.

#click

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

Inherited from IStockControlEvents

#periodselected

Param { period: IPeriod,
type: "periodselected",
target: this }

Invoked when user selects certain period via control.

@from 5.8.5

There is 1 inherited item currently hidden from this list.