2025-04-01 10:38:02 +09:00

141 lines
4.7 KiB
TypeScript

import { css } from '@emotion/css';
import { dateMath, getDefaultTimeRange, GrafanaTheme2, rangeUtil, TimeRange } from '@grafana/data';
import {
SceneComponentProps,
sceneGraph,
SceneTimeRangeLike,
SceneTimeRangeState,
SceneTimeRangeTransformerBase,
VariableDependencyConfig,
} from '@grafana/scenes';
import { Icon, PanelChrome, TimePickerTooltip, Tooltip, useStyles2 } from '@grafana/ui';
import { TimeOverrideResult } from 'app/features/dashboard/utils/panel';
export interface PanelTimeRangeState extends SceneTimeRangeState {
timeFrom?: string;
timeShift?: string;
hideTimeOverride?: boolean;
timeInfo?: string;
}
export class PanelTimeRange extends SceneTimeRangeTransformerBase<PanelTimeRangeState> implements SceneTimeRangeLike {
public static Component = PanelTimeRangeRenderer;
public constructor(state: Partial<PanelTimeRangeState> = {}) {
super({
...state,
// This time range is not valid until activation
from: 'now-6h',
to: 'now',
value: getDefaultTimeRange(),
});
this.addActivationHandler(() => this._onActivate());
}
protected _variableDependency: VariableDependencyConfig<PanelTimeRangeState> = new VariableDependencyConfig(this, {
statePaths: ['timeFrom', 'timeShift'],
});
private _onActivate() {
this._subs.add(
this.subscribeToState((n) => {
const { timeInfo, timeRange } = this.getTimeOverride(this.getAncestorTimeRange().state.value);
// When timeFrom or timeShift is a variable we cannot compare to previous interpolated value
// therefore we need to compare timeInfo directly and update when required
// Note: compare to newState.timeInfo because it is always one behind
if (n.timeInfo !== timeInfo) {
this.setState({ timeInfo, value: timeRange });
}
})
);
const { timeRange } = this.getTimeOverride(this.getAncestorTimeRange().state.value);
// set initial values on activate
this.setState({
value: timeRange,
from: timeRange.raw.from.toString(),
to: timeRange.raw.to.toString(),
});
}
protected ancestorTimeRangeChanged(timeRange: SceneTimeRangeState): void {
const overrideResult = this.getTimeOverride(timeRange.value);
this.setState({ value: overrideResult.timeRange, timeInfo: overrideResult.timeInfo });
}
private getTimeOverride(parentTimeRange: TimeRange): TimeOverrideResult {
const { timeFrom, timeShift } = this.state;
const newTimeData = { timeInfo: '', timeRange: parentTimeRange };
if (timeFrom) {
const timeFromInterpolated = sceneGraph.interpolate(this, this.state.timeFrom);
const timeFromInfo = rangeUtil.describeTextRange(timeFromInterpolated);
if (timeFromInfo.invalid) {
newTimeData.timeInfo = 'invalid time override';
return newTimeData;
}
// Only evaluate if the timeFrom if parent time is relative
if (rangeUtil.isRelativeTimeRange(parentTimeRange.raw)) {
const timeZone = this.getTimeZone();
newTimeData.timeInfo = timeFromInfo.display;
newTimeData.timeRange = {
from: dateMath.parse(timeFromInfo.from, undefined, timeZone)!,
to: dateMath.parse(timeFromInfo.to, undefined, timeZone)!,
raw: { from: timeFromInfo.from, to: timeFromInfo.to },
};
}
}
if (timeShift) {
const timeShiftInterpolated = sceneGraph.interpolate(this, this.state.timeShift);
const timeShiftInfo = rangeUtil.describeTextRange(timeShiftInterpolated);
if (timeShiftInfo.invalid) {
newTimeData.timeInfo = 'invalid timeshift';
return newTimeData;
}
const timeShift = '-' + timeShiftInterpolated;
newTimeData.timeInfo += ' timeshift ' + timeShift;
const from = dateMath.parseDateMath(timeShift, newTimeData.timeRange.from, false)!;
const to = dateMath.parseDateMath(timeShift, newTimeData.timeRange.to, true)!;
newTimeData.timeRange = { from, to, raw: { from, to } };
}
return newTimeData;
}
}
function PanelTimeRangeRenderer({ model }: SceneComponentProps<PanelTimeRange>) {
const { timeInfo, hideTimeOverride } = model.useState();
const styles = useStyles2(getStyles);
if (!timeInfo || hideTimeOverride) {
return null;
}
return (
<Tooltip content={<TimePickerTooltip timeRange={model.state.value} timeZone={model.getTimeZone()} />}>
<PanelChrome.TitleItem className={styles.timeshift}>
<Icon name="clock-nine" size="sm" /> {timeInfo}
</PanelChrome.TitleItem>
</Tooltip>
);
}
const getStyles = (theme: GrafanaTheme2) => {
return {
timeshift: css({
color: theme.colors.text.link,
gap: theme.spacing(0.5),
whiteSpace: 'nowrap',
}),
};
};