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
Disable/enable undoing the creation of the drawing.
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 listed here are supported
Inherited from
lock
• Optional lock: boolean
Should drawing be locked
Inherited from
overrides
• Optional overrides: TOverrides
Drawing properties overrides.
Inherited from
CreateShapeOptionsBase.overrides
ownerStudyId
• Optional ownerStudyId: EntityId
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.
Overrides
CreateShapeOptionsBase.ownerStudyId
shape
• Optional shape: "emoji" | "icon" | "anchored_text" | "anchored_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 drawing
Inherited from
zOrder
• Optional zOrder: "top" | "bottom"
Create the drawing in front of all other drawings, or behind all other drawings.