Skip to content

Commit 68e6b5e

Browse files
committed
docs
1 parent 05f52ac commit 68e6b5e

File tree

5 files changed

+6
-11
lines changed

5 files changed

+6
-11
lines changed

README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -218,20 +218,15 @@ import {ScatterChart} from "stream-charts";
218218

219219
`stream-charts` are high-performance charts for displaying large amounts of data in real-time. The charts are wrapped in [react](https://reactjs.org) and fed data using [rxjs](https://rxjs-dev.firebaseapp.com) `Observable`s. The goal `stream-charts` is to display large amounts of time-series data at high frequencies while providing tools to understand the time-series.
220220

221-
There are currently two chart types available: a raster chart for display neuron spikes as a function of time, and a scatter chart. The chart below shows the raster chart with the bar magnifier enabled. The controls at the top of the chart are part of the example. These controls allow filtering time-series by their assigned names in real-time, displaying a tooltip when the mouse pointer is on top of a datum, displaying a tracker that show a vertical line and the current time of the mouse, and a bar magnifier, as shown in the image.
221+
There are currently two chart types available: a raster chart for displaying neuron spikes as a function of time, and a scatter chart for displaying time-series of data.
222222

223-
![raster-chart](https://github.com/robphilipp/stream-charts/blob/master/docs/images/raster-magnifier.png?raw=true)
224-
![raster-chart](./docs/images/raster-chart.gif)
223+
The chart below shows the raster chart with the bar magnifier enabled. The controls at the top of the chart are part of the example. These controls allow filtering time-series by their assigned names in real-time, displaying a tooltip when the mouse pointer is on top of a datum, displaying a tracker that show a vertical line and the current time of the mouse, and a bar magnifier, as shown in the image.
225224

226-
A scatter plot is shown below. In this plot, the neurons' weights are plotted as a function of time. In this plot, the magnifier is enabled, and magnifies the data near the mouse pointer.
225+
![raster-chart](./docs/images/raster-magnifier.png?raw=true)
227226

228-
![scatter-chart](https://github.com/robphilipp/stream-charts/blob/master/docs/images/scatter.png?raw=true)
227+
The scatter plot shown below has 30 time-series of test data, with two time axes, in which the data are updated every 25 milliseconds. A tooltip shows the times and values that came just before and just after the mouse cursor and, as well as the time and value changes.
229228

230-
Another example of a scatter plot is shown below. In this plot, a tooltip shows the weight updates that came just before the mouse cursor and just after, as well as the time and weight changes.
231-
232-
![scatter-chart-tooltip](https://github.com/robphilipp/stream-charts/blob/master/docs/images/scatter-tooltip.png?raw=true)
233-
234-
In both cases the plots were updated in real-time with an average update time interval of 25 ms.
229+
![scatter-chart-tooltip](./docs/images/scatter-tooltip.png?raw=true)
235230

236231
## usage
237232

docs/images/raster-chart.gif

-23.7 MB
Binary file not shown.

docs/images/raster-magnifier.png

-43.9 KB
Loading

docs/images/scatter-tooltip.png

-749 KB
Loading

src/app/charts/RasterPlot.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -351,10 +351,10 @@ export function RasterPlot(props: Props): null {
351351

352352
// update
353353
seriesContainer
354+
.each(datum => datum.x = xAxis.scale(datum.time))
354355
.attr('x1', datum => datum.x)
355356
.attr('x2', datum => datum.x)
356357
.attr('stroke', color)
357-
.each(datum => datum.x = xAxis.scale(datum.time))
358358

359359
// exit old elements
360360
seriesContainer.exit().remove()

0 commit comments

Comments
 (0)