CreateMultipointShapeOptions<TOverrides>

Interface

Options for creating a multipoint drawing.

Type parameters

Name	Type
TOverrides	extends object

Properties

disableSave

Optional

Disable/enable saving the drawing.

Type

​boolean

---

disableSelection

Optional

Disable/enable selecting the drawing.

Type

​boolean

---

disableUndo

Optional

If true, users cannot cancel the drawing creation in the UI. However, users can still click the Undo button to cancel previous actions.

Type

​boolean

---

filled

Optional

Enable/disable filling the drawing with color (if the drawing supports filling).

Type

​boolean

---

icon

Optional

Specify an icon to render. Only icons listed in Shapes and Overrides are supported. Note that the value should be a hex number, not a string.

Type

​number

---

lock

Optional

Should drawing be locked

Type

​boolean

---

overrides

Optional

Drawing properties overrides. Refer to Shapes and Overrides for more information.

Type

​TOverrides

---

ownerStudyId

Optional

The ID of an indicator that the drawing is attached to. For more information, refer to the Attach drawing to indicator section.

Type

​EntityId

---

shape

Optional

A drawing to create.

Type

​"emoji" | "triangle" | "curve" | "circle" | "ellipse" | "path" | "polyline" | "text" | "icon" | "extended" | "anchored_text" | "anchored_note" | "note" | "signpost" | "double_curve" | "arc" | "sticker" | "arrow_up" | "arrow_down" | "arrow_left" | "arrow_right" | "price_label" | "price_note" | "arrow_marker" | "flag" | "vertical_line" | "horizontal_line" | "cross_line" | "horizontal_ray" | "trend_line" | "info_line" | "trend_angle" | "arrow" | "ray" | "parallel_channel" | "disjoint_angle" | "flat_bottom" | "anchored_vwap" | "pitchfork" | "schiff_pitchfork_modified" | "schiff_pitchfork" | "balloon" | "comment" | "inside_pitchfork" | "pitchfan" | "gannbox" | "gannbox_square" | "gannbox_fixed" | "gannbox_fan" | "fib_retracement" | "fib_trend_ext" | "fib_speed_resist_fan" | "fib_timezone" | "fib_trend_time" | "fib_circles" | "fib_spiral" | "fib_speed_resist_arcs" | "fib_channel" | "xabcd_pattern" | "cypher_pattern" | "abcd_pattern" | "callout" | "triangle_pattern" | "3divers_pattern" | "head_and_shoulders" | "fib_wedge" | "elliott_impulse_wave" | "elliott_triangle_wave" | "elliott_triple_combo" | "elliott_correction" | "elliott_double_combo" | "cyclic_lines" | "time_cycles" | "sine_line" | "long_position" | "short_position" | "forecast" | "date_range" | "price_range" | "date_and_price_range" | "bars_pattern" | "ghost_feed" | "projection" | "rectangle" | "rotated_rectangle" | "brush" | "highlighter" | "regression_trend" | "fixed_range_volume_profile"

---

showInObjectsTree

Optional

Enable/disable showing the drawing in the objects tree.

Type

​boolean

---

text

Optional

Text for drawing

Type

​string

---

zOrder

Optional

Create the drawing in front of all other drawings, or behind all other drawings.

Type

​"top" | "bottom"