ag-charts-community/dist/types/src/chart/legend/legend.d.ts

Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue

import type { AgChartLegendClickEvent, AgChartLegendDoubleClickEvent, AgChartLegendLabelFormatterParams, AgChartLegendListeners, AgChartLegendOrientation, AgChartLegendPosition, AgMarkerShape, FontStyle, FontWeight, Formatter } from 'ag-charts-types';
import type { ModuleContext } from '../../module/moduleContext';
import type { Scene } from '../../scene/scene';
import { BaseProperties } from '../../util/properties';
import type { SwitchWidget } from '../../widget/switchWidget';
import type { MouseWidgetEvent } from '../../widget/widgetEvents';
import { Pagination } from '../pagination/pagination';
import type { CategoryLegendDatum } from './legendDatum';
import { LegendMarkerLabel } from './legendMarkerLabel';
declare class LegendLabel extends BaseProperties {
    maxLength?: number;
    color: string;
    fontStyle?: FontStyle;
    fontWeight?: FontWeight;
    fontSize: number;
    fontFamily: string;
    formatter?: Formatter<AgChartLegendLabelFormatterParams>;
}
declare class LegendMarker extends BaseProperties {
    /**
     * If the marker type is set, the legend will always use that marker type for all its items,
     * regardless of the type that comes from the `data`.
     */
    shape?: AgMarkerShape;
    size: number;
    /**
     * Padding between the marker and the label within each legend item.
     */
    padding: number;
    strokeWidth?: number;
    enabled?: boolean;
}
declare class LegendLine extends BaseProperties {
    strokeWidth?: number;
    length?: number;
}
declare class LegendItem extends BaseProperties {
    /** Used to constrain the width of legend items. */
    maxWidth?: number;
    /**
     * The legend uses grid layout for its items, occupying as few columns as possible when positioned to left or right,
     * and as few rows as possible when positioned to top or bottom. This config specifies the amount of horizontal
     * padding between legend items.
     */
    paddingX: number;
    /**
     * The legend uses grid layout for its items, occupying as few columns as possible when positioned to left or right,
     * and as few rows as possible when positioned to top or bottom. This config specifies the amount of vertical
     * padding between legend items.
     */
    paddingY: number;
    showSeriesStroke: boolean;
    readonly marker: LegendMarker;
    readonly label: LegendLabel;
    readonly line: LegendLine;
}
declare class LegendListeners extends BaseProperties implements AgChartLegendListeners {
    legendItemClick?: (event: AgChartLegendClickEvent) => void;
    legendItemDoubleClick?: (event: AgChartLegendDoubleClickEvent) => void;
}
export declare class Legend extends BaseProperties {
    private readonly ctx;
    static readonly className = "Legend";
    readonly id: string;
    private readonly group;
    private readonly itemSelection;
    private readonly oldSize;
    private pages;
    private maxPageSize;
    /** Item index to track on re-pagination, so current page updates appropriately. */
    private paginationTrackingIndex;
    private readonly truncatedItems;
    private _data;
    set data(value: CategoryLegendDatum[]);
    get data(): CategoryLegendDatum[];
    private readonly contextMenuDatum?;
    context: never;
    toggleSeries: boolean;
    readonly pagination: Pagination;
    readonly item: LegendItem;
    readonly listeners: LegendListeners;
    enabled: boolean;
    position: AgChartLegendPosition;
    /** Used to constrain the width of the legend. */
    maxWidth?: number;
    /** Used to constrain the height of the legend. */
    maxHeight?: number;
    /** Reverse the display order of legend items if `true`. */
    reverseOrder?: boolean;
    orientation?: AgChartLegendOrientation;
    preventHidingAll?: boolean;
    /**
     * Spacing between the legend and the edge of the chart's element.
     */
    spacing: number;
    private readonly destroyFns;
    private readonly domProxy;
    private pendingHighlightDatum?;
    constructor(ctx: ModuleContext);
    private onLegendDataChange;
    destroy(): void;
    private getOrientation;
    readonly size: [number, number];
    private _visible;
    set visible(value: boolean);
    get visible(): boolean;
    private updateGroupVisibility;
    attachLegend(scene: Scene): void;
    getItemLabel(datum: CategoryLegendDatum): string | undefined;
    /**
     * The method is given the desired size of the legend, which only serves as a hint.
     * The vertically oriented legend will take as much horizontal space as needed, but will
     * respect the height constraints, and the horizontal legend will take as much vertical
     * space as needed in an attempt not to exceed the given width.
     * After the layout is done, the {@link size} will contain the actual size of the legend.
     * If the actual size is not the same as the previous actual size, the legend will fire
     * the 'layoutChange' event to communicate that another layout is needed, and the above
     * process should be repeated.
     * @param width
     * @param height
     */
    private calcLayout;
    private isCustomMarker;
    private calcSymbolsEnabled;
    private calcSymbolsLengths;
    private calculateMarkerWidth;
    private updateMarkerLabel;
    private truncate;
    private updatePagination;
    private calculatePagination;
    private updatePositions;
    private updatePageNumber;
    update(): void;
    private updateContextMenu;
    private getLineStyles;
    private getMarkerStyles;
    private computePagedBBox;
    private findNode;
    private contextToggleVisibility;
    private contextToggleOtherSeries;
    onContextClick(widgetEvent: MouseWidgetEvent<'contextmenu'>, node: LegendMarkerLabel): void;
    onClick(event: Event, datum: CategoryLegendDatum, proxyButton: SwitchWidget): void;
    private getVisibleItemCount;
    private doClick;
    onDoubleClick(event: MouseEvent, datum: CategoryLegendDatum): void;
    private doDoubleClick;
    private toTooltipMeta;
    onHover(event: FocusEvent | MouseEvent, node: LegendMarkerLabel): void;
    onLeave(): void;
    private updateHighlight;
    private onLocaleChanged;
    private positionLegend;
    private positionLegendScene;
    private positionLegendDOM;
    private calculateLegendDimensions;
    private cachedCallWithContext;
}
export {};