Create an instance of a AxisMarkerAnnotation
Optional parameters of type IAxisMarkerAnnotationOptions which configure the annotation upon construction
A unique Id for the IAnnotation
Gets or sets mode or custom rule for adorners clipping
Gets or sets mode or custom rule for adorners clipping
Gets or sets current EDraggingGripPoint
Gets or sets current EDraggingGripPoint
The fill color for the adorner drag handle
The fill color for the adorner drag handle
The radius of the adorner drag handle
The radius of the adorner drag handle
The stroke color for the adorner drag handle
The stroke color for the adorner drag handle
Gets the color of the background of the AxisMarkerAnnotation as an HTML Color code
Sets the color of the background of the AxisMarkerAnnotation as an HTML Color code
Gets or sets mode or custom rule for clipping
Gets or sets mode or custom rule for clipping
Gets the color of the AxisMarkerAnnotation as an HTML Color code
Sets the color of the AxisMarkerAnnotation as an HTML Color code
Get the dragging points that should be enabled for this annotation
Set the dragging points that should be enabled for this annotation
Gets the fontFamily of the AxisMarkerAnnotation
Sets the fontFamily of the AxisMarkerAnnotation
Gets the fontSize of the AxisMarkerAnnotation
Sets the fontSize of the AxisMarkerAnnotation
Gets the fontStyle of the AxisMarkerAnnotation
Sets the fontStyle of the AxisMarkerAnnotation
Gets the fontWeight of the AxisMarkerAnnotation
Sets the fontWeight of the AxisMarkerAnnotation
Gets the formattedValue of the AxisMarkerAnnotation
Sets the formattedValue of the AxisMarkerAnnotation
Gets or sets the image to draw as an annotation {@link HTMLImageElement}
Gets or sets the image to draw as an annotation {@link HTMLImageElement}
Gets or sets the image height
Gets or sets the image height
Gets or sets the image width
Gets or sets the image width
Defines if the entity is hovered
Defines if the entity is hovered
Sets an opacity override for the entire annotation, from 0..1
Sets an opacity override for the entire annotation, from 0..1
Gets the padding of the AxisMarkerAnnotation
Sets the padding of the AxisMarkerAnnotation
How much bigger the selection box is than the bounding box of the annotation, in pixels
How much bigger the selection box is than the bounding box of the annotation, in pixels
The stroke color for the adorner selection box
The stroke color for the adorner selection box
The thickness of the selection box line
The thickness of the selection box line
x2 property is not supported for AxisMarkerAnnotation
x2 property is not supported for AxisMarkerAnnotation
Gets the bound XAxis for this IAnnotation.
The X-Coordinate mode. See ECoordinateMode for a list of values
The X-Coordinate mode. See ECoordinateMode for a list of values
y2 property is not supported for AxisMarkerAnnotation
y2 property is not supported for AxisMarkerAnnotation
Gets the bound YAxis for this IAnnotation.
The Y-Coordinate mode. See ECoordinateMode for a list of values
The Y-Coordinate mode. See ECoordinateMode for a list of values
Override this to disable drag behaviour for certain dragging points
Calculates if the annotation is hovered with the specified args
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
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 CoordinateCalculatorBase which will do the transformation
the expected 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
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
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 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
Get svg for the adorner grip handles for standard annotations
the value to convert
the CoordinateCalculatorBase which will do the transformation
the ECoordinateMode to apply
the pixel coordinate
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 CoordinateCalculatorBase which will do the transformation
the Y CoordinateCalculatorBase which will do the transformation
the x value
the y value
true to return the x coordinate. false for y.
the pixel coordinate
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 CoordinateCalculatorBase which will do the transformation
the ECoordinateMode to apply
the data-value or value
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 ECoordinateMode
Returns the pixel X1 coordinate
the X CoordinateCalculatorBase which will do the transformation
the Y CoordinateCalculatorBase which will do the transformation
the pixel X1 coordinate
Returns the pixel X2 coordinate
the X CoordinateCalculatorBase which will do the transformation
the Y CoordinateCalculatorBase which will do the transformation
the pixel X2 coordinate
Returns the pixel Y1 coordinate
the X CoordinateCalculatorBase which will do the transformation
the Y CoordinateCalculatorBase which will do the transformation
the pixel Y1 coordinate
Returns the pixel Y2 coordinate
the X CoordinateCalculatorBase which will do the transformation
the Y CoordinateCalculatorBase which will do the transformation
the pixel Y2 coordinate
Sends hover/leave action to the annotation
Used internally - Sets references to X and Y axes
The name of the property which has changed
Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor
The TDpiChangedEventArgs containing info about the Dpi Changed event
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 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 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
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
Internal use. Captures the state of isHidden,x1,y1 and prevents invalidateParent being called on change to these properties
the annotation absolute coordinates
Generated using TypeDoc
The AxisMarkerAnnotation provides an Annotation which draws a marker at specified value on the axis over the SciChartSurface
To add a AxisMarkerAnnotation to a SciChartSurface, use the following code:
const sciChartSurface: SciChartSurface; const AxisMarkerAnnotation = new AxisMarkerAnnotation( { y1: 3, backgroundColor: "#FF000077", color: "#FF0000"}); sciChartSurface.annotations.add(AxisMarkerAnnotation);Uses the fast WebGL/WebAssembly {@link WebGL2RenderingContext} for rendering