Objects

Note

Count with arraySize, access with arrayGet; usually to loop and delete/update boxs on barstate.islast. Deleted handles are excluded.

When to use

To bulk-clear/update all boxs on the chart (especially to delete old drawings on each re-run).

Note

Creates an independent clone; changing the copy does not affect the original.

When to use

To make a second box by cloning a similar zone and shifting it.

Note

Marks the box deleted; it is excluded from output at flush time.

When to use

To remove a zone box that is no longer valid.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a box's edge coordinate in another computation.

Note

Draws a rectangle from two corners. The 5th argument is the BORDER color — not the fill; the fill is transparent by default and set with boxSetBgColor. Text is centered by default. Border color (color / boxSetColor / boxSetBorderColor) and fill color (boxSetBgColor) are SEPARATE properties; set both together.

When to use

To highlight a price region (a supply/demand zone, a consolidation range, an area of interest).

Limits

Corners must be single numbers → no bulk-series use, call inside an if block. At most 500 objects per kind are kept (FIFO). For a fill, use boxSetBgColor rather than the 5th argument.

Not for

If you want a panel fixed in a screen corner, use tableNew rather than a box (a box scrolls with price).

Tip

Border color (color / boxSetColor / boxSetBorderColor) and fill color (boxSetBgColor) are SEPARATE properties; set both together.

Note

Sets the box's INTERIOR fill color. The fill is transparent by default; usually you pass an alpha color like #rrggbbAA.

When to use

To shade a region so it stands out.

Note

Sets the box's border color (the borderColor property). Serves the same purpose as boxSetColor; use it when you want to color the border explicitly.

When to use

To set the border color independently of the fill.

Note

Sets the border style. A non-string value is a no-op.

When to use

To distinguish a projected/tentative zone with a dashed border.

Note

Sets the border thickness (rounded to an integer). A non-numeric value is a no-op.

When to use

To emphasize an important zone with a thicker border.

Note

Moves the bottom edge (price2) to the given price.

When to use

To align a single edge (bottom edge) of the box without disturbing the others.

Note

Sets the bottom-right corner from a chartPoint (bar2/price2).

When to use

To bind the box's bottom-right corner in a point-based drawing flow.

Note

Changes the box border color. Not the fill — use boxSetBgColor for that. A non-string value is a no-op.

When to use

To recolor the box outline by state.

Note

Extends the box horizontally beyond its edges. A non-string value is a no-op.

When to use

To extend a zone to the right (future) to see upcoming tests.

Note

Moves the left edge (bar1) to the given bar.

When to use

To align a single edge (left edge) of the box without disturbing the others.

Note

Sets the top-left corner (bar1 + price1) in one call; targets the same corner as boxSetXy1.

When to use

To set the top-left corner by both bar and price.

Note

Moves the right edge (bar2) to the given bar.

When to use

To align a single edge (right edge) of the box without disturbing the others.

Note

Sets the bottom-right corner (bar2 + price2) in one call.

When to use

To set the bottom-right corner by both bar and price.

Note

Changes the box text. A non-string value is a no-op.

When to use

To label a zone box (e.g. 'Supply', 'Demand', the range width).

Note

Sets the box text color. A non-string value is a no-op.

When to use

To keep the text legible over the fill (a contrast color).

Note

Sets the box text's font family. A non-string value is a no-op.

When to use

When you want a monospace font so numeric text aligns.

Note

Applies bold/italic formatting to the box text. A non-string value is a no-op.

When to use

To emphasize the box heading in bold.

Note

Sets the text's horizontal alignment inside the box. A non-string value is a no-op.

When to use

To pin the text to one side of the box.

Note

Sets the text size. A name maps to its pixel equivalent; a number is clamped to 7–40.

When to use

To enlarge the box label so it stands out.

Note

Sets the text's vertical alignment inside the box. A non-string value is a no-op.

When to use

To pin the text to the top/bottom of the box.

Note

Turns line wrapping on/off so long text fits the box width. A non-string value is a no-op.

When to use

To break long text that overflows the box into multiple lines.

Note

Moves the top edge (price1) to the given price.

