TradeZoro
Notifications

Reference

Boxes

Rectangles between two corners.

box.copy(id)

A copy of the box.

Returns: box

ParameterType
idbox

box.delete(id)

Removes the box.

Returns: nothing

ParameterType
idbox

box.get_bottom(id)

Bottom edge.

Returns: a number

ParameterType
idbox

box.get_left(id)

Left edge.

Returns: a whole number

ParameterType
idbox

box.get_right(id)

Right edge.

Returns: a whole number

ParameterType
idbox

box.get_top(id)

Top edge.

Returns: a number

ParameterType
idbox

box.new(left, top, right, bottom, border_color=na, border_width=1, border_style="solid", extend="none", xloc="bar_index", bgcolor=na, text="", text_size="auto", text_color=na, text_halign="center", text_valign="center")

Creates a box and returns its id.

Returns: box

ParameterTypeNotes
leftnum
topnum
rightnum
bottomnum
border_colorcolorDefault na
border_widthintDefault 1
border_stylestringDefault "solid"
extendstringDefault "none"
xlocstringDefault "bar_index"
bgcolorcolorDefault na
textstringDefault ""
text_sizestringDefault "auto"
text_colorcolorDefault na
text_halignstringDefault "center"
text_valignstringDefault "center"

box.set_bgcolor(id, color)

Changes the fill color.

Returns: nothing

ParameterType
idbox
colorcolor

box.set_border_color(id, color)

Changes the border color.

Returns: nothing

ParameterType
idbox
colorcolor

box.set_border_style(id, style)

Changes the border style.

Returns: nothing

ParameterType
idbox
stylestring

box.set_border_width(id, width)

Changes the border width.

Returns: nothing

ParameterType
idbox
widthint

box.set_bottom(id, bottom)

Moves the bottom edge.

Returns: nothing

ParameterType
idbox
bottomnum

box.set_extend(id, extend)

Extends the box left, right, both or none.

Returns: nothing

ParameterType
idbox
extendstring

box.set_left(id, left)

Moves the left edge.

Returns: nothing

ParameterType
idbox
leftnum

box.set_lefttop(id, left, top)

Moves the top-left corner.

Returns: nothing

ParameterType
idbox
leftnum
topnum

box.set_right(id, right)

Moves the right edge.

Returns: nothing

ParameterType
idbox
rightnum

box.set_rightbottom(id, right, bottom)

Moves the bottom-right corner.

Returns: nothing

ParameterType
idbox
rightnum
bottomnum

box.set_text(id, text)

Changes the text.

Returns: nothing

ParameterType
idbox
textstring

box.set_text_color(id, text_color)

Changes the text color.

Returns: nothing

ParameterType
idbox
text_colorcolor

box.set_top(id, top)

Moves the top edge.

Returns: nothing

ParameterType
idbox
topnum

Education only. Not financial advice. Examples are teaching samples, not trading results.

Zscript is coming soon

The manual opens when Zscript launches.

Back to home