igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
368 lines (367 loc) • 12.8 kB
JavaScript
import { __extends } from "tslib";
import { AnnotationAppearanceMode_$type } from "./AnnotationAppearanceMode";
import { PenLineCap_$type } from "igniteui-react-core";
import { IgrSeries } from "./igr-series";
import { ensureBool, fromPoint, toPoint, ensureEnum, toDoubleCollection, fromDoubleCollection } from "igniteui-react-core";
/**
* Represents the base class for annotation layer types. Annotations will usually disable some of the default hover/touch behaviors of the chart when they are introduced to the series collection.
* In return they provide some valuable information as the cursor is moved by hovering over the chart, or performing a press-hold-drag interaction in touch mode.
*/
var IgrAnnotationLayer = /** @class */ /*@__PURE__*/ (function (_super) {
__extends(IgrAnnotationLayer, _super);
function IgrAnnotationLayer(props) {
return _super.call(this, props) || this;
}
Object.defineProperty(IgrAnnotationLayer.prototype, "i", {
/**
* @hidden
*/
get: function () {
return this._implementation;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "useIndex", {
/**
* Gets or sets whether this series should take up an index for auto brush coloring.
*/
get: function () {
return this.i.xv;
},
set: function (v) {
this.i.xv = ensureBool(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "useLegend", {
/**
* Gets or sets whether this series interacts with the chart legend.
*/
get: function () {
return this.i.xw;
},
set: function (v) {
this.i.xw = ensureBool(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "cursorPosition", {
/**
* Gets or sets the world position to use instead of the pointer position for this annotation layer. If you set this value, rather than responding to the pointer, this layer will be fixed on the provided world position.
* A world position has x and y values that range from 0 to 1 that represent the global position of the cursor relative to the entire ranges of the axes. The default of (NaN, NaN) means that the layer should react to pointer movement.
*/
get: function () {
return fromPoint(this.i.aae);
},
set: function (v) {
this.i.aae = toPoint(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "isDefaultCrosshairDisabled", {
/**
* Gets or sets whether the series viewer's default crosshair should be disabled by the presence of this layer.
*/
get: function () {
return this.i.xq;
},
set: function (v) {
this.i.xq = ensureBool(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "isDefaultCrosshairBehaviorDisabled", {
/**
* Gets whether or not the default crosshair behavior is disabled.
*/
get: function () {
return this.i.e3;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "appearanceMode", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.xc;
},
set: function (v) {
this.i.xc = ensureEnum(AnnotationAppearanceMode_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualAppearanceMode", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.w9;
},
set: function (v) {
this.i.w9 = ensureEnum(AnnotationAppearanceMode_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "shiftAmount", {
/**
* Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.
*/
get: function () {
return this.i.x9;
},
set: function (v) {
this.i.x9 = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualShiftAmount", {
/**
* Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.
*/
get: function () {
return this.i.xy;
},
set: function (v) {
this.i.xy = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "horizontalAppearanceMode", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.xj;
},
set: function (v) {
this.i.xj = ensureEnum(AnnotationAppearanceMode_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualHorizontalAppearanceMode", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.xa;
},
set: function (v) {
this.i.xa = ensureEnum(AnnotationAppearanceMode_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "verticalAppearanceMode", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.xk;
},
set: function (v) {
this.i.xk = ensureEnum(AnnotationAppearanceMode_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualVerticalAppearanceMode", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.xb;
},
set: function (v) {
this.i.xb = ensureEnum(AnnotationAppearanceMode_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "horizontalShiftAmount", {
/**
* Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.
*/
get: function () {
return this.i.x8;
},
set: function (v) {
this.i.x8 = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualHorizontalShiftAmount", {
/**
* Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.
*/
get: function () {
return this.i.xx;
},
set: function (v) {
this.i.xx = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "verticalShiftAmount", {
/**
* Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.
*/
get: function () {
return this.i.ya;
},
set: function (v) {
this.i.ya = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualVerticalShiftAmount", {
/**
* Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.
*/
get: function () {
return this.i.xz;
},
set: function (v) {
this.i.xz = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "horizontalDashArray", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return fromDoubleCollection(this.i.aaa);
},
set: function (v) {
this.i.aaa = toDoubleCollection(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualHorizontalDashArray", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return fromDoubleCollection(this.i.z2);
},
set: function (v) {
this.i.z2 = toDoubleCollection(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "verticalDashArray", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return fromDoubleCollection(this.i.aab);
},
set: function (v) {
this.i.aab = toDoubleCollection(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualVerticalDashArray", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return fromDoubleCollection(this.i.z3);
},
set: function (v) {
this.i.z3 = toDoubleCollection(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualDashArray", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return fromDoubleCollection(this.i.z1);
},
set: function (v) {
this.i.z1 = toDoubleCollection(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "actualDashCap", {
/**
* Gets or sets the mode used for shifting the annotation layer color based on the target series.
*/
get: function () {
return this.i.aac;
},
set: function (v) {
this.i.aac = ensureEnum(PenLineCap_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "isIndexed", {
/**
* Gets if the series uses an index, which can be used to auto-assign it a color.
*/
get: function () {
return this.i.fh;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "isUsableInLegend", {
/**
* Gets if the series should appear in any legends.
*/
get: function () {
return this.i.isUsableInLegend;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "isAnnotationLayer", {
/**
* Gets whether this series is an annotation layer.
*/
get: function () {
return this.i.eu;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrAnnotationLayer.prototype, "shouldRenderAsOverlay", {
/**
* Gets or sets whether this layer renders as an overlay or not.
*/
get: function () {
return this.i.xu;
},
set: function (v) {
this.i.xu = ensureBool(v);
},
enumerable: false,
configurable: true
});
return IgrAnnotationLayer;
}(IgrSeries));
export { IgrAnnotationLayer };