scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
63 lines (62 loc) • 2.8 kB
JavaScript
;
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.PolarLegendModifier = void 0;
var ChartModifierType_1 = require("../../../types/ChartModifierType");
var ModifierType_1 = require("../../../types/ModifierType");
var LegendModifier_1 = require("../LegendModifier");
/**
* The PolarLegendModifier provides interactive legend behavior on a 2D {@link SciChartPolarSurface}
* within SciChart - High Performance {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
* @remarks
*
* To apply the PolarLegendModifier to a {@link SciChartPolarSurface} and add tooltip behavior,
* use the following code:
*
* ```ts
* const sciChartSurface: SciChartPolarSurface;
* sciChartSurface.chartModifiers.add(new PolarLegendModifier());
* ```
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/polar-modifiers/polar-legend-modifier/}
*/
var PolarLegendModifier = /** @class */ (function (_super) {
__extends(PolarLegendModifier, _super);
/**
* Creates an instance of the PolarLegendModifier
* @param options Optional parameters {@link IPolarLegendModifierOptions} used to configure the modifier
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/polar-modifiers/polar-legend-modifier/}
*/
function PolarLegendModifier(options) {
var _this = _super.call(this, options) || this;
_this.type = ChartModifierType_1.EChart2DModifierType.PolarLegend;
return _this;
}
Object.defineProperty(PolarLegendModifier.prototype, "modifierType", {
/** @inheritDoc */
get: function () {
return ModifierType_1.EModifierType.Chart2DPolarModifier;
},
enumerable: false,
configurable: true
});
return PolarLegendModifier;
}(LegendModifier_1.LegendModifier));
exports.PolarLegendModifier = PolarLegendModifier;