Skip to content
StatePath
Tool Atlasobject.control

Tool

Control

object.control

OutputSink

Inputs

No typed inputs.

Outputs

Bundle (untagged)

A control sink — it draws an interactive object on the terminal chart and outputs nothing. Nothing can be wired from it.

Control puts something on the chart the viewer can press — a button, a number field, an image toggle, a mini-chart panel, or a marker on the time axis. It can show and hide plots, mute alerts, or clear drawn objects.

Control overview diagram

How it works

The control is created once when the indicator starts and stays put through history reloads, so its state survives a chart refresh. Pressing it does not change a single calculated number: the indicator's maths and its buffers are identical whether the control is pressed or not — only what is displayed or announced changes. Show/hide and mute stay on until pressed again; clear fires once per press. Screen-anchored modes are placed by a corner and pixel offsets; the two chart-anchored modes sit on a bar you pick by how far back it is.

Modes

Mode options

Buttonbutton

A labelled screen button.

Button diagram
Number Fieldedit

A screen box holding an editable number.

Number Field diagram
Chart Imagebitmap

A two-state picture pinned to a bar and price.

Chart Image diagram
Image Buttonbitmap_label

A two-state picture pinned to a chart corner.

Image Button diagram
Mini Chartchart

A small chart panel. Not available on MT4.

Mini Chart diagram
Event Markerevent

A marker on the time axis.

Event Marker diagram

Action options

Nonenone

Display only — pressing it changes nothing.

None diagram
Show / Hide Plotstoggle_plots

Hides the plots while pressed, and shows them again when released.

Show / Hide Plots diagram
Mute Alertsmute_alerts

Stops alerts firing while pressed. The plots keep updating.

Mute Alerts diagram
Clear Objectsclear_objects

Removes the drawn objects once, each time it is pressed.

Clear Objects diagram

Corner options

Top Leftleft_upper

Offsets measure from the chart's top-left corner.

Top Left diagram
Top Rightright_upper

Offsets measure from the chart's top-right corner.

Top Right diagram
Bottom Leftleft_lower

Offsets measure from the chart's bottom-left corner.

Bottom Left diagram
Bottom Rightright_lower

Offsets measure from the chart's bottom-right corner.

Bottom Right diagram

Icon options

Eyevisibility

An open eye when released, a crossed-out eye when pressed.

Eye diagram
Bellsound

A bell when released, a muted bell when pressed.

Bell diagram
Playplayback

A play arrow when released, a pause sign when pressed.

Play diagram
Binclear

A bin — the same picture in both states, for a one-shot press.

Bin diagram
Gearsettings

A gear — the same picture in both states.

Gear diagram

Configuration

modeenum

Which control to draw.

Choices:buttoneditbitmapbitmap_labelchartevent
actionenum

What pressing it does.

Choices:nonetoggle_plotsmute_alertsclear_objects
plot_indexscalar

Which plot to show and hide (-1 for all of them).

labelscalar

Text shown on the control.

cornerenum

Chart corner the pixel offsets are measured from.

Choices:left_upperright_upperleft_lowerright_lower
x_offsetscalar

Horizontal offset from the corner, in pixels.

y_offsetscalar

Vertical offset from the corner, in pixels.

width_pxscalar

Control width in pixels.

height_pxscalar

Control height in pixels.

anchor_bars_backscalar

How many bars back the control sits on the time axis (0 = the newest bar).

anchor_pricescalar

Price the image is pinned to; 0 pins it to the newest close.

bg_colorscalar

Background color (#rrggbb).

fg_colorscalar

Text color (#rrggbb).

iconenum

Which pair of pictures the image control uses.

Choices:visibilitysoundplaybackclearsettings
latchingscalar

Stay pressed until pressed again.

initial_statescalar

Whether it starts pressed the first time.

persistscalar

Remember the state across chart reloads.

initial_valuescalar

Number the field starts with.

digitsscalar

Decimal places the number field shows.

Connects to

No direct tool-to-tool connections.

See also