Interface: CreateMultipointShapeOptions<TOverrides>
Charting Library.CreateMultipointShapeOptions
Options for creating a multipoint drawing.
Type parameters
| Name | Type |
|---|---|
TOverrides | extends object |
Hierarchy
-
CreateShapeOptionsBase<TOverrides>↳
CreateMultipointShapeOptions
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 listed in Shapes and Overrides 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 Shapes and 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.
Inherited from
CreateShapeOptionsBase.ownerStudyId
shape
• Optional shape: "emoji" | "triangle" | "curve" | "circle" | "ellipse" | "path" | "polyline" | "text" | "icon" | "extended" | "anchored_text" | "anchored_note" | "note" | "signpost" | "double_curve" | "arc" | "sticker" | "arrow_up" | "arrow_down" | "arrow_left" | "arrow_right" | "price_label" | "price_note" | "arrow_marker" | "flag" | "vertical_line" | "horizontal_line" | "cross_line" | "horizontal_ray" | "trend_line" | "info_line" | "trend_angle" | "arrow" | "ray" | "parallel_channel" | "disjoint_angle" | "flat_bottom" | "anchored_vwap" | "pitchfork" | "schiff_pitchfork_modified" | "schiff_pitchfork" | "balloon" | "comment" | "inside_pitchfork" | "pitchfan" | "gannbox" | "gannbox_square" | "gannbox_fixed" | "gannbox_fan" | "fib_retracement" | "fib_trend_ext" | "fib_speed_resist_fan" | "fib_timezone" | "fib_trend_time" | "fib_circles" | "fib_spiral" | "fib_speed_resist_arcs" | "fib_channel" | "xabcd_pattern" | "cypher_pattern" | "abcd_pattern" | "callout" | "triangle_pattern" | "3divers_pattern" | "head_and_shoulders" | "fib_wedge" | "elliott_impulse_wave" | "elliott_triangle_wave" | "elliott_triple_combo" | "elliott_correction" | "elliott_double_combo" | "cyclic_lines" | "time_cycles" | "sine_line" | "long_position" | "short_position" | "forecast" | "date_range" | "price_range" | "date_and_price_range" | "bars_pattern" | "ghost_feed" | "projection" | "rectangle" | "rotated_rectangle" | "brush" | "highlighter" | "regression_trend" | "fixed_range_volume_profile"
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.