Skip to main content
Version: v26

CreateShapeOptions<TOverrides>

Interface

Options for creating a drawing.

Type parameters

NameType
TOverridesextends object

Properties

disableSave

Optional

Disable/enable saving the drawing.

Type

boolean


disableSelection

Optional

Disable/enable selecting the drawing.

Type

boolean


disableUndo

Optional

Disable/enable undoing the creation of the drawing.

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 here are supported

Type

number


lock

Optional

Should drawing be locked

Type

boolean


overrides

Optional

Drawing properties overrides.

Type

TOverrides


ownerStudyId

Optional

An optional study ID to be attached to the owner study. It does not mean that both the owner and all possible associated IDs will behave in tandem. Their behavior will be independent.

Type

EntityId

Overrides

CreateShapeOptionsBase.ownerStudyId


shape

Optional

A drawing to create.

Type

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


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"