igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
385 lines (384 loc) • 12.4 kB
JavaScript
import { ValueLayerValueMode_$type } from "./ValueLayerValueMode";
import { IgrSeries } from "./igr-series";
import { IgrAxis } from "./igr-axis";
import { IgrAnnotationLayer } from "./igr-annotation-layer";
import { ValueLayer } from "./ValueLayer";
import { ensureBool, ensureEnum, brushToString, stringToBrush, toPoint } from "igniteui-react-core";
/**
* Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.
*/
export class IgrValueLayer extends IgrAnnotationLayer {
createImplementation() {
return new ValueLayer();
}
/**
* @hidden
*/
get i() {
return this._implementation;
}
constructor(props) {
super(props);
}
/**
* Gets whether the series is an crosshair annotation layer.
*/
get isAnnotationValueLayer() {
return this.i.eu;
}
/**
* Gets or sets the value mode for the overlay.
*/
get valueMode() {
return this.i.aaf;
}
set valueMode(v) {
this.i.aaf = ensureEnum(ValueLayerValueMode_$type, v);
}
/**
* Gets or sets the color to use for the horizontal line. Leave null for an automatic value.
*/
get horizontalLineStroke() {
return brushToString(this.i.ac7);
}
set horizontalLineStroke(v) {
this.i.ac7 = stringToBrush(v);
}
/**
* Gets or sets the color to use for vertical line. Leave null for an automatic value.
*/
get verticalLineStroke() {
return brushToString(this.i.ac8);
}
set verticalLineStroke(v) {
this.i.ac8 = stringToBrush(v);
}
/**
* Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously.
*/
get targetSeriesName() {
return this.i.aa9;
}
set targetSeriesName(v) {
this.i.aa9 = v;
}
/**
* Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.
*/
get targetSeries() {
const r = this.i.aad;
if (r == null) {
return null;
}
if (!r.externalObject) {
let e = IgrSeries._createFromInternal(r);
if (e) {
e._implementation = r;
}
r.externalObject = e;
}
return r.externalObject;
}
set targetSeries(v) {
if (v != null && this._stylingContainer && v._styling)
v._styling(this._stylingContainer, this, this);
v == null ? this.i.aad = null : this.i.aad = v.i;
}
/**
* Gets or sets the name of the axis to target this annotation to. If null, this annotation targets all axis simultaneously.
*/
get targetAxisName() {
return this.i.aa6;
}
set targetAxisName(v) {
this.i.aa6 = v;
}
/**
* Gets or sets the axis to target this annotation to. If null, this annotation targets all value axis simultaneously.
*/
get targetAxis() {
const r = this.i.z8;
if (r == null) {
return null;
}
if (!r.externalObject) {
let e = IgrAxis._createFromInternal(r);
if (e) {
e._implementation = r;
}
r.externalObject = e;
}
return r.externalObject;
}
set targetAxis(v) {
if (v != null && this._stylingContainer && v._styling)
v._styling(this._stylingContainer, this, this);
v == null ? this.i.z8 = null : this.i.z8 = v.i;
}
/**
* Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position.
*/
get useInterpolation() {
return this.i.aak;
}
set useInterpolation(v) {
this.i.aak = ensureBool(v);
}
/**
* Gets or sets whether to draw annotations over the axes where the crosshair meets with them.
*/
get isAxisAnnotationEnabled() {
return this.i.aah;
}
set isAxisAnnotationEnabled(v) {
this.i.aah = ensureBool(v);
}
/**
* Sets or gets a function which takes an object that produces a formatted label for the x axis annotation.
*/
get xAxisAnnotationFormatLabel() {
return this.i.z9;
}
set xAxisAnnotationFormatLabel(v) {
this.i.z9 = v;
}
/**
* Sets or gets a function which takes an object that produces a formatted label for the y axis annotation.
*/
get yAxisAnnotationFormatLabel() {
return this.i.aaa;
}
set yAxisAnnotationFormatLabel(v) {
this.i.aaa = v;
}
/**
* Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value.
*/
get xAxisAnnotationTextColor() {
return brushToString(this.i.adb);
}
set xAxisAnnotationTextColor(v) {
this.i.adb = stringToBrush(v);
}
/**
* Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value.
*/
get xAxisAnnotationBackground() {
return brushToString(this.i.ac9);
}
set xAxisAnnotationBackground(v) {
this.i.ac9 = stringToBrush(v);
}
/**
* Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value.
*/
get xAxisAnnotationBackgroundCornerRadius() {
return this.i.aan;
}
set xAxisAnnotationBackgroundCornerRadius(v) {
this.i.aan = +v;
}
/**
* Gets or sets the precision to use displaying values for interpolated crosshair positions.
*/
get xAxisAnnotationInterpolatedValuePrecision() {
return this.i.aaz;
}
set xAxisAnnotationInterpolatedValuePrecision(v) {
this.i.aaz = +v;
}
/**
* Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value.
*/
get xAxisAnnotationOutline() {
return brushToString(this.i.ada);
}
set xAxisAnnotationOutline(v) {
this.i.ada = stringToBrush(v);
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get xAxisAnnotationPaddingLeft() {
return this.i.aap;
}
set xAxisAnnotationPaddingLeft(v) {
this.i.aap = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get xAxisAnnotationPaddingTop() {
return this.i.aar;
}
set xAxisAnnotationPaddingTop(v) {
this.i.aar = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get xAxisAnnotationPaddingRight() {
return this.i.aaq;
}
set xAxisAnnotationPaddingRight(v) {
this.i.aaq = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get xAxisAnnotationPaddingBottom() {
return this.i.aao;
}
set xAxisAnnotationPaddingBottom(v) {
this.i.aao = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get yAxisAnnotationPaddingLeft() {
return this.i.aav;
}
set yAxisAnnotationPaddingLeft(v) {
this.i.aav = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get yAxisAnnotationPaddingTop() {
return this.i.aax;
}
set yAxisAnnotationPaddingTop(v) {
this.i.aax = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get yAxisAnnotationPaddingRight() {
return this.i.aaw;
}
set yAxisAnnotationPaddingRight(v) {
this.i.aaw = +v;
}
/**
* Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.
*/
get yAxisAnnotationPaddingBottom() {
return this.i.aau;
}
set yAxisAnnotationPaddingBottom(v) {
this.i.aau = +v;
}
/**
* Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value.
*/
get xAxisAnnotationStrokeThickness() {
return this.i.aas;
}
set xAxisAnnotationStrokeThickness(v) {
this.i.aas = +v;
}
/**
* Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value.
*/
get yAxisAnnotationTextColor() {
return brushToString(this.i.ade);
}
set yAxisAnnotationTextColor(v) {
this.i.ade = stringToBrush(v);
}
/**
* Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value.
*/
get yAxisAnnotationBackground() {
return brushToString(this.i.adc);
}
set yAxisAnnotationBackground(v) {
this.i.adc = stringToBrush(v);
}
/**
* Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value.
*/
get yAxisAnnotationBackgroundCornerRadius() {
return this.i.aat;
}
set yAxisAnnotationBackgroundCornerRadius(v) {
this.i.aat = +v;
}
/**
* Gets or sets the precision to use displaying values for interpolated crosshair positions.
*/
get yAxisAnnotationInterpolatedValuePrecision() {
return this.i.aa0;
}
set yAxisAnnotationInterpolatedValuePrecision(v) {
this.i.aa0 = +v;
}
/**
* Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value.
*/
get yAxisAnnotationOutline() {
return brushToString(this.i.add);
}
set yAxisAnnotationOutline(v) {
this.i.add = stringToBrush(v);
}
/**
* Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value.
*/
get yAxisAnnotationStrokeThickness() {
return this.i.aay;
}
set yAxisAnnotationStrokeThickness(v) {
this.i.aay = +v;
}
/**
* Gets or sets whether to skip unknown values when searching for series values.
*/
get skipUnknownValues() {
return this.i.aaj;
}
set skipUnknownValues(v) {
this.i.aaj = ensureBool(v);
}
/**
* Gets the effective brush for the current value layer. Can be null for value
* modes that target multiple series.
*/
get actualValueLayerBrush() {
return brushToString(this.i.ac6);
}
set actualValueLayerBrush(v) {
this.i.ac6 = stringToBrush(v);
}
get isSummarizationSupported() {
return this.i.isSummarizationSupported;
}
findByName(name) {
var baseResult = super.findByName(name);
if (baseResult) {
return baseResult;
}
if (this.targetSeries && this.targetSeries.name && this.targetSeries.name == name) {
return this.targetSeries;
}
if (this.targetAxis && this.targetAxis.name && this.targetAxis.name == name) {
return this.targetAxis;
}
return null;
}
_styling(container, component, parent) {
super._styling(container, component, parent);
this._inStyling = true;
if (this.targetSeries && this.targetSeries._styling) {
this.targetSeries._styling(container, component, this);
}
if (this.targetAxis && this.targetAxis._styling) {
this.targetAxis._styling(container, component, this);
}
this._inStyling = false;
}
getSeriesValue(world, useInterpolation, skipUnknowns) {
let iv = this.i.i5(toPoint(world), useInterpolation, skipUnknowns);
return (iv);
}
}