igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
206 lines (205 loc) • 7.58 kB
JavaScript
import { __extends } from "tslib";
import { IgrSeries } from "./igr-series";
import { CategoryItemHighlightType_$type } from "./CategoryItemHighlightType";
import { MarkerType_$type } from "./MarkerType";
import { IgrAnnotationLayer } from "./igr-annotation-layer";
import { CategoryItemHighlightLayer } from "./CategoryItemHighlightLayer";
import { ensureBool, ensureEnum, brushToString, stringToBrush } from "igniteui-react-core";
/**
* Represents an annotation layer that highlights items in a series that use a category axis
* either by drawing a banded shape at their position, or by rendering a marker at their position.
* Depending on the type of series, the default highlight will be affected. To override
* the type of highlight used, you can set the HighlightType property.
*/
var IgrCategoryItemHighlightLayer = /** @class */ /*@__PURE__*/ (function (_super) {
__extends(IgrCategoryItemHighlightLayer, _super);
function IgrCategoryItemHighlightLayer(props) {
return _super.call(this, props) || this;
}
IgrCategoryItemHighlightLayer.prototype.createImplementation = function () {
return new CategoryItemHighlightLayer();
};
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "i", {
/**
* @hidden
*/
get: function () {
return this._implementation;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "isAnnotationHoverLayer", {
/**
* Gets whether the series is an annotation layer displayed only when hovering over the chart.
*/
get: function () {
return this.i.et;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "targetSeries", {
/**
* Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.
*/
get: function () {
var r = this.i.aae;
if (r == null) {
return null;
}
if (!r.externalObject) {
var e = IgrSeries._createFromInternal(r);
if (e) {
e._implementation = r;
}
r.externalObject = e;
}
return r.externalObject;
},
set: function (v) {
if (v != null && this._stylingContainer && v._styling)
v._styling(this._stylingContainer, this, this);
v == null ? this.i.aae = null : this.i.aae = v.i;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "targetSeriesName", {
/**
* Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously.
*/
get: function () {
return this.i.aas;
},
set: function (v) {
this.i.aas = v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "useInterpolation", {
/**
* Gets or sets whether to use value interpolation when drawing a line through the best value for the pointer position.
*/
get: function () {
return this.i.aai;
},
set: function (v) {
this.i.aai = ensureBool(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "highlightType", {
/**
* Gets or sets which type of highlight shape to use when highlighting items.
*/
get: function () {
return this.i.aab;
},
set: function (v) {
this.i.aab = ensureEnum(CategoryItemHighlightType_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "markerType", {
/**
* Gets or sets which type of marker to use when highlighting items, if appropriate.
*/
get: function () {
return this.i.aad;
},
set: function (v) {
this.i.aad = ensureEnum(MarkerType_$type, v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "markerBrush", {
/**
* Gets or sets which color to use for the marker when highlighting items, if appropriate.
*/
get: function () {
return brushToString(this.i.abc);
},
set: function (v) {
this.i.abc = stringToBrush(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "markerOutline", {
/**
* Gets or sets which outline color to use for the marker when highlighting items, if appropriate.
*/
get: function () {
return brushToString(this.i.abd);
},
set: function (v) {
this.i.abd = stringToBrush(v);
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "markerTemplate", {
/**
* Gets or sets the template to use for marker visuals for the current series object.
*/
get: function () {
return this.i.aa1;
},
set: function (v) {
this.i.aa1 = v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "bandHighlightWidth", {
/**
* Gets or sets the width to use for the highlight region if highlighting items in a grid aligned series (line, spline, etc), with a banded shape.
*/
get: function () {
return this.i.aak;
},
set: function (v) {
this.i.aak = +v;
},
enumerable: false,
configurable: true
});
Object.defineProperty(IgrCategoryItemHighlightLayer.prototype, "skipUnknownValues", {
/**
* Gets or sets whether to skip unknown values when searching for series values.
*/
get: function () {
return this.i.aah;
},
set: function (v) {
this.i.aah = ensureBool(v);
},
enumerable: false,
configurable: true
});
IgrCategoryItemHighlightLayer.prototype.findByName = function (name) {
var baseResult = _super.prototype.findByName.call(this, name);
if (baseResult) {
return baseResult;
}
if (this.targetSeries && this.targetSeries.name && this.targetSeries.name == name) {
return this.targetSeries;
}
return null;
};
IgrCategoryItemHighlightLayer.prototype._styling = function (container, component, parent) {
_super.prototype._styling.call(this, container, component, parent);
this._inStyling = true;
if (this.targetSeries && this.targetSeries._styling) {
this.targetSeries._styling(container, component, this);
}
this._inStyling = false;
};
return IgrCategoryItemHighlightLayer;
}(IgrAnnotationLayer));
export { IgrCategoryItemHighlightLayer };