CreateShapeOptions<TOverrides>

Interface

Options for creating a 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

Overrides

CreateShapeOptionsBase.ownerStudyId

---

shape

Optional

A drawing to create.

Type

​"emoji" | "icon" | "anchored_text" | "anchored_note" | "sticker" | "arrow_up" | "arrow_down" | "flag" | "vertical_line" | "horizontal_line" | "long_position" | "short_position"

---

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"