CreateShapeOptions<TOverrides>
Options for creating a drawing.
Type parameters
Name | Type |
---|---|
TOverrides | extends object |
Properties
disableSave
OptionalDisable/enable saving the drawing.
Type
boolean
disableSelection
OptionalDisable/enable selecting the drawing.
Type
boolean
disableUndo
OptionalDisable/enable undoing the creation of the drawing.
Type
boolean
filled
OptionalEnable/disable filling the drawing with color (if the drawing supports filling).
Type
boolean
icon
OptionalSpecify an icon to render - Only icons listed here are supported
Type
number
lock
OptionalShould drawing be locked
Type
boolean
overrides
OptionalDrawing properties overrides.
Type
TOverrides
ownerStudyId
OptionalAn optional study ID of the owner study.
Type
Overrides
CreateShapeOptionsBase.ownerStudyId
shape
OptionalA drawing to create.
Type
"icon" | "anchored_text" | "anchored_note" | "arrow_up" | "arrow_down" | "flag" | "vertical_line" | "horizontal_line" | "long_position" | "short_position"
showInObjectsTree
OptionalEnable/disable showing the drawing in the objects tree.
Type
boolean
text
OptionalText for drawing
Type
string
zOrder
OptionalCreate the drawing in front of all other drawings, or behind all other drawings.
Type
"top" | "bottom"