Interface: CreateShapeOptionsBase<TOverrides>
Charting Library.CreateShapeOptionsBase
Options for creating a drawing.
Type parameters
| Name | Type |
|---|---|
TOverrides | extends object |
Hierarchy
-
CreateShapeOptionsBase
Properties
disableSave
• Optional disableSave: boolean
Disable/enable saving the drawing.
disableSelection
• Optional disableSelection: boolean
Disable/enable selecting the drawing.
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.
filled
• Optional filled: boolean
Enable/disable filling the drawing with color (if the drawing supports filling).
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.
lock
• Optional lock: boolean
Should drawing be locked
overrides
• Optional overrides: TOverrides
Drawing properties overrides. Refer to Drawing Overrides for more information.
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.
showInObjectsTree
• Optional showInObjectsTree: boolean
Enable/disable showing the drawing in the objects tree.
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.
zOrder
• Optional zOrder: "top" | "bottom"
Create the drawing in front of all other drawings, or behind all other drawings.