Create an instance of a HorizontalLineAnnotation
Optional parameters of type ILineAnnotationOptions which configure the annotation upon construction
A unique Id for the IAnnotation
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 axisFontSize for the LineAnnotation
Sets the axisFontSize for the LineAnnotation
Gets the axisFontSize for the LineAnnotation
Sets the axisFontSize for the LineAnnotation
Gets the axisLabelFill for the LineAnnotation
Sets the axisLabelFill for the LineAnnotation
Gets the axisLabelStroke for the LineAnnotation
Sets the axisLabelStroke for the LineAnnotation
Get the dragging points that should be enabled for this annotation
Set the dragging points that should be enabled for this annotation
Defines if the entity is hovered
Defines if the entity is hovered
Gets the labelPlacement for the LineAnnotation
Sets the labelPlacement for the LineAnnotation
Gets the labelValue for the LineAnnotation
Sets the labelValue for the LineAnnotation
Sets an opacity override for the entire annotation, from 0..1
Sets an opacity override for the entire annotation, from 0..1
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
Gets the showLabel for the LineAnnotation
Sets the showLabel for the LineAnnotation
Gets the stroke for the LineAnnotation
Sets the stroke for the LineAnnotation
Gets the strokeDashArray for the LineAnnotation
Sets the strokeDashArray for the LineAnnotation
Gets the strokeThickness for the LineAnnotation
Sets the strokeThickness for the LineAnnotation
x2 property is not supported for HorizontalLineAnnotation
x2 property is not supported for HorizontalLineAnnotation
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 HorizontalLineAnnotation
y2 property is not supported for HorizontalLineAnnotation
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
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
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
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
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
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 HorizontalLineAnnotation provides an Annotation which draws a horizontal line at specific y1 (or x1 for Vertical Chart) over the SciChartSurface
To add a HorizontalLineAnnotation to a SciChartSurface, use the following code:
const sciChartSurface: SciChartSurface; const horizontalLineAnnotation = new HorizontalLineAnnotation( { x1: 1, y1: 3, fill: "#FF000077", stroke: "#FF0000"}); sciChartSurface.annotations.add(horizontalLineAnnotation);Uses the fast WebGL/WebAssembly {@link WebGL2RenderingContext} for rendering