@neo4j-ndl/react-charts
Version:
React implementation of charts from Neo4j Design System
45 lines • 1.97 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import type { Condition, NeedleSeries, NotificationType, ThresholdLineSeriesOption } from './chart-types';
export type NormalizedThresholdLine = ThresholdLineSeriesOption<NotificationType> & {
condition: NonNullable<ThresholdLineSeriesOption<NotificationType>['condition']>;
value: number;
};
export type ThresholdConditionEvaluation = {
isConditionMet: boolean;
conditionText: string | undefined;
};
export declare const isThresholdLine: (name?: string) => boolean | undefined;
export declare const getThresholdLineDisplayName: (name: string) => string;
/**
* Extracts threshold-line series and resolves defaults needed by tooltips.
*/
export declare function normalizeThresholdLines(propsSeries: NeedleSeries): NormalizedThresholdLine[];
/**
* Evaluates a threshold condition and returns the short label used by
* chart tooltip notifications.
*/
export declare function evaluateThresholdCondition(value: number, condition: Condition, threshold: number): ThresholdConditionEvaluation;
/**
* Returns the longer condition phrase used in chart aria descriptions.
*/
export declare function thresholdConditionToText(condition: Condition): string;
//# sourceMappingURL=threshold.d.ts.map