scichart/Charting/ChartModifiers/Polar/PolarLegendModifier.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { EChart2DModifierType } from "../../../types/ChartModifierType";
import { EModifierType } from "../../../types/ModifierType";
import { ILegendModifierOptions, LegendModifier } from "../LegendModifier";
/**
 * Optional parameters used to configure a {@link PolarLegendModifier} at construct time
 */
export interface IPolarLegendModifierOptions extends ILegendModifierOptions {
}
/**
 * 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/}
 */
export declare class PolarLegendModifier extends LegendModifier {
    readonly type: EChart2DModifierType;
    /**
     * 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/}
     */
    constructor(options?: IPolarLegendModifierOptions);
    /** @inheritDoc */
    get modifierType(): EModifierType;
}