Skip to content
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
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/node_modules
/doc
.idea/
/examples/birmingham/data/identify/
/examples/birmingham/data/split_data.py
Expand Down
56 changes: 56 additions & 0 deletions doc/config_json.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Application configuration file
=============================

The configuration file is description of the application which is created using this config file.

Structure
----------
**App object**
```json
{
"appName": "",
"dataFileName": "",
"description": "",
"language": "", // cs, uk
"dimensions": [
]
}
```
**Dimension object**
```json
{
"column": "",
"domain": [], // optional
"type": "day",
"name": "days", // KEY
"numBins": 12, // only for type: linear, date, hour
"filter": {
"numBins": 12 // filter granuality, only for type: linear, date, hour
},
"chart":{} // optional
}
```
available type: day, hour, date, month, ordinal, linear

**Spatial dimension object**
```json
{
"xColumn": "",
"yColumn": "",
"type": "",
"filter": true,
"identifyFileURL": "", // only for type: identify
"radius": 300
}
```
available type: heatmap, dotmap, identify


**Chart object**
```json
{
"label": "",
"xLabel": "",
"yLabel": "" // optional
}
```
57 changes: 57 additions & 0 deletions examples/init_config/app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"appName": "Birmingham car accidents",
"dataFileName": "data/data.json",
"description": "bla bla bla bla ...",
"dimensions": [
{
"column": "timestamp",
"type": "hour",
"name": "hours",
"numBins": 24,
"filter": {
"numBins": 48
},
"chart": {
"label": "Hours",
"xLabel": "Hours",
"yLabel": "detections"
}
},
{
"column": "timestamp",
"type": "day",
"name": "days",
"filter": {},
"chart":{
"label": "Days in week",
"xLabel": "Day",
"yLabel": "detections"
}
},
{
"xColumn": "x",
"yColumn": "y",
"type": "heatmap",
"filter": false,
"radius": 500
},
{
"xColumn": "x",
"yColumn": "y",
"type": "dotmap",
"filter": false,
"radius": 30
},
{
"column": "speed_limit",
"type": "ordinal",
"name": "speed_limit",
"filter": {},
"chart":{
"label": "Speed limit",
"xLabel": "Speed limit",
"yLabel": "detections"
}
}
]
}
Loading