When to use

To align a single edge (top edge) of the box without disturbing the others.

Note

Sets the top-left corner from a chartPoint (bar1/price1); a missing field on the point is skipped.

When to use

To bind a box corner in a point-based drawing flow.

Note

Sets the box's horizontal placement unit (bar order or timestamp). A non-string value is a no-op.

When to use

Use bar_time when you want placement to hold across timeframes.

Note

Moves the box's FIRST corner (top-left: bar1, price1) together. If price is omitted, only the bar moves.

When to use

To reposition the top-left corner of a zone box.

Note

Moves the box's SECOND corner (bottom-right: bar2, price2) together.

When to use

To extend the box's right edge as bars advance.

Note

Copies all fields (index/time/price) of a chartPoint; changing the copy does not affect the original.

When to use

To derive a second point from the same base and shift its price slightly.

Note

Builds a chartPoint from index + price; it carries no time, so it suits bar_index placement.

When to use

To build a point by bar order without needing a timestamp.

Note

Builds a chartPoint from time + price; it suits bar_time placement (alignment holds across timeframes).

When to use

To anchor a point by timestamp so it stays in the same place across timeframes.

Note

Produces an {index, time, price} record used by the point-based APIs of lines/boxes/labels. If price is a series its last value is taken; if index is omitted the last bar is used.

When to use

To create a drawing point once and bind it via lineSetFirstPoint/boxSetTopLeftPoint/labelSetPoint.

Note

Builds a chartPoint from the current (last) bar's index + the given price; the most common shortcut in live drawings.

When to use

To attach a drawing's end to the current bar (e.g. the second point of lineNew).

Note

Count with arraySize, access with arrayGet; usually to loop and delete/update labels on barstate.islast. Deleted handles are excluded.

When to use

To bulk-clear/update all labels on the chart (especially to delete old drawings on each re-run).

Note

Creates an independent clone; changing the copy does not affect the original.

When to use

To make a second same-styled label at a different position.

Note

Marks the label deleted; it is excluded from output at flush time. Later calls on a deleted handle have no effect.

When to use

To remove a label from the chart when its condition no longer holds.

Note

Read-only; does not mutate the label.

When to use

To read a label's text and reuse it in another drawing.

Note

Read-only; returns the raw x value in the xloc unit (no resolution). Returns na if unset.

When to use

To use the bar a label sits on in another computation.

Note

Read-only; does not mutate the label.

When to use

To use a label's price level in another computation.

Note

Usually called inside a conditional block: if cond { e = labelNew(...) }. Text is white and the style is fixed downward-pointing (label_down); you set only price, text, bar, color and size. Keep the handle and you can update the same label instead of recreating it. Store the handle in a var variable and update it with labelSetText/labelSetXy instead of creating a new label; that keeps a single label on the chart.

When to use

For a label you will update later (change its text/position/color); ideal for a single live readout pinned to the last bar — update the handle instead of spawning a new label each bar.

Limits

The bar value must be a single number → passing a series directly in a vector run fails; call it bar by bar inside an if block. At most 500 labels are kept on the chart; call it unconditionally on every bar and new labels pile up while the oldest are dropped.

Not for

Not for a fixed shape repeated on every bar — plotshape/plotchar are lighter for that. For a summary pinned in a screen corner that does not scroll, use tableNew. Do not call it unconditionally on every bar; it creates a fresh label each bar, hits the 500 limit and old labels disappear.

Tip

Store the handle in a var variable and update it with labelSetText/labelSetXy instead of creating a new label; that keeps a single label on the chart.

Note

Sets the label background color. Passing na (None) hides the box (only the text remains); a string applies the color.

When to use

To recolor the label by state, or hide its box leaving only the text.

Note

Positions the label from a chartPoint: bar index, time and price are all written (time is preserved).

When to use

To bind a label to a point in a point-based drawing flow.

Note

Sets the label font size. A name maps to its pixel equivalent; a number is clamped to 7–40.

When to use

To enlarge an important label so it stands out.

Note

