box

How do you shade a range of bars and prices? Call box.new with its top-left and bottom-right corners: the left bar and top price, then the right bar and bottom price. Keep the handle to move the corners or change the text later.

//@version=6
indicator("Last 20 bars' range", overlay = true)
hi = ta.highest(high, 20)
lo = ta.lowest(low, 20)
var box zone = box.new(na, na, na, na,
      bgcolor = color.new(color.blue, 85), border_color = color.blue)
if barstate.islast
    // Top-left corner, then bottom-right.
    box.set_lefttop(zone, bar_index - 19, hi)
    box.set_rightbottom(zone, bar_index, lo)
    box.set_text(zone, str.tostring(hi - lo, format.mintick))

A deleted box leaves the chart and box.all at once. Its getters read na and its setters do nothing. Past max_boxes_count + 5 boxes on the chart, the oldest go until max_boxes_count are left, 50 by default, as with labels. 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.

box.new

Pine v6

box.new(left, top, right, bottom, border_color, border_width, border_style, extend, xloc, bgcolor, text, text_size, text_color, text_halign, text_valign, text_wrap, text_font_family, force_overlay, text_formatting) → series box
box.new(top_left, bottom_right, border_color, border_width, border_style, extend, xloc, bgcolor, text, text_size, text_color, text_halign, text_valign, text_wrap, text_font_family, force_overlay, text_formatting) → series box

Makes a box from its top-left corner to its bottom-right one, and returns its handle.

In the second form, two chart.points stand in for the corners. Left out there, xloc follows the first point: one made by chart.point.from_time places by time, any other by bar index.

The box's text is white unless text_color says otherwise. TradingView's manual says color.black, but TradingView draws white, and so does this engine.

Parameter	Default	Description
left series int		The left edge's bar, as a bar index, or a time in milliseconds under xloc.bar_time.
top series int/float		The top edge's price.
right series int		The right edge's bar.
bottom series int/float		The bottom edge's price.
border_color series color	color.blue	The border's colour.
border_width series int	1	The border's width in pixels.
border_style series string	line.style_solid	line.style_solid, line.style_dashed or line.style_dotted.
extend series string	extend.none	extend.left, extend.right or extend.both carry the box on to the chart's edge.
xloc series string	xloc.bar_index	Whether left and right are bar indexes or times.
bgcolor series color	color.blue	The fill.
text series string	""	The words inside the box. \n starts a new line.
text_size series string	size.auto	size.auto fits the text to the box. size.tiny to size.huge fix it.
text_color series color	color.white	The text's colour.
text_halign series string	text.align_center	text.align_left, text.align_center or text.align_right.
text_valign series string	text.align_center	text.align_top, text.align_center or text.align_bottom.
text_wrap series string	text.wrap_none	text.wrap_auto wraps the text to the box's width.
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.
top_left chart.point		A chart.point for the top-left corner.
bottom_right chart.point		A chart.point for the bottom-right corner.

box.copy

Pine v6

box.copy(id) → series box

Also a method: id.copy().

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

Parameter	Description
id series box	The box to copy.

box.delete

Pine v6

box.delete(id) → void

Also a method: id.delete().

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

Parameter	Description
id series box	The box.

box.all

Pine v6

array<box> box.all

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

box.get_left

Pine v6

box.get_left(id) → series int

Also a method: id.get_left().

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

Parameter	Description
id series box	The box.

box.get_right

Pine v6

box.get_right(id) → series int

Also a method: id.get_right().

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

Parameter	Description
id series box	The box.

box.get_top

Pine v6

box.get_top(id) → series float

Also a method: id.get_top().

The top edge's price.

Parameter	Description
id series box	The box.

box.get_bottom

Pine v6

box.get_bottom(id) → series float

Also a method: id.get_bottom().

The bottom edge's price.

Parameter	Description
id series box	The box.

box.set_left

Pine v6

box.set_left(id, left) → void

Also a method: id.set_left(left).

Moves the left edge to another bar.

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

box.set_right

Pine v6

box.set_right(id, right) → void

Also a method: id.set_right(right).

Moves the right edge to another bar.

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

box.set_top

Pine v6

box.set_top(id, top) → void

Also a method: id.set_top(top).

Moves the top edge to another price.

Parameter	Description
id series box	The box.
top series int/float	The price.

box.set_bottom

Pine v6

box.set_bottom(id, bottom) → void

Also a method: id.set_bottom(bottom).

