Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Demos: Drawer drilldown scene #1045

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 164 additions & 0 deletions packages/scenes-app/src/demos/drawerDrilldownDemo.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
import React, { useMemo } from 'react';
import {
EmbeddedScene,
PanelBuilders,
SceneAppPage,
SceneAppPageState,
SceneComponentProps,
SceneDataTransformer,
SceneFlexItem,
SceneFlexLayout,
SceneObject,
SceneObjectBase,
SceneObjectState,
SceneObjectUrlSyncConfig,
SceneObjectUrlValues,
UrlSyncContextProvider,
} from '@grafana/scenes';
import { Drawer } from '@grafana/ui';
import { getEmbeddedSceneDefaults, getQueryRunnerWithRandomWalkQuery } from './utils';

export function getDrawerDrilldownDemo(defaults: SceneAppPageState) {
return new SceneAppPage({
...defaults,
subTitle: 'Open a sub scene in a drawer',
getScene: () => {
return new EmbeddedScene({
...getEmbeddedSceneDefaults(),
key: 'Dynamic options demo',
body: new SceneFlexLayout({
direction: 'column',
children: [
new SceneFlexItem({
body: new PanelWithDrawer({
body: getRoomsTemperatureTable(),
}),
}),
],
}),
});
},
});
}

export function getRoomsTemperatureTable() {
const dataTransformed = new SceneDataTransformer({
$data: getQueryRunnerWithRandomWalkQuery(
{ seriesCount: 10, spread: 15, alias: '__house_locations' },
{ maxDataPoints: 50 }
),
transformations: [
{
id: 'reduce',
options: {
reducers: ['mean'],
},
},
{
id: 'organize',
options: {
excludeByName: {},
indexByName: {},
renameByName: {
Field: 'Room',
Mean: 'Average temperature',
},
},
},
],
});

return PanelBuilders.table()
.setData(dataTransformed)
.setTitle('Room temperature overview')
.setOption('sortBy', [
{
displayName: 'Average temperature',
},
])
.setOverrides((b) =>
b
.matchFieldsWithName('Average temperature')
.overrideUnit('celsius')
.overrideCustomFieldConfig('align', 'center')
.matchFieldsWithName('Room')
.overrideLinks([
{
title: 'Go to room overview',
url: '${__url.path}${__url.params:exclude:room}&room=${__value.text}',
},
])
.overrideCustomFieldConfig('width', 250)
)
.build();
}

interface PanelWithDrawerState extends SceneObjectState {
room?: string;
body: SceneObject;
}

class PanelWithDrawer extends SceneObjectBase<PanelWithDrawerState> {
protected _urlSync = new SceneObjectUrlSyncConfig(this, { keys: ['room'] });

public constructor(state: PanelWithDrawerState) {
super(state);
}

public getUrlState() {
return { room: this.state.room };
}

public updateFromUrl(values: SceneObjectUrlValues) {
if (typeof values.room === 'string') {
this.setState({ room: values.room });
} else if (values.room == null) {
this.setState({ room: undefined });
}
}

static Component = ({ model }: SceneComponentProps<PanelWithDrawer>) => {
const { room, body } = model.useState();

return (
<>
<body.Component model={body} />
{room && (
<Drawer title={`${room} details`} onClose={() => model.setState({ room: undefined })}>
<DrilldownScene room={room} />
</Drawer>
)}
</>
);
};
}

interface DrilldownSceneProps {
room: string;
}

function DrilldownScene(props: DrilldownSceneProps) {
const scene = useMemo(() => getDrilldownScene(props.room), [props.room]);

return (
<UrlSyncContextProvider scene={scene}>
<scene.Component model={scene} />
</UrlSyncContextProvider>
);
}

export function getDrilldownScene(room: string) {
return new EmbeddedScene({
$data: getQueryRunnerWithRandomWalkQuery({ seriesCount: 3, spread: 15 }, { maxDataPoints: 50 }),
body: new SceneFlexLayout({
direction: 'column',
children: [
new SceneFlexItem({
height: 500,
body: PanelBuilders.timeseries().setTitle(room).setUnit('humidity').build(),
}),
],
}),
...getEmbeddedSceneDefaults(),
});
}
2 changes: 2 additions & 0 deletions packages/scenes-app/src/demos/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import { getUrlSyncTest } from './urlSyncTest';
import { getMlDemo } from './ml';
import { getSceneGraphEventsDemo } from './sceneGraphEvents';
import { getSeriesLimitTest } from './seriesLimit';
import { getDrawerDrilldownDemo } from './drawerDrilldownDemo';

export interface DemoDescriptor {
title: string;
Expand Down Expand Up @@ -89,5 +90,6 @@ export function getDemos(): DemoDescriptor[] {
{ title: 'Machine Learning', getPage: getMlDemo },
{ title: 'Events on the Scene Graph', getPage: getSceneGraphEventsDemo },
{ title: 'Series limit', getPage: getSeriesLimitTest },
{ title: 'Drawer drilldown', getPage: getDrawerDrilldownDemo },
].sort((a, b) => a.title.localeCompare(b.title));
}