Sets the label's style. Box-arrow styles (label_up/down/left/right) show text in a box; none draws only the text; shape styles (label_circle/square/diamond/triangleup/triangledown/arrowup/arrowdown/cross/xcross/flag) draw a small shape at the anchor with text above. An unrecognized value falls back to label_down and produces a warning.

When to use

To point the label's arrow up/down relative to the bar (e.g. label_down for a top, label_up for a bottom).

Note

Changes the label text. A non-string value is a no-op. Ideal for keeping a handle and updating the text without creating a new label each bar.

When to use

To update the text of a live readout label pinned to the last bar.

Note

Sets the label text's font family. A non-string value is a no-op.

When to use

When you want a monospace font so numeric labels align.

Note

Applies bold/italic formatting to the label text. A non-string value is a no-op.

When to use

To emphasize an important label in bold.

Note

Sets the alignment of multi-line label text. A non-string value is a no-op.

When to use

To align multi-line label text.

Note

Sets the label text color. Passing na (None) hides the text; a string applies the color.

When to use

To keep the text legible over the background (a contrast color).

Note

Adds a tooltip to the label that appears on hover. A non-string value is a no-op.

When to use

To show extra detail in a tooltip that does not fit in a short label.

Note

Changes only the label's horizontal position; the price is untouched. x is written in the label's xloc unit.

When to use

To slide the label to another bar while keeping its price.

Note

Changes the label's horizontal location unit AND rewrites x in that new unit (three arguments: label, x, xloc). Only bar_index/bar_time are accepted as valid modes.

When to use

When you want to switch the label to bar_time and anchor it by timestamp.

Note

Moves the label both horizontally (bar) and vertically (price). The x value is written in the label's xloc unit (bar_index → barIndex, bar_time → time).

When to use

To move a live label to the last bar and current price.

Note

Changes only the label's vertical (price) position. Passing na (None) drops the price (meaningful with abovebar/belowbar yloc).

When to use

To update the label's price level while keeping its bar.

Note

Sets the label's vertical placement: price uses the price level, abovebar/belowbar pins above/below the bar (the price argument is ignored in those modes). Only one of the three values is valid.

When to use

To pin the label above/below the bar independent of the price level.

Note

Count with arraySize, access with arrayGet; usually to loop and delete/update lines on barstate.islast. Deleted handles are excluded.

When to use

To bulk-clear/update all lines on the chart (especially to delete old drawings on each re-run).

Note

Creates an independent clone; changing the copy does not affect the original. Returns na for an invalid handle.

When to use

To make a parallel channel or a second level by cloning a line and shifting it slightly.

Note

Marks the line deleted — it is excluded from the output list at flush time. Later calls on a deleted handle have no effect.

When to use

To remove a line that is no longer valid (e.g. delete the line when support breaks).

Note

Treats the line as a straight line and computes its y value at the requested bar — works beyond the endpoints too (extrapolation). Returns na for an invalid handle.

When to use

To compare price against a trendline's value at a specific bar for a break/touch test.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a line's endpoint coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a line's endpoint coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a line's endpoint coordinate in another computation.

Note

Read-only; does not mutate the handle. Returns na for an invalid handle.

When to use

To use a line's endpoint coordinate in another computation.

Note

Draws a free line between two (bar, price) pairs. Width defaults to 1 (change to 1–4 via lineSetWidth) and extension is off (turn on with lineSetExtend). Usually called inside a conditional block; keep the handle to update the same line instead of recreating it. Store the handle in a var variable and extend the second endpoint with lineSetXy2 instead of creating a new line each bar; that grows a single line.

When to use

For any drawing that connects two points — support/resistance, a trendline, a channel edge, or joining a swing high to a low. You can pass a chartPoint in place of a point pair (it is auto-expanded).

Limits

bar1/bar2 must be single numbers → passing a series directly in a vector run fails; call it bar by bar inside an if block. width is clamped to 1–4. At most 500 lines are kept on the chart; call it unconditionally every bar and new lines pile up while the oldest are dropped (FIFO).

Not for

Not for a continuous curve computed on every bar — use plot for that. For a fixed horizontal level, hline is lighter. To shade between two lines, use linefillNew.

