Label

Handle for a label drawing.

Static Methods

new

Creates a label object on the chart.

Parameters

Name	Type	Default	Description
`point`	`series chart.Point`		The chart.Point object specifying the position of the label.
`text`	`series String`	`na`	The text to display on the label.
`xloc`	`series XLoc`	`XLoc.BarIndex`	The x-location type: XLoc.BarIndex or XLoc.BarTime.
`yloc`	`series YLoc`	`YLoc.Price`	The y-location type: YLoc.Price or YLoc.Price_range.
`color`	`series Color`	`na`	The background color of the label.
`style`	`series LabelStyle`	`LabelStyle.Down`	The style of the label.
`text_color`	`series Color`	`na`	The color of the label text.
`size`	`series Size`	`Size.Normal`	The size of the label as a named constant.
`text_align`	`series TextHAlign`	`TextHAlign.Center`	The text alignment: TextHAlign.Center, TextHAlign.Left, or TextHAlign.Right.
`tooltip`	`series String`	`na`	The tooltip text when hovering over the label.
`text_font_family`	`series FontFamily`	`FontFamily.Default`	The font family for the label text.
`force_overlay`	`const bool`	`false`	If true, the label is rendered on the top.
`text_formatting`	`const TextFormat`	`TextFormat.NONE`	The text formatting options.

Returns: series Label

Name	Type	Default	Description
`x`	`series int`		The x-coordinate (bar index or UNIX time).
`y`	`series float`		The y-coordinate (price).
`text`	`series String`	`na`	The text to display on the label.
`xloc`	`series XLoc`	`XLoc.BarIndex`	The x-location type: XLoc.BarIndex or XLoc.BarTime.
`yloc`	`series YLoc`	`YLoc.Price`	The y-location type: YLoc.Price or YLoc.Price_range.
`color`	`series Color`	`na`	The background color of the label.
`style`	`series LabelStyle`	`LabelStyle.Down`	The style of the label.
`text_color`	`series Color`	`na`	The color of the label text.
`size`	`series Size`	`Size.Normal`	The size of the label as a named constant.
`text_align`	`series TextHAlign`	`TextHAlign.Center`	The text alignment: TextHAlign.Center, TextHAlign.Left, or TextHAlign.Right.
`tooltip`	`series String`	`na`	The tooltip text when hovering over the label.
`text_font_family`	`series FontFamily`	`FontFamily.Default`	The font family for the label text.
`force_overlay`	`const bool`	`false`	If true, the label is rendered on the top.
`text_formatting`	`const TextFormat`	`TextFormat.NONE`	The text formatting options.

Name	Type	Default	Description
`x`	`series int`		The x-coordinate (bar index or UNIX time).
`y`	`series float`		The y-coordinate (price).
`text`	`series String`	`na`	The text to display on the label.
`xloc`	`series XLoc`	`XLoc.BarIndex`	The x-location type: XLoc.BarIndex or XLoc.BarTime.
`yloc`	`series YLoc`	`YLoc.Price`	The y-location type: YLoc.Price or YLoc.Price_range.
`color`	`series Color`	`na`	The background color of the label.
`style`	`series LabelStyle`	`LabelStyle.Down`	The style of the label.
`text_color`	`series Color`	`na`	The color of the label text.
`size`	`series int`	`0`	The size of the label as an integer value.
`text_align`	`series TextHAlign`	`TextHAlign.Center`	The text alignment: TextHAlign.Center, TextHAlign.Left, or TextHAlign.Right.
`tooltip`	`series String`	`na`	The tooltip text when hovering over the label.
`text_font_family`	`series FontFamily`	`FontFamily.Default`	The font family for the label text.
`force_overlay`	`series bool`	`false`	If true, the label is rendered on the top.
`text_formatting`	`const TextFormat`	`TextFormat.NONE`	The text formatting options.

Static Properties

all

Type: series Array<Label>

Returns an array filled with all the current labels drawn by the script.

Methods

copy

navi

copy(id: series Label): series Label

Creates a copy of the specified label and returns its id.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to copy.

