@gpa-gemstone/react-graph/lib/DataLegend.d.ts

Interactive UI Components for GPA products

import * as React from 'react';
import { LineStyle } from './GraphContext';
import { ILegendRequiredProps } from './LegendContext';
export type LegendStyle = LineStyle | 'none' | 'square' | 'circle';
export interface IProps extends ILegendRequiredProps {
    /**
     * The color of the legend symbol
     */
    color: string;
    /**
     * The style of the legend symbol to display
     */
    legendSymbol: LegendStyle;
    /**
     * Handler to set the enabled state of the data series
     * @param arg The new enabled state
     * @param e The mouse event that triggered the change
     */
    setEnabled: (arg: boolean, e: React.MouseEvent<HTMLDivElement>) => void;
    /**
     * Flag that indicates whether the data series has no data
     */
    hasNoData: boolean;
    /**
     * The label to display next to the legend symbol.
     */
    label: string;
    /**
     * Optional text that will enable a tooltip when hovering over the legend entry
     */
    toolTipText?: string;
}
declare const DataLegend: (props: IProps) => JSX.Element;
export default DataLegend;