label

How do you write text on the chart at a bar? Call label.new with a bar and a price, or with a chart.point, and keep the handle it returns to change the label later. Each call makes a new label, so a script that wants one label that follows the price makes it once with var and moves it.

//@version=6
indicator("Last close", overlay = true)
// Made once, on the first bar, then moved:
// the chart holds one label, not one per bar.
var label tag = label.new(bar_index, close, "", style = label.style_label_left)
label.set_xy(tag, bar_index, close)
label.set_text(tag, str.tostring(close, format.mintick))

A deleted label leaves the chart and label.all at once. Its getters read na and its setters do nothing. A drawing placed at a bar before the one that made it, such as bar_index - 5, runs with a leak warning: on the chart it looks known earlier than it was.

A label a bar keeps only the newest 50

Once a script has made max_labels_count + 5 labels that are still on the chart, the oldest go until max_labels_count are left: 50 unless indicator() or strategy() sets it. A label taken this way leaves the chart and label.all, but its getters still read it.

label.new

Pine v6

label.new(x, y, text, xloc, yloc, color, style, textcolor, size, textalign, tooltip, text_font_family, force_overlay, text_formatting) → series label
label.new(point, text, xloc, yloc, color, style, textcolor, size, textalign, tooltip, text_font_family, force_overlay, text_formatting) → series label

Makes a label at a bar and a price, and returns its handle.

In the second form, a chart.point stands in for x and y. Left out there, xloc follows the point: one made by chart.point.from_time places by time, any other by bar index.

Parameter	Default	Description
x series int		The bar, as a bar index, or a time in milliseconds under xloc.bar_time.
y series int/float		The price.
text series string	""	The words. \n starts a new line.
xloc series string	xloc.bar_index	Whether x is a bar index or a time.
yloc series string	yloc.price	yloc.price puts the label at y. yloc.abovebar puts it above the bar's high and yloc.belowbar below its low, and both ignore y.
color series color	color.blue	The label's fill, or the shape's colour.
style series string	label.style_label_down	The shape. See label.style_*.
textcolor series color	color.white	The text's colour.
size series string	size.normal	The size of the label and its text, from size.tiny to size.huge.
textalign series string	text.align_center	How lines of text line up inside the label: text.align_left, text.align_center or text.align_right.
tooltip series string	""	Words shown while the pointer is over the label.
text_font_family series string	font.family_default	font.family_default or font.family_monospace.
force_overlay const bool	false	true draws on the price pane even from a script with a pane of its own.
text_formatting const string	text.format_none	text.format_bold, text.format_italic, or both added together.
point chart.point		A chart.point that gives the bar and the price.

label.copy

Pine v6

label.copy(id) → series label

Also a method: id.copy().

A new label with every value of id. A deleted label copies too, and the copy is on the chart.

Parameter	Description
id series label	The label to copy.

label.delete

Pine v6

label.delete(id) → void

Also a method: id.delete().

Takes the label off the chart and out of label.all.

Parameter	Description
id series label	The label.

label.all

Pine v6

array<label> label.all

An array of every label the script has on the chart, oldest first. A deleted label, or one the count took, isn't in it.

label.get_x

Pine v6

label.get_x(id) → series int

Also a method: id.get_x().

The label's bar index, or its time under xloc.bar_time.

Parameter	Description
id series label	The label.

label.get_y

Pine v6

label.get_y(id) → series float

Also a method: id.get_y().

The label's price.

Parameter	Description
id series label	The label.

label.get_text

Pine v6

label.get_text(id) → series string

Also a method: id.get_text().

The label's text. A deleted label reads "", not na.

Parameter	Description
id series label	The label.

label.set_x

Pine v6

label.set_x(id, x) → void

Also a method: id.set_x(x).

Moves the label to another bar.

Parameter	Description
id series label	The label.
x series int	The bar index, or the time under xloc.bar_time.

label.set_y

Pine v6

label.set_y(id, y) → void

Also a method: id.set_y(y).

Moves the label to another price.

Parameter	Description
id series label	The label.
y series int/float	The price.

label.set_xy

Pine v6

label.set_xy(id, x, y) → void

Also a method: id.set_xy(x, y).

Moves the label to another bar and price.

Parameter	Description
id series label	The label.
x series int	The bar index, or the time under xloc.bar_time.
y series int/float	The price.

label.set_point

Pine v6

label.set_point(id, point) → void

