instrument¶
- instrument(name, short_name_or_overlay, description_or_overlay, icon_or_overlay, overlay)[has-table-overload]¶
- Parameters
name (
string
) – Display name of the instrumentshort_name_or_overlay (
string
orboolean
) – Abbreviated name of the instrument. If the value is boolean, then the value is treated as overlay.description_or_overlay (
string
orboolean
) – Description of the instrument. If the value is boolean, then the value is treated as overlay.icon_or_overlay (
string
orboolean
) – Icon of the instrument. If the value is boolean, then the value is treated as overlay.overlay (
boolean
) – If true - the instrument is an overlay for the main plot. Otherwise, the instrument is in a separate panel below the main plot.
This function determines the base parameters of the instrument. It should be called exactly once at the beginning of the script.