scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
28 lines (27 loc) • 1.33 kB
TypeScript
/**
* Defines the CoordinateMode for {@link AnnotationBase | Annotations} within SciChart's
* {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
*/
export declare enum ESubSurfacePositionCoordinateMode {
/**
* The {@link AnnotationBase.x1 | Annotation.x1}, {@link AnnotationBase.x2 | x2},
* {@link AnnotationBase.y1 | y1}, {@link AnnotationBase.y2 | y2} coordinate is a data-value,
* corresponding to the value on the {@link AxisBase2D | Axis} or in the
* {@link IRenderableSeries.dataSeries | DataSeries}
*/
DataValue = "DataValue",
/**
* The {@link AnnotationBase.x1 | Annotation.x1}, {@link AnnotationBase.x2 | x2},
* {@link AnnotationBase.y1 | y1}, {@link AnnotationBase.y2 | y2} coordinate is a pixel coordinate,
* corresponding to the distance from the top-left of the
* {@link SciChartSurface}
*/
Pixel = "Pixel",
/**
* The {@link AnnotationBase.x1 | Annotation.x1}, {@link AnnotationBase.x2 | x2},
* {@link AnnotationBase.y1 | y1}, {@link AnnotationBase.y2 | y2} coordinate is relative,
* where 0.0 corresponds to the left (or top) of the {@link SciChartSurface}
* and 1.0 corresponds to the right (or bottom) of the {@link SciChartSurface}
*/
Relative = "Relative"
}