scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
31 lines (30 loc) • 1.38 kB
TypeScript
import { EChart2DModifierType } from "../../../types/ChartModifierType";
import { EModifierType } from "../../../types/ModifierType";
import { ISeriesSelectionModifierOptions, SeriesSelectionModifier } from "../SeriesSelectionModifier";
/**
* Optional parameters used to configure a {@link PolarSeriesSelectionModifier} at construct time
*/
export interface IPolarSeriesSelectionModifierOptions extends ISeriesSelectionModifierOptions {
}
/**
* The PolarSeriesSelectionModifier provides an ability to select renderable series on a 2D {@link SciChartPolarSurface}
* within SciChart - High Performance {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
* @remarks
*
* To apply the `PolarSeriesSelectionModifier` to a {@link SciChartPolarSurface} use the following code:
*
* ```ts
* sciChartSurface.chartModifiers.add(
* new PolarSeriesSelectionModifier()
* );
* ```
*/
export declare class PolarSeriesSelectionModifier extends SeriesSelectionModifier {
readonly type: EChart2DModifierType;
/**
* Creates an instances of PolarSeriesSelectionModifier
* @param options Optional parameters of type {@link IPolarSeriesSelectionModifierOptions} used to configure the modifier
*/
constructor(options?: IPolarSeriesSelectionModifierOptions);
get modifierType(): EModifierType;
}