Moves the bottom edge to another price.

Parameter	Description
id series box	The box.
bottom series int/float	The price.

box.set_lefttop

Pine v6

box.set_lefttop(id, left, top) → void

Also a method: id.set_lefttop(left, top).

Moves the top-left corner.

Parameter	Description
id series box	The box.
left series int	The bar index, or the time under xloc.bar_time.
top series int/float	The price.

box.set_rightbottom

Pine v6

box.set_rightbottom(id, right, bottom) → void

Also a method: id.set_rightbottom(right, bottom).

Moves the bottom-right corner.

Parameter	Description
id series box	The box.
right series int	The bar index, or the time under xloc.bar_time.
bottom series int/float	The price.

box.set_top_left_point

Pine v6

box.set_top_left_point(id, point) → void

Also a method: id.set_top_left_point(point).

Moves the top-left corner to a point, read by the box's own xloc.

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

box.set_bottom_right_point

Pine v6

box.set_bottom_right_point(id, point) → void

Also a method: id.set_bottom_right_point(point).

Moves the bottom-right corner to a point, read by the box's own xloc.

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

box.set_xloc

Pine v6

box.set_xloc(id, left, right, xloc) → void

Also a method: id.set_xloc(left, right, xloc).

Sets both edges' bars and whether they're bar indexes or times, together.

Parameter	Description
id series box	The box.
left series int	The left edge's bar index or time.
right series int	The right edge's bar index or time.
xloc series string	xloc.bar_index or xloc.bar_time.

box.set_extend

Pine v6

box.set_extend(id, extend) → void

Also a method: id.set_extend(extend).

Sets whether the box carries on to the chart's edge.

Parameter	Description
id series box	The box.
extend series string	extend.none, extend.left, extend.right or extend.both.

box.set_border_color

Pine v6

box.set_border_color(id, color) → void

Also a method: id.set_border_color(color).

Sets the border's colour.

Parameter	Description
id series box	The box.
color series color	The colour.

box.set_border_width

Pine v6

box.set_border_width(id, width) → void

Also a method: id.set_border_width(width).

Sets the border's width.

Parameter	Description
id series box	The box.
width series int	The width in pixels.

box.set_border_style

Pine v6

box.set_border_style(id, style) → void

Also a method: id.set_border_style(style).

Sets the border's style.

Parameter	Description
id series box	The box.
style series string	line.style_solid, line.style_dashed or line.style_dotted.

box.set_bgcolor

Pine v6

box.set_bgcolor(id, color) → void

Also a method: id.set_bgcolor(color).

Sets the fill.

Parameter	Description
id series box	The box.
color series color	The colour.

box.set_text

Pine v6

box.set_text(id, text) → void

Also a method: id.set_text(text).

Replaces the text inside the box.

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

box.set_text_color

Pine v6

box.set_text_color(id, text_color) → void

Also a method: id.set_text_color(text_color).

Sets the text's colour.

Parameter	Description
id series box	The box.
text_color series color	The colour.

box.set_text_size

Pine v6

box.set_text_size(id, text_size) → void

Also a method: id.set_text_size(text_size).

Sets the text's size.

Parameter	Description
id series box	The box.
text_size series string	size.auto, or size.tiny to size.huge.

box.set_text_halign

Pine v6

box.set_text_halign(id, text_halign) → void

Also a method: id.set_text_halign(text_halign).

Sets the text's place across the box.

Parameter	Description
id series box	The box.
text_halign series string	text.align_left, text.align_center or text.align_right.

box.set_text_valign

Pine v6

box.set_text_valign(id, text_valign) → void

Also a method: id.set_text_valign(text_valign).

Sets the text's place up and down the box.

Parameter	Description
id series box	The box.
text_valign series string	text.align_top, text.align_center or text.align_bottom.

box.set_text_wrap

Pine v6

box.set_text_wrap(id, text_wrap) → void

Also a method: id.set_text_wrap(text_wrap).

Sets whether the text wraps to the box's width.

Parameter	Description
id series box	The box.
text_wrap series string	text.wrap_none or text.wrap_auto.

box.set_text_font_family

Pine v6

box.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 box	The box.
text_font_family series string	font.family_default or font.family_monospace.

box.set_text_formatting

Pine v6

box.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 box	The box.
text_formatting const string	text.format_none, text.format_bold, text.format_italic, or bold and italic added together.

See also

• chart.point
• label and line
• Drawings
• declarations, for max_boxes_count