mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Chore: Add more deprecation notices to packages/grafana-ui/src/components/Graph/ (#77480)
more deprecations
This commit is contained in:
parent
8a5d4c4c6e
commit
d511925fc9
@ -15,6 +15,7 @@ import { GraphDimensions } from './GraphTooltip/types';
|
|||||||
import { FlotPosition, FlotItem } from './types';
|
import { FlotPosition, FlotItem } from './types';
|
||||||
import { graphTimeFormat, graphTickFormatter } from './utils';
|
import { graphTimeFormat, graphTickFormatter } from './utils';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface GraphProps {
|
export interface GraphProps {
|
||||||
ariaLabel?: string;
|
ariaLabel?: string;
|
||||||
children?: JSX.Element | JSX.Element[];
|
children?: JSX.Element | JSX.Element[];
|
||||||
@ -31,6 +32,7 @@ export interface GraphProps {
|
|||||||
onHorizontalRegionSelected?: (from: number, to: number) => void;
|
onHorizontalRegionSelected?: (from: number, to: number) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
interface GraphState {
|
interface GraphState {
|
||||||
pos?: FlotPosition;
|
pos?: FlotPosition;
|
||||||
contextPos?: FlotPosition;
|
contextPos?: FlotPosition;
|
||||||
|
@ -21,8 +21,10 @@ import { SeriesIcon } from '../VizLegend/SeriesIcon';
|
|||||||
|
|
||||||
import { GraphDimensions } from './GraphTooltip/types';
|
import { GraphDimensions } from './GraphTooltip/types';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export type ContextDimensions<T extends Dimensions = any> = { [key in keyof T]: [number, number | undefined] | null };
|
export type ContextDimensions<T extends Dimensions = any> = { [key in keyof T]: [number, number | undefined] | null };
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export type GraphContextMenuProps = ContextMenuProps & {
|
export type GraphContextMenuProps = ContextMenuProps & {
|
||||||
getContextMenuSource: () => FlotDataPoint | null;
|
getContextMenuSource: () => FlotDataPoint | null;
|
||||||
timeZone?: TimeZone;
|
timeZone?: TimeZone;
|
||||||
|
@ -3,22 +3,26 @@ import React, { Component } from 'react';
|
|||||||
|
|
||||||
import { GraphSeriesXY } from '@grafana/data';
|
import { GraphSeriesXY } from '@grafana/data';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface GraphSeriesTogglerAPI {
|
export interface GraphSeriesTogglerAPI {
|
||||||
onSeriesToggle: (label: string, event: React.MouseEvent<HTMLElement>) => void;
|
onSeriesToggle: (label: string, event: React.MouseEvent<HTMLElement>) => void;
|
||||||
toggledSeries: GraphSeriesXY[];
|
toggledSeries: GraphSeriesXY[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface GraphSeriesTogglerProps {
|
export interface GraphSeriesTogglerProps {
|
||||||
children: (api: GraphSeriesTogglerAPI) => JSX.Element;
|
children: (api: GraphSeriesTogglerAPI) => JSX.Element;
|
||||||
series: GraphSeriesXY[];
|
series: GraphSeriesXY[];
|
||||||
onHiddenSeriesChanged?: (hiddenSeries: string[]) => void;
|
onHiddenSeriesChanged?: (hiddenSeries: string[]) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface GraphSeriesTogglerState {
|
export interface GraphSeriesTogglerState {
|
||||||
hiddenSeries: string[];
|
hiddenSeries: string[];
|
||||||
toggledSeries: GraphSeriesXY[];
|
toggledSeries: GraphSeriesXY[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export class GraphSeriesToggler extends Component<GraphSeriesTogglerProps, GraphSeriesTogglerState> {
|
export class GraphSeriesToggler extends Component<GraphSeriesTogglerProps, GraphSeriesTogglerState> {
|
||||||
constructor(props: GraphSeriesTogglerProps) {
|
constructor(props: GraphSeriesTogglerProps) {
|
||||||
super(props);
|
super(props);
|
||||||
|
@ -8,6 +8,7 @@ import { MultiModeGraphTooltip } from './MultiModeGraphTooltip';
|
|||||||
import { SingleModeGraphTooltip } from './SingleModeGraphTooltip';
|
import { SingleModeGraphTooltip } from './SingleModeGraphTooltip';
|
||||||
import { GraphDimensions } from './types';
|
import { GraphDimensions } from './types';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export const GraphTooltip = ({
|
export const GraphTooltip = ({
|
||||||
mode = TooltipDisplayMode.Single,
|
mode = TooltipDisplayMode.Single,
|
||||||
dimensions,
|
dimensions,
|
||||||
|
@ -8,11 +8,13 @@ import { getMultiSeriesGraphHoverInfo } from '../utils';
|
|||||||
|
|
||||||
import { GraphTooltipContentProps } from './types';
|
import { GraphTooltipContentProps } from './types';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
type Props = GraphTooltipContentProps & {
|
type Props = GraphTooltipContentProps & {
|
||||||
// We expect position to figure out correct values when not hovering over a datapoint
|
// We expect position to figure out correct values when not hovering over a datapoint
|
||||||
pos: FlotPosition;
|
pos: FlotPosition;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export const MultiModeGraphTooltip = ({ dimensions, activeDimensions, pos, timeZone }: Props) => {
|
export const MultiModeGraphTooltip = ({ dimensions, activeDimensions, pos, timeZone }: Props) => {
|
||||||
let activeSeriesIndex: number | null = null;
|
let activeSeriesIndex: number | null = null;
|
||||||
// when no x-axis provided, skip rendering
|
// when no x-axis provided, skip rendering
|
||||||
|
@ -11,6 +11,7 @@ import { SeriesTable } from '../../VizTooltip';
|
|||||||
|
|
||||||
import { GraphTooltipContentProps } from './types';
|
import { GraphTooltipContentProps } from './types';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export const SingleModeGraphTooltip = ({ dimensions, activeDimensions, timeZone }: GraphTooltipContentProps) => {
|
export const SingleModeGraphTooltip = ({ dimensions, activeDimensions, timeZone }: GraphTooltipContentProps) => {
|
||||||
// not hovering over a point, skip rendering
|
// not hovering over a point, skip rendering
|
||||||
if (
|
if (
|
||||||
|
@ -2,11 +2,13 @@ import { Dimension, Dimensions, TimeZone } from '@grafana/data';
|
|||||||
|
|
||||||
import { ActiveDimensions } from '../../VizTooltip';
|
import { ActiveDimensions } from '../../VizTooltip';
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface GraphDimensions extends Dimensions {
|
export interface GraphDimensions extends Dimensions {
|
||||||
xAxis: Dimension<number>;
|
xAxis: Dimension<number>;
|
||||||
yAxis: Dimension<number>;
|
yAxis: Dimension<number>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface GraphTooltipContentProps {
|
export interface GraphTooltipContentProps {
|
||||||
dimensions: GraphDimensions; // Dimension[]
|
dimensions: GraphDimensions; // Dimension[]
|
||||||
activeDimensions: ActiveDimensions<GraphDimensions>;
|
activeDimensions: ActiveDimensions<GraphDimensions>;
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
/** @deprecated */
|
||||||
export interface FlotPosition {
|
export interface FlotPosition {
|
||||||
pageX: number;
|
pageX: number;
|
||||||
pageY: number;
|
pageY: number;
|
||||||
@ -7,6 +8,7 @@ export interface FlotPosition {
|
|||||||
y1: number;
|
y1: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export interface FlotItem<T> {
|
export interface FlotItem<T> {
|
||||||
datapoint: [number, number];
|
datapoint: [number, number];
|
||||||
dataIndex: number;
|
dataIndex: number;
|
||||||
|
@ -13,6 +13,7 @@ import {
|
|||||||
*
|
*
|
||||||
* @param posX
|
* @param posX
|
||||||
* @param series
|
* @param series
|
||||||
|
* @deprecated
|
||||||
*/
|
*/
|
||||||
export const findHoverIndexFromData = (xAxisDimension: Field, xPos: number) => {
|
export const findHoverIndexFromData = (xAxisDimension: Field, xPos: number) => {
|
||||||
let lower = 0;
|
let lower = 0;
|
||||||
@ -50,6 +51,7 @@ interface MultiSeriesHoverInfo {
|
|||||||
*
|
*
|
||||||
* @param seriesList list of series visible on the Graph
|
* @param seriesList list of series visible on the Graph
|
||||||
* @param pos mouse cursor position, based on jQuery.flot position
|
* @param pos mouse cursor position, based on jQuery.flot position
|
||||||
|
* @deprecated
|
||||||
*/
|
*/
|
||||||
export const getMultiSeriesGraphHoverInfo = (
|
export const getMultiSeriesGraphHoverInfo = (
|
||||||
// x and y axis dimensions order is aligned
|
// x and y axis dimensions order is aligned
|
||||||
@ -102,6 +104,7 @@ export const getMultiSeriesGraphHoverInfo = (
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export const graphTickFormatter = (epoch: number, axis: any) => {
|
export const graphTickFormatter = (epoch: number, axis: any) => {
|
||||||
return dateTimeFormat(epoch, {
|
return dateTimeFormat(epoch, {
|
||||||
format: axis?.options?.timeformat,
|
format: axis?.options?.timeformat,
|
||||||
@ -109,6 +112,7 @@ export const graphTickFormatter = (epoch: number, axis: any) => {
|
|||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @deprecated */
|
||||||
export const graphTimeFormat = (ticks: number | null, min: number | null, max: number | null): string => {
|
export const graphTimeFormat = (ticks: number | null, min: number | null, max: number | null): string => {
|
||||||
if (min && max && ticks) {
|
if (min && max && ticks) {
|
||||||
const range = max - min;
|
const range = max - min;
|
||||||
|
Loading…
Reference in New Issue
Block a user