QuaScript Documentation

Language guide, engine API, 601 builtins and the preset library · v3.0.0-phase1

draw: drawing objects

Generated from the engine catalog by tools/gen-docs.mjs; do not edit.

draw.path.create

script.qs

draw.path.create(xs, ys, color = color.blue.500, width = 1, closed = 0, fill = na, by = anchor.bar) -> id

Polyline through the points (xs[i], ys[i]).

Argument	Kind	Default
`xs`	list<any>	required
`ys`	list<any>	required
`color`	color	`color.blue.500`
`width`	num	`1`
`closed`	bool	`0`
`fill`	color	`na`
`by`	num	`anchor.bar`

draw.path.delete

script.qs

draw.path.delete(id)

Deletes the object (unknown ids are ignored with a warning).

Argument	Kind	Default	Notes
`id`	id	required

draw.path.update

script.qs

draw.path.update(id, xs, ys, color = na)

Replaces the points.

Argument	Kind	Default
`id`	id	required
`xs`	list<any>	required
`ys`	list<any>	required
`color`	color	`na`

draw.segment.create

script.qs

draw.segment.create(x1, y1, x2, y2, color = color.blue.500, width = 1, stroke = style.solid, ray = ray.none, by = anchor.bar) -> id

Line segment from (x1, y1) to (x2, y2); x is a bar index unless by = anchor.time.

Argument	Kind	Default
`x1`	num	required
`y1`	num	required
`x2`	num	required
`y2`	num	required
`color`	color	`color.blue.500`
`width`	num	`1`
`stroke`	num	`style.solid`
`ray`	num	`ray.none`
`by`	num	`anchor.bar`

draw.segment.delete

script.qs

draw.segment.delete(id)

Deletes the object (unknown ids are ignored with a warning).

Argument	Kind	Default	Notes
`id`	id	required

draw.segment.get

script.qs

draw.segment.get(id) -> (x1, y1, x2, y2)

End points: (x1, y1, x2, y2).

Argument	Kind	Default	Notes
`id`	id	required

Returns 4 values: x1, y1, x2, y2.

draw.segment.update

script.qs

draw.segment.update(id, x1 = na, y1 = na, x2 = na, y2 = na, color = na, width = na)

Changes the given fields (na keeps a field).

Argument	Kind	Default
`id`	id	required
`x1`	num	`na`
`y1`	num	`na`
`x2`	num	`na`
`y2`	num	`na`
`color`	color	`na`
`width`	num	`na`

draw.segment.y_at

script.qs

draw.segment.y_at(id, x) -> num

Price of the segment's line at x.

Argument	Kind	Default	Notes
`id`	id	required
`x`	num	required

draw.table.cell

script.qs

draw.table.cell(id, row, col, text, text_color = color.white, bg_color = na, size = 1, align = center, tooltip = )

Sets one cell.

Argument	Kind	Default	Notes
`id`	id	required
`row`	int	required
`col`	int	required
`text`	text	required
`text_color`	color	`color.white`
`bg_color`	color	`na`
`size`	num	`1`
`align`	text	`center`	one of `left`, `center`, `right`
`tooltip`	text	`""`

draw.table.clear

script.qs

draw.table.clear(id)

Removes every cell.

Argument	Kind	Default	Notes
`id`	id	required

draw.table.create

script.qs

draw.table.create(at = anchor.top_right, rows, cols, bg_color = color.slate.900, border_color = color.slate.700, border_width = 1) -> id

Table anchored to a screen corner (at most 100 x 20 cells).

Argument	Kind	Default
`at`	num	`anchor.top_right`
`rows`	int	required
`cols`	int	required
`bg_color`	color	`color.slate.900`
`border_color`	color	`color.slate.700`
`border_width`	num	`1`

draw.table.delete

script.qs

draw.table.delete(id)

Deletes the object (unknown ids are ignored with a warning).

Argument	Kind	Default	Notes
`id`	id	required

draw.table.from

script.qs

