scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
37 lines (36 loc) • 1.84 kB
TypeScript
import { EChart2DModifierType } from "../../../types/ChartModifierType";
import { EModifierType } from "../../../types/ModifierType";
import { DataPointSelectionModifier, IDataPointSelectionModifierOptions } from "../DataPointSelectionModifier";
/**
* Optional parameters used to configure a {@link PolarDataPointSelectionModifier} at construct time
*/
export interface IPolarDataPointSelectionModifierOptions extends IDataPointSelectionModifierOptions {
}
/**
* The PolarDataPointSelectionModifier provides an ability to select data points on a 2D {@link SciChartPolarSurface}
* within SciChart - High Performance {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
* @remarks
*
* To apply the PolarDataPointSelectionModifier to a {@link SciChartPolarSurface} and add data selection behavior,
* use the following code:
*
* ```ts
* const sciChartSurface: SciChartSurface;
* sciChartSurface.chartModifiers.add(new PolarDataPointSelectionModifier());
* ```
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/polar-modifiers/polar-data-point-selection-modifier/}
*/
export declare class PolarDataPointSelectionModifier extends DataPointSelectionModifier {
readonly type = EChart2DModifierType.PolarDataPointSelection;
/**
* Creates an instances of PolarDataPointSelectionModifier
* @param options Optional parameters of type {@link IPolarDataPointSelectionModifierOptions} used to configure the modifier
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-modifier-api/polar-modifiers/polar-data-point-selection-modifier/}
*/
constructor(options?: IPolarDataPointSelectionModifierOptions);
get modifierType(): EModifierType;
}