open-nomad/ui/stories/charts/line-chart.stories.js
Buck Doyle 576bcf554f
UI: Migrate to Storybook (#6507)
I originally planned to add component documentation, but as this dragged on and I found that JSDoc-to-Markdown sometimes needed hand-tuning, I decided to skip it and focus on replicating what was already present in Freestyle. Adding documentation is a finite task that can be revisited in the future.

My goal was to migrate everything from Freestyle with as few changes as possible. Some adaptations that I found necessary:
• the DelayedArray and DelayedTruth utilities that delay component rendering until slightly after initial render because without them:
  ◦ charts were rendering with zero width
  ◦ the JSON viewer was rendering with empty content
• Storybook in Ember renders components in a routerless/controllerless context by default, so some component stories needed changes:
  ◦ table pagination/sorting stories access to query params, which necessitates some reaching into Ember internals to start routing and dynamically generate a Storybook route/controller to render components into
  ◦ some stories have a faux controller as part of their Storybook context that hosts setInterval-linked dynamic computed properties
• some jiggery-pokery with anchor tags
  ◦ inert href='#' had to become href='javascript:;
  ◦ links that are actually meant to navigate need target='_parent' so they don’t navigate inside the Storybook iframe

Maybe some of these could be addressed by fixes in ember-cli-storybook but I’m wary of digging around in there any more than I already have, as I’ve lost a lot of time to Storybook confusion and frustrations already 😞

The STORYBOOK=true environment variable tweaks some environment settings to get things working as expected in the Storybook context.

I chose to:
• use angle bracket invocation within stories rather than have to migrate them soon after having moved to Storybook
• keep Freestyle around for now for its palette and typeface components
2020-01-21 15:46:32 -06:00

148 lines
4.4 KiB
JavaScript

import hbs from 'htmlbars-inline-precompile';
import EmberObject from '@ember/object';
import { on } from '@ember/object/evented';
import moment from 'moment';
import DelayedArray from '../utils/delayed-array';
export default {
title: 'Charts|Line Chart',
};
let data1 = [
{ year: 2010, value: 10 },
{ year: 2011, value: 10 },
{ year: 2012, value: 20 },
{ year: 2013, value: 30 },
{ year: 2014, value: 50 },
{ year: 2015, value: 80 },
{ year: 2016, value: 130 },
{ year: 2017, value: 210 },
{ year: 2018, value: 340 },
];
let data2 = [
{ year: 2010, value: 100 },
{ year: 2011, value: 90 },
{ year: 2012, value: 120 },
{ year: 2013, value: 130 },
{ year: 2014, value: 115 },
{ year: 2015, value: 105 },
{ year: 2016, value: 90 },
{ year: 2017, value: 85 },
{ year: 2018, value: 90 },
];
export let Standard = () => {
return {
template: hbs`
<h5 class="title is-5">Line Chart</h5>
<div class="block" style="height:100px; width: 400px;">
{{#if lineChartData}}
<LineChart @data={{lineChartData}} @xProp="year" @yProp="value" @chartClass="is-primary" />
{{/if}}
</div>
<div class="block" style="height:100px; width: 400px;">
{{#if lineChartMild}}
<LineChart @data={{lineChartMild}} @xProp="year" @yProp="value" @chartClass="is-info" />
{{/if}}
</div>
`,
context: {
lineChartData: DelayedArray.create(data1),
lineChartMild: DelayedArray.create(data2),
},
};
};
export let FluidWidth = () => {
return {
template: hbs`
<h5 class="title is-5">Fluid-width Line Chart</h5>
<div class="block" style="height:250px;">
{{#if lineChartData}}
<LineChart @data={{lineChartData}} @xProp="year" @yProp="value" @chartClass="is-danger" />
{{/if}}
</div>
<div class="block" style="height:250px;">
{{#if lineChartMild}}
<LineChart @data={{lineChartMild}} @xProp="year" @yProp="value" @chartClass="is-warning" />
{{/if}}
</div>
<p class="annotation">A line chart will assume the width of its container. This includes the dimensions of the axes, which are calculated based on real DOM measurements. This requires a two-pass render: first the axes are placed with their real domains (in order to capture width and height of tick labels), second the axes are adjusted to make sure both the x and y axes are within the height and width bounds of the container.</p>
`,
context: {
lineChartData: DelayedArray.create(data1),
lineChartMild: DelayedArray.create(data2),
},
};
};
export let LiveData = () => {
return {
template: hbs`
<h5 class="title is-5">Live data Line Chart</h5>
<div class="block" style="height:250px">
{{#if controller.lineChartLive}}
<LineChart @data={{controller.lineChartLive}} @xProp="ts" @yProp="val" @timeseries={{true}} @chartClass="is-primary" @xFormat={{controller.secondsFormat}} />
{{/if}}
</div>
`,
context: {
controller: EmberObject.extend({
startTimer: on('init', function() {
this.set(
'timer',
setInterval(() => {
this.incrementProperty('timerTicks');
let ref = this.lineChartLive;
ref.addObject({ ts: Date.now(), val: Math.random() * 30 + 20 });
if (ref.length > 60) {
ref.splice(0, ref.length - 60);
}
}, 500)
);
}),
willDestroy() {
clearInterval(this.timer);
},
lineChartLive: [],
secondsFormat() {
return date => moment(date).format('HH:mm:ss');
},
}).create(),
},
};
};
export let Gaps = () => {
return {
template: hbs`
<h5 class="title is-5">Line Chart data with gaps</h5>
<div class="block" style="height:250px">
{{#if lineChartGapData}}
<LineChart @data={{lineChartGapData}} @xProp="year" @yProp="value" @chartClass="is-primary" />
{{/if}}
</div>
`,
context: {
lineChartGapData: DelayedArray.create([
{ year: 2010, value: 10 },
{ year: 2011, value: 10 },
{ year: 2012, value: null },
{ year: 2013, value: 30 },
{ year: 2014, value: 50 },
{ year: 2015, value: 80 },
{ year: 2016, value: null },
{ year: 2017, value: 210 },
{ year: 2018, value: 340 },
]),
},
};
};