Tip

Store the handle in a var variable and extend the second endpoint with lineSetXy2 instead of creating a new line each bar; that grows a single line.

Note

Changes the line color. Only a string (color) argument is applied; a number/na is a no-op.

When to use

To recolor a line by state (e.g. a support line that turns green/red by condition).

Note

Extends the line beyond its endpoints. The value is lowercased; anything other than none/right/left/both is a no-op. Default is none.

When to use

To project a trend/support line into the future (right) to see upcoming touches.

Note

Sets the first endpoint from a chartPoint: if the point's bar and price fields are present, bar1/price1 update (missing fields are skipped).

When to use

To attach points produced by chartPointNew/chartPointNow to a line (a point-based drawing flow).

Note

Sets the second endpoint from a chartPoint (bar2/price2).

When to use

To update the line's end in a point-based drawing flow.

Note

Changes the line style. For arrow_* styles the arrowhead is always drawn solid (even if the line is dashed/dotted). A non-string value is a no-op.

When to use

To visually distinguish line kinds (e.g. a dashed line for a projected level, an arrowhead to show direction).

Note

Sets the width. The value is clamped to 1–4 (1 is thinnest). A non-numeric value is a no-op.

When to use

To emphasize an important level with a thick line.

Note

Changes only the HORIZONTAL position (bar1) of the first endpoint; the price is untouched.

When to use

When you want to slide the start bar while keeping the price end fixed.

Note

Changes only the second endpoint's bar index (bar2).

When to use

To slide where the line ends while keeping its price.

Note

Sets the line's horizontal placement unit: bar_index places by bar order, bar_time by timestamp.

When to use

Use bar_time mode when you want the placement to hold across different timeframes.

Note

Moves the FIRST endpoint (bar1, price1) together. If price is omitted, only the bar moves. Mutates the handle in place — no new line.

When to use

For lines whose one end you track live (e.g. keeping a dynamic trendline start fixed while updating its endpoint).

Note

Moves the SECOND endpoint (bar2, price2) together. If price is omitted, only the bar updates.

When to use

To extend or update where the line ends as new bars arrive.

Note

Changes only the VERTICAL position (price1) of the first endpoint. If you pass a series, its value at the line's current bar1 index is used.

When to use

To realign the line's start level while keeping its bar position.

Note

Changes only the second endpoint's price level (price2).

When to use

To realign the line's end level.

Note

Marks the fill deleted; it is excluded from output at flush time. The underlying lines are not deleted.

When to use

To remove only the fill while keeping the lines.

Note

Read-only; returns the first line handle passed when creating the fill (you can then modify that line separately).

When to use

To reach one edge line of the fill and change its color/position.

Note

Read-only; returns the second line handle passed when creating the fill.

When to use

To reach the fill's upper edge line.

Note

