`Global names`

Built-in variables and functions that are not inside a namespace: the bar's prices, the script declaration, plots and the core helpers.

#Functions

#`barcolor`function

Colours the chart candles on each bar (na: the chart's own colour). When several scripts colour the same candle, the last one added wins.

barcolor(color: color, { offset?: input int = 0, editable?: const bool = true, show_last?: const int = na, title?: const string = "", display?: input display = display.all })

Parameter	Type	Description
`color`	`color`	The colour.
`offset`	`input int`default `0`	Shift the output this many bars to the right (negative: left).
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`display`	`input display`default `display.all`	Where the value is shown (display.*).

Example

ChartScriptFragmentOpen in editor

barcolor(close > ta.sma(close, 20) ? color.up : na)

Since ChartScript 1

#`bgcolor`function

Colours the pane background on each bar (na: no colour).

bgcolor(color: color, { offset?: input int = 0, editable?: const bool = true, show_last?: const int = na, title?: const string = "", display?: input display = display.all, force_overlay?: const bool = false, format?: const format = na, precision?: const int = na })

Parameter	Type	Description
`color`	`color`	The colour.
`offset`	`input int`default `0`	Shift the output this many bars to the right (negative: left).
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`force_overlay`	`const bool`default `false`	Accepted and ignored in this version.
`format`	`const format`default `na`	Accepted for compatibility with imported scripts (a background has no values to format).
`precision`	`const int`default `na`	Accepted for compatibility with imported scripts (a background has no values to format).

Example

ChartScriptFragmentOpen in editor

bgcolor(close > open ? color.new(color.up, 90) : na)

Since ChartScript 1

#`bool`function

Converts to bool: na and 0 are false.

bool(x: T): bool

Parameter	Type	Description
`x`	`T`	The value.

Returns bool.

Example

ChartScriptFragmentOpen in editor

const b = bool(volume)

Since ChartScript 1

#`dayofmonth`function

The day of the month of the bar open (UTC). The dayofmonth of a time in a time zone.

dayofmonth(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = dayofmonth(time, "UTC")

Since ChartScript 1

#`fill`function

Fills between two plots or two hlines; the gradient form colours each bar from top_color at top_value to bottom_color at bottom_value.

fill(hline1: hline, hline2: hline, { color?: color = na, title?: const string = "", editable?: const bool = true, fillgaps?: const bool = false, display?: input display = display.all, role?: const string = "", look?: const string = "", variant?: const string = "" })

fill(plot1: plot, plot2: plot, { color?: color = na, title?: const string = "", editable?: const bool = true, show_last?: const int = na, fillgaps?: const bool = false, display?: input display = display.all, role?: const string = "", look?: const string = "", variant?: const string = "" })

fill(plot1: plot, plot2: plot, top_value: float, bottom_value: float, top_color: color, bottom_color: color, { title?: const string = "", display?: input display = display.all, fillgaps?: const bool = false, editable?: const bool = true, role?: const string = "", look?: const string = "", variant?: const string = "" })

Parameter	Type	Description
`hline1`	`hline`	The first hline.
`hline2`	`hline`	The second hline.
`color`	`color`default `na`	The colour.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`fillgaps`	`const bool`default `false`	Accepted and ignored.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`role`	`const string`default `""`	What the color of this output means, for the color presets of the Colors tab: "up", "down", "neutral" or "accent". Empty = guessed from the role of its style (look), the theme color, the title and the hue (a teal line counts as up). Another value is error CS2014.
`look`	`const string`default `""`	A style made with style.plot / style.line / style.marker / style.fill (its look, shared and user-editable).
`variant`	`const string`default `""`	The name of one of the style's variants (style.variant).
`plot1`	`plot`	The first plot.
`plot2`	`plot`	The second plot.
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`top_value`	`float`	The value of the top colour.
`bottom_value`	`float`	The value of the bottom colour.
`top_color`	`color`	The colour at top_value.
`bottom_color`	`color`	The colour at bottom_value.

Example

ChartScriptFragmentOpen in editor

const a = plot(high)
const b = plot(low)
fill(a, b, color.new(color.accent, 80))

Since ChartScript 1

#`fixnan`function

The value, or the last value that was not na.

fixnan(source: T): T

Parameter	Type	Description
`source`	`T`	The series to read.

Returns T.

Example

ChartScriptFragmentOpen in editor

const pv = fixnan(ta.pivothigh(high, 5, 5))

Since ChartScript 1

#`float`function

Converts to float; also types an na.

float(x: num): float

Parameter	Type	Description
`x`	`num`	The value.

Returns float.

Example

ChartScriptFragmentOpen in editor

const f = float(na)

Since ChartScript 1

#`hour`function

The hour of the bar open (UTC). The hour of a time in a time zone.

hour(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = hour(time, "UTC")

Since ChartScript 1

#`indicator`function

Declares the script as an indicator: its name, pane and number format.

indicator(title: const string, { shorttitle?: const string = "", overlay?: const bool = false, format?: const format = format.inherit, precision?: const int = na, scale?: const scale = na, max_bars_back?: const int = 500, timeframe?: const string = "", timeframe_gaps?: const bool = true, explicit_plot_zorder?: const bool = false, max_lines_count?: const int = 50, max_labels_count?: const int = 50, max_boxes_count?: const int = 50, max_polylines_count?: const int = 50, dynamic_requests?: const bool = true, behind_chart?: const bool = false, calc_bars_count?: const int = na })

Parameter	Type	Description
`title`	`const string`	The name shown in the settings, legend and data window.
`shorttitle`	`const string`default `""`	The short name used in the legend.
`overlay`	`const bool`default `false`	true: draw on the price pane; false: in its own pane.
`format`	`const format`default `format.inherit`	The number format (format.*).
`precision`	`const int`default `na`	Decimals shown.
`scale`	`const scale`default `na`	The price scale (scale.*).
`max_bars_back`	`const int`default `500`	History kept for dynamic offsets (1-10,000).
`timeframe`	`const string`default `""`	A timeframe such as "60", "240", "1D" or "1W"; "" is the chart's.
`timeframe_gaps`	`const bool`default `true`	Accepted and ignored.
`explicit_plot_zorder`	`const bool`default `false`	true = plots, horizontal levels and fills are layered in the order they appear in the script (default: by kind, as in imported scripts).
`max_lines_count`	`const int`default `50`	How many lines are kept (1-1,000; the oldest goes first).
`max_labels_count`	`const int`default `50`	How many labels are kept (1-1,000; the oldest goes first).
`max_boxes_count`	`const int`default `50`	How many boxes are kept (1-1,000; the oldest goes first).
`max_polylines_count`	`const int`default `50`	How many polylines are kept (1-500; the oldest goes first).
`dynamic_requests`	`const bool`default `true`	Allow markets and timeframes that change at run time in requests (on by default; false = simple strings only).
`behind_chart`	`const bool`default `false`	true = an overlay script draws behind the price candles; false (the ChartDeck default) = in front of them.
`calc_bars_count`	`const int`default `na`	The number of bars the script runs on: the newest N bars of the chart's market and timeframe, fetched for the script (5,000 when left out). Your plan's bars per run is the most (Beginner 5,000, Plus 7,500, Pro 10,000, Elite 20,000; a phone 2,000). Chart bars older than the run show no script values; scrolling back never extends the run.

Example

ChartScriptOpen in editor

//@chartscript 1
indicator("My script", { overlay: true })

Since ChartScript 1

#`int`function

Converts to int (truncates toward zero); also types an na.

int(x: num): int

Parameter	Type	Description
`x`	`num`	The value.

Returns int.

Example

ChartScriptFragmentOpen in editor

const n = int(close)

Since ChartScript 1

#`library`function

Declares the script as a library: its exported functions, methods, types, enums and constants can be imported by other scripts.

library(title: const string, { overlay?: const bool = false, dynamic_requests?: const bool = true })

Parameter	Type	Description
`title`	`const string`	The name shown in the settings, legend and data window.
`overlay`	`const bool`default `false`	true: draw on the price pane; false: in its own pane.
`dynamic_requests`	`const bool`default `true`	Allow markets and timeframes that change at run time in requests (on by default; false = simple strings only).

Example

ChartScriptOpen in editor

//@chartscript 1
library("Tools")
export const double = (x: float) => x * 2

Since ChartScript 1

#`max_bars_back`function

Sets the history kept for one variable (compile time only).

max_bars_back(var: T, num: const int)

Parameter	Type	Description
`var`	`T`	The variable.
`num`	`const int`	The number of bars of history.

Example

ChartScriptFragmentOpen in editor

const x = close - open
max_bars_back(x, 1000)

Since ChartScript 1

#`minute`function

The minute of the bar open (UTC). The minute of a time in a time zone.

minute(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = minute(time, "UTC")

Since ChartScript 1

#`month`function

The month of the bar open (1-12, UTC). The month of a time in a time zone.

month(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = month(time, "UTC")

Since ChartScript 1

#`na`function

true when the value is na (missing).

na(x: T): bool

Parameter	Type	Description
`x`	`T`	The value.

Returns bool.

Example

ChartScriptFragmentOpen in editor

const missing = na(close[1])

Since ChartScript 1

#`nz`function

The value, or the replacement (0 by default) when it is na.

nz(source: num, { replacement?: num = 0 }): num

nz(source: T, replacement: T): T

Parameter	Type	Description
`source`	`num`	The series to read.
`replacement`	`num`default `0`	The replacement.

Returns num.

Example

ChartScriptFragmentOpen in editor

const chg = nz(close - close[1])

Since ChartScript 1

#`plotarrow`function

Draws an up arrow for positive values and a down arrow for negative ones.

plotarrow(series: float, { title?: const string = "", colorup?: input color = color.up, colordown?: input color = color.down, offset?: input int = 0, minheight?: const int = 5, maxheight?: const int = 100, editable?: const bool = true, show_last?: const int = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false })

Parameter	Type	Description
`series`	`float`	The value to draw on each bar.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`colorup`	`input color`default `color.up`	The colour of up arrows.
`colordown`	`input color`default `color.down`	The colour of down arrows.
`offset`	`input int`default `0`	Shift the output this many bars to the right (negative: left).
`minheight`	`const int`default `5`	The smallest arrow height in pixels.
`maxheight`	`const int`default `100`	The largest arrow height in pixels.
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`format`	`const format`default `na`	The number format (format.*).
`precision`	`const int`default `na`	Decimals shown.
`force_overlay`	`const bool`default `false`	Accepted and ignored in this version.

Example

ChartScriptFragmentOpen in editor

plotarrow(close - open, "Body")

Since ChartScript 1

#`plotbar`function

Draws OHLC bars.

plotbar(open: float, high: float, low: float, close: float, { title?: const string = "", color?: color = na, editable?: const bool = true, show_last?: const int = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false })

Parameter	Type	Description
`open`	`float`	The open value.
`high`	`float`	The high value.
`low`	`float`	The low value.
`close`	`float`	The close value.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`color`	`color`default `na`	The colour.
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`format`	`const format`default `na`	The number format (format.*).
`precision`	`const int`default `na`	Decimals shown.
`force_overlay`	`const bool`default `false`	Accepted and ignored in this version.

Example

ChartScriptFragmentOpen in editor

plotbar(open, high, low, close, "Bars")

Since ChartScript 1

#`plotcandle`function

Draws candles.

plotcandle(open: float, high: float, low: float, close: float, { title?: const string = "", color?: color = na, wickcolor?: color = na, editable?: const bool = true, show_last?: const int = na, bordercolor?: color = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false })

Parameter	Type	Description
`open`	`float`	The open value.
`high`	`float`	The high value.
`low`	`float`	The low value.
`close`	`float`	The close value.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`color`	`color`default `na`	The colour.
`wickcolor`	`color`default `na`	The wick colour.
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`bordercolor`	`color`default `na`	The border colour.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`format`	`const format`default `na`	The number format (format.*).
`precision`	`const int`default `na`	Decimals shown.
`force_overlay`	`const bool`default `false`	Accepted and ignored in this version.

Example

ChartScriptFragmentOpen in editor

plotcandle(open, high, low, close, "Candles", close > open ? color.up : color.down)

Since ChartScript 1

#`plotchar`function

Draws one character on bars where the series is true (or not na).

plotchar(series: bool, { title?: const string = "", char?: input string = "★", location?: input location = location.abovebar, color?: color = na, offset?: input int = 0, text?: input string = "", textcolor?: color = na, editable?: const bool = true, size?: input size = size.auto, show_last?: const int = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false, role?: const string = "", look?: const string = "", variant?: const string = "", textstyle?: input string = "", text_formatting?: input int = text.format_none })

plotchar(series: float, { title?: const string = "", char?: input string = "★", location?: input location = location.abovebar, color?: color = na, offset?: input int = 0, text?: input string = "", textcolor?: color = na, editable?: const bool = true, size?: input size = size.auto, show_last?: const int = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false, role?: const string = "", look?: const string = "", variant?: const string = "", textstyle?: input string = "", text_formatting?: input int = text.format_none })

Parameter	Type	Description
`series`	`bool`	The value to draw on each bar.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`char`	`input string`default `"★"`	One character to draw.
`location`	`input location`default `location.abovebar`	Where the shape sits (location.*).
`color`	`color`default `na`	The colour.
`offset`	`input int`default `0`	Shift the output this many bars to the right (negative: left).
`text`	`input string`default `""`	Text drawn with the shape.
`textcolor`	`color`default `na`	The colour of the text.
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`size`	`input size`default `size.auto`	The number of elements.
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`format`	`const format`default `na`	The number format (format.*).
`precision`	`const int`default `na`	Decimals shown.
`force_overlay`	`const bool`default `false`	Accepted and ignored in this version.
`role`	`const string`default `""`	What the color of this output means, for the color presets of the Colors tab: "up", "down", "neutral" or "accent". Empty = guessed from the role of its style (look), the theme color, the title and the hue (a teal line counts as up). Another value is error CS2014.
`look`	`const string`default `""`	A style made with style.plot / style.line / style.marker / style.fill (its look, shared and user-editable).
`variant`	`const string`default `""`	The name of one of the style's variants (style.variant).
`textstyle`	`input string`default `""`	The text's style (textstyle.new or input.textstyle): size, font, weight, italic, colour, halo, background.
`text_formatting`	`input int`default `text.format_none`	text.format_bold, text.format_italic or both added.

Example

ChartScriptFragmentOpen in editor

plotchar(close > open, "Up", "*", location.top, color.up)

Since ChartScript 1

#`plotshape`function

Draws a shape on bars where the series is true (or not na).

plotshape(series: bool, { title?: const string = "", style?: input shape_style = shape.xcross, location?: input location = location.abovebar, color?: color = na, offset?: input int = 0, text?: input string = "", textcolor?: color = na, editable?: const bool = true, size?: input size = size.auto, show_last?: const int = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false, role?: const string = "", look?: const string = "", variant?: const string = "", textstyle?: input string = "", text_formatting?: input int = text.format_none })

plotshape(series: float, { title?: const string = "", style?: input shape_style = shape.xcross, location?: input location = location.abovebar, color?: color = na, offset?: input int = 0, text?: input string = "", textcolor?: color = na, editable?: const bool = true, size?: input size = size.auto, show_last?: const int = na, display?: input display = display.all, format?: const format = na, precision?: const int = na, force_overlay?: const bool = false, role?: const string = "", look?: const string = "", variant?: const string = "", textstyle?: input string = "", text_formatting?: input int = text.format_none })

Parameter	Type	Description
`series`	`bool`	The value to draw on each bar.
`title`	`const string`default `""`	The name shown in the settings, legend and data window.
`style`	`input shape_style`default `shape.xcross`	The style constant.
`location`	`input location`default `location.abovebar`	Where the shape sits (location.*).
`color`	`color`default `na`	The colour.
`offset`	`input int`default `0`	Shift the output this many bars to the right (negative: left).
`text`	`input string`default `""`	Text drawn with the shape.
`textcolor`	`color`default `na`	The colour of the text.
`editable`	`const bool`default `true`	Accepted and ignored (styles are always editable).
`size`	`input size`default `size.auto`	The number of elements.
`show_last`	`const int`default `na`	Accepted and ignored in this version.
`display`	`input display`default `display.all`	Where the value is shown (display.*).
`format`	`const format`default `na`	The number format (format.*).
`precision`	`const int`default `na`	Decimals shown.
`force_overlay`	`const bool`default `false`	Accepted and ignored in this version.
`role`	`const string`default `""`	What the color of this output means, for the color presets of the Colors tab: "up", "down", "neutral" or "accent". Empty = guessed from the role of its style (look), the theme color, the title and the hue (a teal line counts as up). Another value is error CS2014.
`look`	`const string`default `""`	A style made with style.plot / style.line / style.marker / style.fill (its look, shared and user-editable).
`variant`	`const string`default `""`	The name of one of the style's variants (style.variant).
`textstyle`	`input string`default `""`	The text's style (textstyle.new or input.textstyle): size, font, weight, italic, colour, halo, background.
`text_formatting`	`input int`default `text.format_none`	text.format_bold, text.format_italic or both added.

Example

ChartScriptFragmentOpen in editor

plotshape(ta.crossover(close, ta.sma(close, 20)), "Cross", shape.triangleup, location.belowbar, color.up)

Since ChartScript 1

#`second`function

The second of the bar open (UTC). The second of a time in a time zone.

second(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = second(time, "UTC")

Since ChartScript 1

#`string`function

Types a string value (string(na)).

string(x: string): string

Parameter	Type	Description
`x`	`string`	The value.

Returns string.

Example

ChartScriptFragmentOpen in editor

const s = string(na)

Since ChartScript 1

#`time`function

The open time of the bar (ms, UTC). The open time of the bar in a timeframe, or na outside the session; bars_back reads a chart bar that many bars ago, timeframe_bars_back steps back whole periods of the timeframe.

time({ timeframe?: simple string = "", session?: simple string = "", timezone?: simple string = "UTC", bars_back?: int = 0, timeframe_bars_back?: int = 0 }): int

Parameter	Type	Description
`timeframe`	`simple string`default `""`	A timeframe such as "60", "240", "1D" or "1W"; "" is the chart's.
`session`	`simple string`default `""`	A session such as "0930-1600" (UTC unless timezone is given).
`timezone`	`simple string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".
`bars_back`	`int`default `0`	Chart bars back (0 = this bar).
`timeframe_bars_back`	`int`default `0`	Periods of the timeframe back (0 = this period).

Returns int.

Example

ChartScriptFragmentOpen in editor

const t = time("1D")

Since ChartScript 1

#`time_close`function

The close time of the bar (ms, UTC). The close time of the bar in a timeframe.

time_close({ timeframe?: simple string = "", session?: simple string = "", timezone?: simple string = "UTC", bars_back?: int = 0, timeframe_bars_back?: int = 0 }): int

Parameter	Type	Description
`timeframe`	`simple string`default `""`	A timeframe such as "60", "240", "1D" or "1W"; "" is the chart's.
`session`	`simple string`default `""`	A session such as "0930-1600" (UTC unless timezone is given).
`timezone`	`simple string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".
`bars_back`	`int`default `0`	Chart bars back (0 = this bar).
`timeframe_bars_back`	`int`default `0`	Periods of the timeframe back (0 = this period).

Returns int.

Example

ChartScriptFragmentOpen in editor

const t = time_close("1D")

Since ChartScript 1

#`timestamp`function

A time in milliseconds (UTC unless a time zone is given).

timestamp(year: int, month: int, day: int, { hour?: int = 0, minute?: int = 0, second?: int = 0 }): int

timestamp(timezone: string, year: int, month: int, day: int, { hour?: int = 0, minute?: int = 0, second?: int = 0 }): int

timestamp(dateString: string): int

Parameter	Type	Description
`year`	`int`	The year.
`month`	`int`	The month (1-12).
`day`	`int`	The day of the month.
`hour`	`int`default `0`	The hour (0-23).
`minute`	`int`default `0`	The minute.
`second`	`int`default `0`	The second.
`timezone`	`string`	An IANA time zone such as "UTC" or "America/New_York".
`dateString`	`string`	A date such as "2024-01-31" or "2024-01-31T09:30:00Z".

Returns int.

Example

ChartScriptFragmentOpen in editor

const t0 = timestamp(2024, 1, 31)

Since ChartScript 1

#`weekofyear`function

The ISO week of the bar open (UTC). The weekofyear of a time in a time zone.

weekofyear(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = weekofyear(time, "UTC")

Since ChartScript 1

#`year`function

The year of the bar open (UTC). The year of a time in a time zone.

year(time: int, { timezone?: string = "UTC" }): int

Parameter	Type	Description
`time`	`int`	A time in milliseconds since 1970 (UTC).
`timezone`	`string`default `"UTC"`	An IANA time zone such as "UTC" or "America/New_York".

Returns int.

Example

ChartScriptFragmentOpen in editor

const v = year(time, "UTC")

Since ChartScript 1

#Variables

#`bar_index`variable

The bar number: 0 = the first bar of the run.

bar_index: int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = bar_index

Since ChartScript 1

#`close`variable

The close of the bar (the last price on the live bar).

close: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = close

Since ChartScript 1

#`dayofmonth`variable

The day of the month of the bar open (UTC). The dayofmonth of a time in a time zone.

dayofmonth(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = dayofmonth

Since ChartScript 1

#`high`variable

The high of the bar.

high: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = high

Since ChartScript 1

#`hl2`variable

(high + low) / 2.

hl2: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = hl2

Since ChartScript 1

#`hlc3`variable

(high + low + close) / 3.

hlc3: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = hlc3

Since ChartScript 1

#`hlcc4`variable

(high + low + close + close) / 4.

hlcc4: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = hlcc4

Since ChartScript 1

#`hour`variable

The hour of the bar open (UTC). The hour of a time in a time zone.

hour(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = hour

Since ChartScript 1

#`last_bar_index`variable

The bar_index of the last bar.

last_bar_index: int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = last_bar_index

Since ChartScript 1

#`last_bar_time`variable

The open time of the last bar of the chart (ms, UTC).

last_bar_time: int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = last_bar_time

Since ChartScript 1

#`low`variable

The low of the bar.

low: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = low

Since ChartScript 1

#`minute`variable

The minute of the bar open (UTC). The minute of a time in a time zone.

minute(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = minute

Since ChartScript 1

#`month`variable

The month of the bar open (1-12, UTC). The month of a time in a time zone.

month(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = month

Since ChartScript 1

#`ohlc4`variable

(open + high + low + close) / 4.

ohlc4: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = ohlc4

Since ChartScript 1

#`open`variable

The open of the bar.

open: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = open

Since ChartScript 1

#`second`variable

The second of the bar open (UTC). The second of a time in a time zone.

second(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = second

Since ChartScript 1

#`time`variable

time({ timeframe?: simple string = "", session?: simple string = "", timezone?: simple string = "UTC", bars_back?: int = 0, timeframe_bars_back?: int = 0 }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = time

Since ChartScript 1

#`time_close`variable

The close time of the bar (ms, UTC). The close time of the bar in a timeframe.

time_close({ timeframe?: simple string = "", session?: simple string = "", timezone?: simple string = "UTC", bars_back?: int = 0, timeframe_bars_back?: int = 0 }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = time_close

Since ChartScript 1

#`time_tradingday`variable

The start of the trading day of the bar (crypto: 00:00 UTC of the bar's day).

time_tradingday: int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = time_tradingday

Since ChartScript 1

#`timenow`variable

The current time (ms, UTC); differs between runs.

timenow: int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = timenow

Since ChartScript 1

#`volume`variable

The volume of the bar (base units).

volume: float

Type series float.

Example

ChartScriptFragmentOpen in editor

const v = volume

Since ChartScript 1

#`weekofyear`variable

The ISO week of the bar open (UTC). The weekofyear of a time in a time zone.

weekofyear(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = weekofyear

Since ChartScript 1

#`year`variable

The year of the bar open (UTC). The year of a time in a time zone.

year(time: int, { timezone?: string = "UTC" }): int

Type series int.

Example

ChartScriptFragmentOpen in editor

const v = year

Since ChartScript 1

#Not supported

#`alertcondition`function

Not supported in ChartScript.

Use alert.on(condition, title, message).

Since ChartScript 1

#`study`function

Not supported in ChartScript.

Use indicator(...).

Since ChartScript 1

#`varip`variable

Not supported in ChartScript.

Not supported: use live state (same meaning: not rolled back between ticks).

Since ChartScript 1

Global names

#Functions

#barcolorfunction

#bgcolorfunction

#boolfunction

#dayofmonthfunction

#fillfunction

#fixnanfunction

#floatfunction

#hourfunction

#indicatorfunction

#intfunction

#libraryfunction

#max_bars_backfunction

#minutefunction

#monthfunction

#nafunction

#nzfunction

#plotarrowfunction

#plotbarfunction

#plotcandlefunction

#plotcharfunction

#plotshapefunction

#secondfunction

#stringfunction

#timefunction

#time_closefunction

#timestampfunction

#weekofyearfunction

#yearfunction

#Variables

#bar_indexvariable

#closevariable

#dayofmonthvariable

#highvariable

#hl2variable

#hlc3variable

#hlcc4variable

#hourvariable

#last_bar_indexvariable

#last_bar_timevariable

#lowvariable

#minutevariable

#monthvariable

#ohlc4variable

#openvariable

#secondvariable

#timevariable

#time_closevariable

#time_tradingdayvariable

#timenowvariable

#volumevariable

#weekofyearvariable

#yearvariable

#Not supported

#alertconditionfunction

#studyfunction

#varipvariable

`Global names`

#`barcolor`function

#`bgcolor`function

#`bool`function

#`dayofmonth`function

#`fill`function

#`fixnan`function

#`float`function

#`hour`function

#`indicator`function

#`int`function

#`library`function

#`max_bars_back`function

#`minute`function

#`month`function

#`na`function

#`nz`function

#`plotarrow`function

#`plotbar`function

#`plotcandle`function

#`plotchar`function

#`plotshape`function

#`second`function

#`string`function

#`time`function

#`time_close`function

#`timestamp`function

#`weekofyear`function

#`year`function

#`bar_index`variable

#`close`variable

#`dayofmonth`variable

#`high`variable

#`hl2`variable

#`hlc3`variable

#`hlcc4`variable

#`hour`variable

#`last_bar_index`variable

#`last_bar_time`variable

#`low`variable

#`minute`variable

#`month`variable

#`ohlc4`variable

#`open`variable

#`second`variable

#`time`variable

#`time_close`variable

#`time_tradingday`variable

#`timenow`variable

#`volume`variable

#`weekofyear`variable

#`year`variable

#`alertcondition`function

#`study`function

#`varip`variable