draw.table.from(tbl, at = anchor.top_right, header = 1, max_rows = 20, number_format = {:.2f}, header_color = color.slate.700, text_color = color.white, bg_color = color.slate.900) -> id

Shows a data table on screen (one table per call site, updated in place).

Argument	Kind	Default
`tbl`	table	required
`at`	num	`anchor.top_right`
`header`	bool	`1`
`max_rows`	int	`20`
`number_format`	text	`{:.2f}`
`header_color`	color	`color.slate.700`
`text_color`	color	`color.white`
`bg_color`	color	`color.slate.900`

draw.table.merge

script.qs

draw.table.merge(id, from_row, from_col, to_row, to_col)

Merges a block of cells.

Argument	Kind	Default
`id`	id	required
`from_row`	int	required
`from_col`	int	required
`to_row`	int	required
`to_col`	int	required

draw.table.update

script.qs

draw.table.update(id, at = na, bg_color = na, border_color = na)

Changes table placement or colors.

Argument	Kind	Default
`id`	id	required
`at`	num	`na`
`bg_color`	color	`na`
`border_color`	color	`na`

draw.tag.create

script.qs

draw.tag.create(x, y, text, color = color.blue.500, text_color = color.white, shape = shape.tag_down, size = 1, by = anchor.bar, tooltip = ) -> id

Text label at (x, y).

Argument	Kind	Default
`x`	num	required
`y`	num	required
`text`	text	required
`color`	color	`color.blue.500`
`text_color`	color	`color.white`
`shape`	num	`shape.tag_down`
`size`	num	`1`
`by`	num	`anchor.bar`
`tooltip`	text	`""`

draw.tag.delete

script.qs

draw.tag.delete(id)

Deletes the object (unknown ids are ignored with a warning).

Argument	Kind	Default	Notes
`id`	id	required

draw.tag.get

script.qs

draw.tag.get(id) -> (x, y)

Position: (x, y).

Argument	Kind	Default	Notes
`id`	id	required

Returns 2 values: x, y.

draw.tag.update

script.qs

draw.tag.update(id, x = na, y = na, text = , color = na)

Changes the given fields.

Argument	Kind	Default
`id`	id	required
`x`	num	`na`
`y`	num	`na`
`text`	text	`""`
`color`	color	`na`

draw.zone.create

script.qs

draw.zone.create(left, top, right, bottom, color = color.blue.500, border_color = na, border_width = 1, text = , ray = ray.none, by = anchor.bar) -> id

Rectangle between two bars and two prices.

Argument	Kind	Default
`left`	num	required
`top`	num	required
`right`	num	required
`bottom`	num	required
`color`	color	`color.blue.500`
`border_color`	color	`na`
`border_width`	num	`1`
`text`	text	`""`
`ray`	num	`ray.none`
`by`	num	`anchor.bar`

draw.zone.delete

script.qs

draw.zone.delete(id)

Deletes the object (unknown ids are ignored with a warning).

Argument	Kind	Default	Notes
`id`	id	required

draw.zone.get

script.qs

draw.zone.get(id) -> (left, top, right, bottom)

Bounds: (left, top, right, bottom).

Argument	Kind	Default	Notes
`id`	id	required

Returns 4 values: left, top, right, bottom.

draw.zone.update

script.qs

draw.zone.update(id, left = na, top = na, right = na, bottom = na, color = na, text = )

Changes the given fields.

Argument	Kind	Default
`id`	id	required
`left`	num	`na`
`top`	num	`na`
`right`	num	`na`
`bottom`	num	`na`
`color`	color	`na`
`text`	text	`""`

Appearance

draw: drawing objects

draw.path.create

draw.path.delete

draw.path.update

draw.segment.create

draw.segment.delete

draw.segment.get

draw.segment.update

draw.segment.y_at

draw.table.cell

draw.table.clear

draw.table.create

draw.table.delete

draw.table.from

draw.table.merge

draw.table.update

draw.tag.create

draw.tag.delete

draw.tag.get

draw.tag.update

draw.zone.create

draw.zone.delete

draw.zone.get

draw.zone.update