Shades the area between two lines; both arguments must be line handles or it errors. You usually pass an alpha color (e.g. #2962ff22).

When to use

To shade a channel or band defined by two lines.

Limits

Arguments must be lines; another object type fails. At most 500 objects per kind are kept (FIFO).

Note

Changes the fill color. A non-string value is a no-op.

When to use

To recolor the channel fill by state.

Note

Count with arraySize, access with arrayGet; usually to loop and delete/update polylines on barstate.islast. Deleted handles are excluded.

When to use

To bulk-clear/update all polylines on the chart (especially to delete old drawings on each re-run).

Note

Marks the polyline deleted; it is excluded from output at flush time.

When to use

To remove a pattern polyline that is no longer valid.

Note

Connects points taken from two arrays (bar + price) in order; it uses as many points as the shorter array. If a price element is a series, its last value is used. width is clamped to 1–4. curved needs at least 3 points to bend; closed connects the last point back to the first (with curved the curve also closes). Both arguments must be arrays; otherwise it errors.

When to use

To draw a zigzag, a wave count or a multi-point pattern as a single drawing object.

Limits

Arrays should be equal length (the shorter one wins). At most 500 objects per kind are kept (FIFO).

Note

Changes the polyline color. A non-string value is a no-op.

When to use

To recolor a pattern polyline by state.

Note

Count with arraySize, access with arrayGet; usually to loop and delete/update tables on barstate.islast. Deleted handles are excluded.

When to use

To bulk-clear/update all tables on the chart (especially to delete old drawings on each re-run).

Note

Writes text into the (column, row) cell; text and fill settings can be given by position or by name (text_color = ...). If the text is a number/series it is auto-converted (a float is trimmed to 4 decimals, a series takes its last value). The older form that puts colours in slots 5 and 6 — tableCell(t, 0, 0, "Trend", "#ffffff", "#26a69a") — keeps working; a number in those slots means width/height.

When to use

To fill the cells of a panel opened with tableNew.

Limits

Column/row indexes are 0-based and must stay within the table's declared size.

Note

Sets a single cell's fill (background) color. A non-string value is a no-op.

When to use

To color a specific value by state (e.g. positive → green cell).

Note

Sets a single cell's height as a percentage (0 = automatic). A non-numeric value is a no-op.

When to use

To pin a row to a specific height.

Note

Changes an existing cell's text; the cell is created if absent. A number/series text is auto-converted.

When to use

To update a single cell without rebuilding the whole panel.

Note

Sets a single cell's text color. A non-string value is a no-op.

When to use

To color a value by its sign.

Note

Sets a single cell's font family. A non-string value is a no-op.

When to use

To align a numeric column with a monospace font.

Note

Applies bold/italic formatting to a single cell. A non-string value is a no-op.

When to use

To render a header or key value in bold.

Note

Sets a single cell's horizontal text alignment. A non-string value is a no-op.

When to use

To right-align numeric values for a tidy column.

Note

Sets a single cell's text size. A name maps to its pixel equivalent; a number is clamped to 7–40.

When to use

To render a header or key value larger.

Note

Sets a single cell's vertical text alignment. A non-string value is a no-op.

When to use

To pin cell text to the top/bottom.

Note

Adds a hover tooltip to a single cell. A non-string value is a no-op.

When to use

To provide detail that does not fit a compact cell via a tooltip.

Note

Sets a single cell's width as a percentage (0 = automatic). A non-numeric value is a no-op.

When to use

To pin a column to a specific width.

Note

With only the table, every cell is cleared. With column/row bounds, only that rectangle is cleared; the table object and its position remain in both cases. Clears all cell contents of the table; the table object and its position remain and can be refilled.

When to use

To rebuild the panel from scratch on each update.

Note

Marks the table deleted; it is excluded from output at flush time.

When to use

To remove the panel entirely when a condition no longer holds.

Note

Merges the cells in the (c1,r1)–(c2,r2) rectangular range; handy for header rows.

When to use

To span a header across multiple columns.

Note

Create it with tableNew, write cells with tableCell. The position is fixed to the chart (not tied to a bar); it stays in place when the chart scrolls.

When to use

For a fixed summary or readout panel in a corner of the screen. If you need text tied to a bar, use label.

Limits

Cell indexes are 0-based and must stay within the declared size. The table does not scale with the chart's values; it is a fixed corner box.

Not for

Not for text tied to a specific bar and sitting at a price level — use label for that. To draw a line or shape over the chart, prefer plot or plotshape. The table is a fixed corner box; do not use it for anything that should move with price as you scroll and zoom.

Note

Sets the table's overall background color. A non-string value is a no-op.

When to use

To give the whole panel a common background color.

Note

Sets the color of the borders (grid) between cells. A non-string value is a no-op.

When to use

To make the panel grid visible.

Note

Sets the thickness of the cell border lines (integer). A non-numeric value is a no-op.

When to use

To thicken the grid lines for emphasis.

Note

Sets the color of the table's OUTER frame (separate from the cell borders). A non-string value is a no-op.

When to use

To bound the panel with an outer frame.

Note

Sets the outer frame thickness (integer). A non-numeric value is a no-op.

When to use

To thicken the outer frame for a bolder panel.

Note

Changes the table's corner/position on screen. A non-string value is a no-op.

When to use

To move the panel to a corner that does not cover price.