Also a method: id.set_point(point).

Moves the label to a point, read by the label's own xloc.

Parameter	Description
id series label	The label.
point chart.point	The chart.point.

label.set_xloc

Pine v6

label.set_xloc(id, x, xloc) → void

Also a method: id.set_xloc(x, xloc).

Sets the bar and whether it's a bar index or a time, together, so the two never disagree.

Parameter	Description
id series label	The label.
x series int	The bar index or time.
xloc series string	xloc.bar_index or xloc.bar_time.

label.set_yloc

Pine v6

label.set_yloc(id, yloc) → void

Also a method: id.set_yloc(yloc).

Sets whether the label sits at its price, above the bar's high or below its low.

Parameter	Description
id series label	The label.
yloc series string	yloc.price, yloc.abovebar or yloc.belowbar.

label.set_text

Pine v6

label.set_text(id, text) → void

Also a method: id.set_text(text).

Replaces the label's text.

Parameter	Description
id series label	The label.
text series string	The words.

label.set_color

Pine v6

label.set_color(id, color) → void

Also a method: id.set_color(color).

Sets the label's fill, or its shape's colour.

Parameter	Description
id series label	The label.
color series color	The colour. na leaves no fill.

label.set_textcolor

Pine v6

label.set_textcolor(id, textcolor) → void

Also a method: id.set_textcolor(textcolor).

Sets the text's colour.

Parameter	Description
id series label	The label.
textcolor series color	The colour.

label.set_style

Pine v6

label.set_style(id, style) → void

Also a method: id.set_style(style).

Sets the label's shape.

Parameter	Description
id series label	The label.
style series string	A label.style_* value.

label.set_size

Pine v6

label.set_size(id, size) → void

Also a method: id.set_size(size).

Sets the size of the label and its text.

Parameter	Description
id series label	The label.
size series string	size.tiny, size.small, size.normal, size.large, size.huge or size.auto.

label.set_textalign

Pine v6

label.set_textalign(id, textalign) → void

Also a method: id.set_textalign(textalign).

Sets how lines of text line up inside the label.

Parameter	Description
id series label	The label.
textalign series string	text.align_left, text.align_center or text.align_right.

label.set_tooltip

Pine v6

label.set_tooltip(id, tooltip) → void

Also a method: id.set_tooltip(tooltip).

Sets the words shown while the pointer is over the label.

Parameter	Description
id series label	The label.
tooltip series string	The words.

label.set_text_font_family

Pine v6

label.set_text_font_family(id, text_font_family) → void

Also a method: id.set_text_font_family(text_font_family).

Sets the text's font.

Parameter	Description
id series label	The label.
text_font_family series string	font.family_default or font.family_monospace.

label.set_text_formatting

Pine v6

label.set_text_formatting(id, text_formatting) → void

Also a method: id.set_text_formatting(text_formatting).

Sets the text to bold, italic, both or neither.

Parameter	Description
id series label	The label.
text_formatting const string	text.format_none, text.format_bold, text.format_italic, or bold and italic added together.

label.style_*

Values for a label's style. The label_* styles are a box round the text, with a tail toward the point the style names. The others are a shape at the point, with the text above it.

Each is a const string.

Name	What it means
label.style_arrowdown	An arrow pointing down.
label.style_arrowup	An arrow pointing up.
label.style_circle	A circle.
label.style_cross	A plus sign.
label.style_diamond	A diamond.
label.style_flag	A flag.
label.style_label_center	A box centred on the point, with no tail.
label.style_label_down	A box above the point, its tail down to it.
label.style_label_left	A box right of the point, its tail left to it.
label.style_label_lower_left	A box above and right of the point, its corner on it.
label.style_label_lower_right	A box above and left of the point, its corner on it.
label.style_label_right	A box left of the point, its tail right to it.
label.style_label_up	A box below the point, its tail up to it.
label.style_label_upper_left	A box below and right of the point, its corner on it.
label.style_label_upper_right	A box below and left of the point, its corner on it.
label.style_none	The text alone, written up from the point.
label.style_square	A square.
label.style_text_outline	The text alone, centred on the point and outlined in color.
label.style_triangledown	A triangle pointing down.
label.style_triangleup	A triangle pointing up.
label.style_xcross	An X.

See also

• chart.point
• line and box
• table, for text that stays put on the screen
• Drawings
• declarations, for max_labels_count