Gets or sets mode or custom rule for adorners clipping
Gets or sets mode or custom rule for adorners clipping
Gets or sets current {@link EDraggingGripPoint}
Gets or sets current {@link EDraggingGripPoint}
Gets or sets the visibility policy for the selection outline / adorner.
Gets or sets the visibility policy for the selection outline / adorner.
Multi-point grips default to the current theme background unless explicitly overridden.
Multi-point grips default to the current theme background unless explicitly overridden.
Gets or sets the grip stroke color.
Gets or sets the grip stroke color.
Gets or sets axis-label corner radius for labels with anchorMode: Axis.
Gets or sets axis-label corner radius for labels with anchorMode: Axis.
Gets or sets axis-label fill for labels with anchorMode: Axis.
Gets or sets axis-label fill for labels with anchorMode: Axis.
Gets or sets axis-label padding for labels with anchorMode: Axis.
Gets or sets axis-label padding for labels with anchorMode: Axis.
Gets or sets axis-label text color for labels with anchorMode: Axis.
Gets or sets axis-label text color for labels with anchorMode: Axis.
Gets or sets visibility policy for axis labels (anchorMode: Axis).
Default is OnInteraction.
Gets or sets visibility policy for axis labels (anchorMode: Axis).
Default is OnInteraction.
Gets or sets span opacity between adjacent axis labels for labels with anchorMode: Axis.
Gets or sets span opacity between adjacent axis labels for labels with anchorMode: Axis.
Gets or sets mode or custom rule for clipping
Gets or sets mode or custom rule for clipping
Get the dragging points that should be enabled for this annotation
Set the dragging points that should be enabled for this annotation
Gets or sets dragging cursor.
Gets or sets dragging cursor.
Gets or sets channel fill color.
Gets or sets channel fill color.
Gets or sets a custom formatter for point/segment labels.
Gets or sets a custom formatter for point/segment labels.
Gets or sets a custom style formatter for point/segment labels.
Gets or sets a custom style formatter for point/segment labels.
Gets or sets the visibility policy for adorner grips.
Gets or sets the visibility policy for adorner grips.
Gets or sets hover cursor.
Gets or sets hover cursor.
Gets or sets idle cursor.
Gets or sets idle cursor.
Editing flag toggled during placement workflow.
Editing flag toggled during placement workflow.
Selection state used to keep adorner visible while placing.
Selection state used to keep adorner visible while placing.
Gets or sets label definitions.
Gets or sets label definitions.
Gets or sets the middle line dash array. undefined means solid line.
Gets or sets the middle line dash array. undefined means solid line.
Gets or sets visibility policy for point labels (anchorMode: Point).
Gets or sets visibility policy for point labels (anchorMode: Point).
Gets or sets points.
Gets or sets points.
Gets or sets visibility policy for segment labels (anchorMode: Segment).
Gets or sets visibility policy for segment labels (anchorMode: Segment).
Gets or sets visibility of middle line.
Gets or sets visibility of middle line.
Gets or sets visibility of midpoint grips on top/bottom edges.
Gets or sets visibility of midpoint grips on top/bottom edges.
Backward-compatible snap toggle.
Backward-compatible snap toggle.
Gets or sets init snap behavior.
Gets or sets init snap behavior.
Gets or sets snap radius.
Gets or sets snap radius.
Gets or sets target snap series id.
Gets or sets target snap series id.
Gets or sets stroke color.
Gets or sets stroke color.
Gets or sets dash array for top and bottom lines.
Gets or sets dash array for top and bottom lines.
Gets or sets stroke thickness.
Gets or sets stroke thickness.
TDragPointHost: returns whether body drag can run.
Override this to disable drag behaviour for certain dragging points
Calculates if the annotation is hovered with the specified args
Clamps a number into [0..1].
Called internally. Send a click to the annotation if the point is in bounds, raising the clicked event and optionally selecting the annotation.
Called internally. Select the annotation if the point is in bounds. Does not raise the clicked event
Returns a cloned point array.
For Polar surface converts Cartesian Coordinates to Polar, otherwise returns the original values
Converts an absolute coordinate to a value which could be in form of DataValue, Pixel, or Relative coordinate
an absolute coordinate to convert
the {@link CoordinateCalculatorBase} which will do the transformation
the expected {@link ECoordinateMode} of the converted point
the data-value, pixel, or relative value accordingly to the coordinateMode
For Polar surface converts Polar Coordinates to Cartesian, otherwise returns the original values
is always angle for Polar
is always radius for Polar
Clones a thickness value.
Draws axis labels + spans for explicit axis coordinates in series-view-rect pixels.
Draws axis labels + spans for labels with anchorMode: Axis.
Draws point/segment labels via the texture text rendering path.
Ensures a brush cache exists for the current surface.
Ensures a pen cache exists for the current surface.
Calculates coordinates in pixels of the specified Point. Uses the xCoordinateMode (or yCoordinateMode for vertical chart)
Calculates coordinates in pixels of the specified Point. Uses the xCoordinateMode (or yCoordinateMode for vertical chart)
Calculates coordinate in pixels of the specified value in the vertical dimension. Uses the yCoordinateMode (or xCoordinateMode for vertical chart)
Returns annotation borders for the {@link AdornerLayer} which has the size of the whole canvas
flag to return x and y values in ascending order
Returns annotationBorders
flag to return x and y values in ascending order, where x1 <= x2 and y1 <= y2
Trading annotations have a more modern default grip SVG
Returns a DPI-adjusted overscan amount for geometry that will still be rendered with the real clip rect.
the value to convert
the {@link CoordinateCalculatorBase} which will do the transformation
the {@link ECoordinateMode} to apply
the pixel coordinate
TDragPointHost: grip SVG for point index.
Converts one value-space point to series-view-rect pixel coordinates.
Returns points converted to series-view-rect pixel coordinates.
Returns required point count for placement.
TDragPointHost: gets point position in canvas coords.
TDragPointHost: gets current point by index.
The render layer grouping within which the annotation will be draw. Defaults to EDefaultRenderLayer.AnnotationsAboveSeriesLayer
Returns the pixel coordinate depending whether the chart is vertical
the X {@link CoordinateCalculatorBase} which will do the transformation
the Y {@link CoordinateCalculatorBase} which will do the transformation
the x value
the y value
true to return the x coordinate. false for y.
the pixel coordinate
Returns the target renderable series for snapping.
Allows an annotation to be treated as if it was drawn on a surface with a different draw order than its actual parent surface
Converts a pixel coordinate back to a value
coordinate or dataValue to convert
the {@link CoordinateCalculatorBase} which will do the transformation
the {@link ECoordinateMode} to apply
the data-value or value
Converts mouse canvas point to value coordinates.
Transforms an absolute coordinates point to the corresponding value point. The value point has x and y converted accordingly to the the coordinate modes xCoordinateMode and yCoordinateMode
defines if the coordinates should be projected from the Canvas to SeriesViewRect
a point with coordinates {@link ECoordinateMode}
Returns the pixel X1 coordinate
the X {@link CoordinateCalculatorBase} which will do the transformation
the Y {@link CoordinateCalculatorBase} which will do the transformation
the pixel X1 coordinate
Returns the pixel X2 coordinate
the X {@link CoordinateCalculatorBase} which will do the transformation
the Y {@link CoordinateCalculatorBase} which will do the transformation
the pixel X2 coordinate
Returns the pixel Y1 coordinate
the X {@link CoordinateCalculatorBase} which will do the transformation
the Y {@link CoordinateCalculatorBase} which will do the transformation
the pixel Y1 coordinate
Returns the pixel Y2 coordinate
the X {@link CoordinateCalculatorBase} which will do the transformation
the Y {@link CoordinateCalculatorBase} which will do the transformation
the pixel Y2 coordinate
TDragPointHost: body hit-test in canvas coordinates.
Hit-tests renderable series for snapping.
Sends hover/leave action to the annotation
Inflates a local clip rect so pre-clipped geometry can extend just beyond the rendered clip.
Returns whether body drag is currently allowed.
Sanitizes and clones points, optionally capping count.
Resizes a brush-cache collection to the required count.
Resizes a pen-cache collection to the required count.
Resolves X and Y axis coordinates for labels with anchorMode: Axis.
Resolves axis coordinates for labels with anchorMode: Axis in series-view-rect pixels.
Resolves a brush from cache and reapplies opacity.
Resolves Auto mode to DataPoint or XSlice.
Returns the cursor resolved for current interaction state.
Resolves all labels to pixel positions.
Resolves a pen from cache and reapplies opacity.
TDragPointHost: snap resolver used by drag points.
Resolves snap from a mouse point in canvas coordinates.
Resolves snap from a data point by projecting it to canvas first.
Resolves snap from the most recent mouse drag point.
Internal use. If isHidden,x1,y1 have change since suspendInvalidate was called, call invalidateParent
Sets annotationBorders For renderContext annotations it is scaled and for SVG annotations it is not For example if we have a macbook with retina display and canvas.width = 1600px, canvas.height = 1200px, canvas.style.width = 800px, canvas.style.height = 600px If we have {@link BoxAnnotation} (renderContext) which takes 50% width and height, located in the left-top corner it should have annotationBorders as follows x1 = 0, x2 = 800, y1 = 0, y2 = 600 But if we have {@link CustomAnnotation} (SVG) which takes 50% width and height, located in the left-top corner it should have annotationBorders as follows x1 = 0, x2 = 400, y1 = 0, y2 = 300
Replaces all placement points.
TDragPointHost: sets one point by index.
The render layer grouping within which the series will be draw. Defaults to EDefaultRenderLayer.AnnotationsAboveSeriesLayer
Allows an annotation to be treated as if it was drawn on a surface with a different draw order than its actual parent surface
Shared helper to test whether a fill brush should be rendered.
Shared helper to test whether a stroke should be rendered.
Applies optional snap for placement flow.
Internal use. Captures the state of isHidden,x1,y1 and prevents invalidateParent being called on change to these properties
TDragPointHost: translates all points by value-space delta.
Snaps initial points once after attach when enabled.
Updates adorner SVG for selected/hovered states.
Updates annotation borders from a point list in pixel coordinates.
Ensures and refreshes a brush cache.
Ensures and refreshes a pen cache.
the annotation absolute coordinates
Generated using TypeDoc
The ChannelAnnotation provides a multi-point annotation which draws a parallel price channel over the {@link SciChartSurface}.
To add a ChannelAnnotation to a {@link SciChartSurface}, use the following code:
const sciChartSurface: SciChartSurface; const channelAnnotation = new ChannelAnnotation({ points: [ new Point(0, 5), // can also be written as "{ x: 0, y: 5 }" new Point(10, 7), new Point(10, 3) ], stroke: "#3B82F6", strokeThickness: 2, strokeDashArray: [4, 2], midLineStrokeDashArray: [4, 3], showMidLine: true, showMidPointGrips: true, fill: "#3B82F633" }); sciChartSurface.annotations.add(channelAnnotation);The first two points define one channel line; the third controls the offset.