IDateRangeSelectorSettings

Type interface

Inheritance

IDateRangeSelectorSettings extends IStockControlSettings.

IDateRangeSelectorSettings is not extended by any other symbol.

Properties

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.

dateFormat
#

Type undefined | string

Date format to use for date input fields.

Will use global date format if not set.

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

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.

maxDate
#

Type Date | "auto" | null

Default "auto"

Maximum date to allow for selection.

Accepts either a Date object or "auto" (latest date available in chart).

@since 5.3.7

minDate
#

Type Date | "auto" | null

Default "auto"

Minimum date to allow for selection.

Accepts either a Date object or "auto" (smallest date available in chart).

@since 5.3.7

name
#

Type undefined | string

Inherited from IStockControlSettings

Name of the control. Used for the label.

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.

useDefaultCSS
#

Type undefined | false | true

Default true

If set to false the control will not load default CSS for Flatpickr component. This would mean it would be unstyled, and would require custom CSS present on the page.

@since 5.2.4

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 16 inherited items currently hidden from this list.