Interface: CreateShapeOptions<TOverrides>
Charting Library.CreateShapeOptions
Options for creating a drawing.
Type parameters
| Name | Type |
|---|---|
TOverrides | extends object |
Hierarchy
-
CreateShapeOptionsBase<TOverrides>↳
CreateShapeOptions
Properties
disableSave
Optional
disableSave: boolean
Disable/enable saving the drawing.
Inherited from
CreateShapeOptionsBase.disableSave
disableSelection
Optional
disableSelection: boolean
Disable/enable selecting the drawing.
Inherited from
CreateShapeOptionsBase.disableSelection
disableUndo
Optional
disableUndo: boolean
If true, users cannot cancel the drawing creation in the UI. However, users can still click the Undo button to cancel previous actions.
Inherited from
CreateShapeOptionsBase.disableUndo
filled
Optional
filled: boolean
Enable/disable filling the drawing with color (if the drawing supports filling).
Inherited from
icon
Optional
icon: number
Specify an icon to render. Only icons from the Drawings list are supported. Note that the value should be a hex number, not a string.
Inherited from
lock
Optional
lock: boolean
Should drawing be locked
Inherited from
overrides
Optional
overrides: TOverrides
Drawing properties overrides. Refer to Drawing Overrides for more information.
Inherited from
CreateShapeOptionsBase.overrides
ownerStudyId
Optional
ownerStudyId: EntityId
The ID of an indicator that the drawing is attached to. For more information, refer to the Attach drawing to indicator section.
Overrides
CreateShapeOptionsBase.ownerStudyId
shape
Optional
shape: "emoji" | "text" | "icon" | "anchored_text" | "anchored_note" | "note" | "sticker" | "arrow_up" | "arrow_down" | "flag" | "vertical_line" | "horizontal_line" | "long_position" | "short_position"
A drawing to create.
showInObjectsTree
Optional
showInObjectsTree: boolean
Enable/disable showing the drawing in the objects tree.
Inherited from
CreateShapeOptionsBase.showInObjectsTree
text
Optional
text: string
Text for a drawing.
For long_positions and short_positions (shape), the text is generated automatically based on the drawing's inputs and position.
Do not set this property for these drawing types as doing so will throw Error: Value is undefined.
Inherited from
zOrder
Optional
zOrder: "top" | "bottom"
Create the drawing in front of all other drawings, or behind all other drawings.