Returns: series Label

delete

navi

delete(id: series Label)

Deletes the specified label from the chart.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to delete.

get_text

navi

get_text(id: series Label): series String

Returns text of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to get the text from.

Returns: series String

get_x

navi

get_x(id: series Label): series int

Returns UNIX time or bar index (depending on the last xloc value set) of this label's position.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to get the x-coordinate from.

Returns: series int

get_y

navi

get_y(id: series Label): series float

Returns price of this label's position.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to get the y-coordinate from.

Returns: series float

set_color

navi

set_color(id: series Label, color: series Color)

Sets color of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`color`	`series Color`		The new background color.

set_point

navi

set_point(id: series Label, point: series chart.Point)

Sets the location of this label using a chart.Point object.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`point`	`series chart.Point`		The `chart.Point` object specifying the new position.

set_size

Sets arrow and text size of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`size`	`series int`		The new size as an integer value.

set_style

navi

set_style(id: series Label, style: series LabelStyle)

Sets style of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`style`	`series LabelStyle`		The new label style constant.

set_text

navi

set_text(id: series Label, text: series String)

Sets text of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`text`	`series String`		The new text to display.

set_text_align

navi

set_text_align(id: series Label, text_align: series TextHAlign)

Sets text alignment of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`text_align`	`series TextHAlign`		The text alignment: TextHAlign.Center, TextHAlign.Left, or TextHAlign.Right.

set_text_color

navi

set_text_color(id: series Label, text_color: series Color)

Sets text color of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`text_color`	`series Color`		The new text color.

set_text_font_family

navi

set_text_font_family(id: series Label, text_font_family: series FontFamily)

Sets font family of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`text_font_family`	`series FontFamily`		The font family: FontFamily.Default or FontFamily.Monospace.

set_text_formatting

navi

set_text_formatting(id: series Label, text_formatting: const TextFormat)

Sets text formatting of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`text_formatting`	`const TextFormat`		The text formatting options.

navi

set_tooltip(id: series Label, tooltip: series String)

Sets tooltip text of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`tooltip`	`series String`		The new tooltip text.

set_x

navi

set_x(id: series Label, x: series int)

Sets UNIX time or bar index (depending on the last xloc value set) of this label's position.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`x`	`series int`		The new x-coordinate (bar index or UNIX time).

set_xloc

navi

set_xloc(id: series Label, xloc: series XLoc)

Sets x location type of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`xloc`	`series XLoc`		The x-location type: XLoc.BarIndex or XLoc.BarTime.

set_xy

navi

set_xy(id: series Label, x: series int, y: series float)

Sets both x and y coordinates of this label's position.

Parameters

Name	Type	Description
`id`	`series Label`	The label to modify.
`x`	`series int`	The new x-coordinate (bar index or UNIX time).
`y`	`series float`	The new y-coordinate (price).

set_y

navi

set_y(id: series Label, y: series float)

Sets price of this label's position.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`y`	`series float`		The new y-coordinate (price).

set_yloc

navi

set_yloc(id: series Label, yloc: series YLoc)

Sets y location type of this label.

Parameters

Name	Type	Default	Description
`id`	`series Label`		The label to modify.
`yloc`	`series YLoc`		The y-location type: YLoc.Price or YLoc.Price_range.

Label ​

Static Methods ​

new ​

Static Properties ​

all ​

Methods ​

copy ​

delete ​

get_text ​

get_x ​

get_y ​

set_color ​

set_point ​

set_size ​

set_style ​

set_text ​

set_text_align ​

set_text_color ​

set_text_font_family ​

set_text_formatting ​

set_tooltip ​

set_x ​

set_xloc ​

set_xy ​

set_y ​

set_yloc ​

Label

Static Methods

new

Static Properties

all

Methods

copy

delete

get_text

get_x

get_y

set_color

set_point

set_size

set_style

set_text

set_text_align

set_text_color

set_text_font_family

set_text_formatting

set_tooltip

set_x

set_xloc

set_xy

set_y

set_yloc