@gpa-gemstone/react-graph
Version:
Interactive UI Components for GPA products
16 lines (15 loc) • 714 B
TypeScript
import { LegendStyle } from '../DataLegend';
/**
* Hook to create and manage legend entries/operations.
* @param color The color of the legend entry.
* @param legendSymbol The symbol style of the legend entry.
* @param guid The unique identifier for the data series component.
* @param hasNoData Indicates if the data series has no data.
* @param legendLabel Text label for the legend entry.
* @returns An object containing the createLegend function and the enabled state.
*/
declare const useLegend: (color: string, legendSymbol: LegendStyle, guid: string, hasNoData?: boolean, legendLabel?: string) => {
createLegend: () => JSX.Element | undefined;
enabled: boolean;
};
export default useLegend;