Creates a new Candlestick instance from a MAIDR layer
The MAIDR layer containing candlestick data
Protected ReadonlyobserversProtectedisProtected ReadonlyidProtected ReadonlytypeProtected ReadonlytitleProtected ReadonlyxProtected ReadonlyyProtected ReadonlyzProtected ReadonlylayerProtected ReadonlysupportsAbstract property that subclasses must implement to indicate extrema support
Protected ReadonlymovableProtected ReadonlyhighlightProtectedhighlightProtected ReadonlynavigationGets the current state of the trace including audio, braille, text, and highlight information.
The current TraceState
ProtectedoutProtectedhighlightProtectedautoplayProtectedhasProtectedvaluesGets the 2D array of candlestick values
Array of candlestick values for all segments
ProtectedaudioProtectedbrailleProtectedtextProtecteddimensionProtectedgetGets safe row and column indices to prevent accessing undefined values
Object with safe row and column indices
Registers an observer to receive state updates.
The observer to add
Removes an observer from receiving state updates.
The observer to remove
Notifies all registered observers with the current state.
Notifies observers that an out-of-bounds condition occurred.
Utility function to compare point values for rotor functionality
boolean value
Returns true if this trace supports compare (lower/higher value) navigation. Override to false for trace types that don't use compare modes (e.g., scatter, which is all we currently have).
Returns the display name for the default data navigation mode. Override to provide a trace-specific name (e.g., "ROW AND COLUMN NAVIGATION" for scatter).
Get all highlight SVG elements for this trace Used by HighlightService for high contrast mode
Array of all SVG elements, or empty array if none
Get all original (visible) SVG elements for this trace. These are the actual rendered elements, not the hidden clones used for highlighting. Used by HighlightService for high contrast mode color changes.
Array of all original SVG elements, or empty array if none
ProtectedgetResets the trace to initial entry state
ProtectedfinalizeCommon post-navigation cleanup that should be called by subclasses after they update their internal state
Returns true if this trace supports intersection navigation mode. Opt-in per trace type: override to return true (possibly conditionally, e.g. based on data shape) for trace types that expose point intersections between series. Intersection navigation is a trace-level capability — it has no meaning at the figure or subplot level, which is why it lives on AbstractTrace rather than AbstractPlot.
Move to the next point intersection (right arrow in intersection rotor mode). Default is a no-op returning false; subclasses that advertise supportsIntersectionMode must override to provide real behavior.
Move to the previous point intersection (left arrow in intersection rotor mode). Default is a no-op returning false; subclasses that advertise supportsIntersectionMode must override to provide real behavior.
Checks if this plot supports extrema navigation.
True if extrema navigation is supported
Gets the unique identifier for this trace.
The trace ID
Moves to the nearest point at the specified coordinates (used for hover functionality).
The x-coordinate
The y-coordinate
Checks if the specified coordinates are within bounds of the element.
The x-coordinate
The y-coordinate
Object containing the SVG element and its position
True if the point is in bounds, false otherwise
ProtectedupdateUpdates visual position for point highlighting and segment position
ProtectedhandleHandles initial entry into the candlestick chart, setting default position
Moves navigation position one step in the specified direction
Direction to move (UPWARD, DOWNWARD, FORWARD, BACKWARD)
Checks if movement to the target position or direction is possible
Target position array or movement direction
True if movement is possible, false otherwise
Cleans up resources and disposes of the candlestick instance
ProtectedmapMaps candlestick selectors to 2D array of SVG elements for highlighting
CSS selectors or structured candlestick selectors
2D array of SVG elements or null if no selectors provided
Gets the current candlestick trend for audio palette selection
The trend of the current candlestick point
Gets the current X value from the candlestick trace
The current X value or null if not available
Moves the candlestick to the position that matches the given X value
The X value to move to
True if the position was found and set, false otherwise
Gets extrema targets for the current candlestick trace with labels and descriptions
Array of extrema targets for navigation
Navigates to a specific extrema target
The extrema target to navigate to
Moves to the next value in the specified direction that matches the comparison type
Direction to search (left or right)
Comparison type (lower or higher)
True if a matching value was found and moved to
Moves upward between segments within a candle in rotor mode
True if the move was successful
Moves downward between segments within a candle in rotor mode
True if the move was successful
ProtectedmapMaps SVG elements to their center coordinates for click navigation
Array of center coordinates with row/col indices or null
Finds the nearest candlestick point to the given coordinates
X coordinate
Y coordinate
Nearest point information or null
Interface representing a trace with navigation and observation capabilities