Skip to content

Commit

Permalink
Merge pull request #250 from jpmorganchase/docs-update
Browse files Browse the repository at this point in the history
Updated documentation
  • Loading branch information
texodus authored Oct 1, 2018
2 parents 5e4eed4 + 83d5c9b commit b858525
Show file tree
Hide file tree
Showing 15 changed files with 1,618 additions and 701 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ simple to build real-time & user configurable analytics entirely in the browser.

## Examples

* [Superstore](https://jsfiddle.net/texodus/gsoybtrp/) A static `superstore.arrow` demo.
* [Olympics](https://jsfiddle.net/texodus/eax9tqbm/) An example of sharing a single `perspective.table` among multiple `<perspective-viewer>`s.
* [Streaming](https://jsfiddle.net/texodus/84u926L1/) A streaming random data demo.
* [CSV](https://jsfiddle.net/texodus/pcrnd4jg/) Upload a CSV of your own.
* [Superstore](https://jsfiddle.net/texodus/gsoybtrp/show/) A static `superstore.arrow` demo.
* [Olympics](https://jsfiddle.net/texodus/eax9tqbm/show/) An example of sharing a single `perspective.table` among multiple `<perspective-viewer>`s.
* [Streaming](https://jsfiddle.net/texodus/84u926L1/show/) A streaming random data demo.
* [CSV](https://jsfiddle.net/texodus/pcrnd4jg/show/) Upload a CSV of your own.

## Documentation

Expand Down
84 changes: 84 additions & 0 deletions docs/architecture.dot
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
digraph G {
graph [rankdir="LR" fontname="helvetica" labeljust="l"]
subgraph cluster_1 {
node [shape="box" fontname="monospace" fontsize=8 color=gray70 style=filled fillcolor=white];
edge [arrowhead="oarrow" color=gray50 arrowsize=0.8]
subgraph cluster_2 {
graph [
label="\lWeb Worker #1";
style=filled
fillcolor=lightgrey
color=none
fontcolor=gray30
fontsize=10
]
table1 [
label="table(csv)"
width=1
]
table2 [
label="table(json)"
width=1
]
view1 [
label="view({\l row_pivot: [\"Category\"]\l filter: [[\"State\",\"==\",\"Texas\"]]\l})\l"
width=3
]
view2 [
label="view({\l row_pivot: [\"Category\",\"Sub-Category\"]\l})\l"
width=3
]
view3 [
label="view()\l"
width=3
]
table1 -> {view1 view2};
table2 -> view3;
}
subgraph cluster_3 {
graph [
label="\lWeb Worker #2";
style=filled
fillcolor=lightgrey
color=none
fontcolor=gray30
fontsize=10
]
table3 [
label="table(arrow)"
width=1
]
view4 [
label="view({\l row_pivot: [\"State\"]\l column_pivot: [\"Segment\"]\l})\l"
width=3
]
table3 -> view4;
}
subgraph cluster_4 {
label = "Main";
}
view1 -> viewer1;
view2 -> viewer2;
view3 -> viewer3;
view4 -> viewer4;

viewer1 [
label = "<perspective-viewer\l view=\"y_bar\" row-pivots='[\"Category\"]'\l filters='[[\"State\",\"==\",\"Texas\"]]'>\l"
width=3.2
];
viewer2 [
label = "<perspective-viewer\l view=\"xy_scatter\"\l row-pivots='[\"Category\",\"Sub-Category\"]'>\l"
width=3.2
];
viewer3 [
label = "<perspective-viewer\l view=\"grid\">\l"
width=3.2
];
viewer4 [
label = "<perspective-viewer\l view=\"heatmap\"\l row-pivots='[\"State\"]\l column-pivots='[\"Segment\"]'>\l"
width=3.2
];
label="\lBrowser";
color=none
}
}
158 changes: 158 additions & 0 deletions docs/architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit b858525

Please sign in to comment.