scichart/Charting/Visuals/Legend/SciChart3DLegend.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { IRenderableSeries3D } from "../../../Charting3D/Visuals/RenderableSeries/BaseRenderableSeries3D";
import { ELegendType, SciChartLegendBase } from "./SciChartLegendBase";
/**
 * The SciChart3DLegend displays a legend on the 3D chart at top,left,bottom,right location and with customisable legend rows
 */
export declare class SciChart3DLegend extends SciChartLegendBase {
    readonly type = ELegendType.SciChart3DLegend;
    /**
     * Checked changed callback - when a legend item row checkbox is checked or unchecked. Set by parent {@link LegendModifier}
     */
    legendItemCheckedChangedCallback: (series: IRenderableSeries3D, isChecked: boolean) => void;
    private renderableSeriesArray;
    private showCheckboxesProperty;
    private showSeriesMarkersProperty;
    /** @inheritDoc */
    applyTheme(): void;
    /**
     * Gets or sets whether series visibility checkboxes should be shown
     */
    get showCheckboxes(): boolean;
    set showCheckboxes(value: boolean);
    /**
     * Gets or sets whether series markers should be shown
     */
    get showSeriesMarkers(): boolean;
    set showSeriesMarkers(value: boolean);
    /**
     * Sets the array of RenderableSeries to display in the legend
     * @param renderableSeriesArray The array of series
     * @remarks see {@link SciChart3DSurface.renderableSeries} which is the source for this array
     */
    setRenderableSeriesArray(renderableSeriesArray: IRenderableSeries3D[]): void;
    /** @inheritDoc */
    protected addEventListeners(): void;
    /** @inheritDoc */
    protected removeEventListeners(): void;
    /**
     * adds event listeners to a specific {@link IRenderableSeries3D} series
     */
    protected addEventListenerToSeries(rs: IRenderableSeries3D): void;
    /** @inheritDoc */
    protected getInnerHTML(): string;
}