Skip to main content
Version: v26

TimeFrameItem

Interface

Definition of visible timeframes that can be selected at the bottom of the chart

Example

{ text: "3y", resolution: "1W", description: "3 Years", title: "3yr" }

Properties

description

Optional

Optional text displayed in the pop-up menu. If not set, title wil be used instead.

Type

string


resolution

Resolution to be set

Type

ResolutionString


text

Defines the range to be set for the given resolution. It has the <integer><y|m|d> ( \d+(y|m|d) as Regex ) format.

Type

string


title

Optional

Optional text representing the time frame. If not set a generated string will be set based on text property.

Type

string