QuaScript Documentation

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

param: settings

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

param.bool

script.qs

param.bool(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> bool

Checkbox setting.

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.choice

script.qs

param.choice(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> any

One of several options (texts, or the members of an enum).

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.color

script.qs

param.color(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> color

Color setting.

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.float

script.qs

param.float(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> num

Number setting.

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.int

script.qs

param.int(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> int

Whole-number setting.

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.interval

script.qs

param.interval(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> text

Interval setting (15, 15m, 4h, 1D ...).

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.source

script.qs

param.source(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> series

Price source setting (close, bar.typical, ...).

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.symbol

script.qs

param.symbol(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> text

Symbol setting ("" = chart symbol).

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.text

script.qs

param.text(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> text

Text setting.

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

param.time

script.qs

param.time(default, title = , id = , group = , tooltip = , min = na, max = na, step = na, options = na, row = ) -> num

Date/time setting (UTC epoch seconds).

Argument	Kind	Default
`default`	any	required
`title`	text	`""`
`id`	text	`""`
`group`	text	`""`
`tooltip`	text	`""`
`min`	num	`na`
`max`	num	`na`
`step`	num	`na`
`options`	any	`na`
`row`	text	`""`

Appearance

param: settings

param.bool

param.choice

param.color

param.float

param.int

param.interval

param.source

param.symbol

param.text

param.time