You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,13 +67,14 @@ const TAG = require("text-annotation-graphs");
67
67
import TAG from "text-annotation-graphs";
68
68
```
69
69
70
-
Then initialise the visualisation on an element, optionally specifying the initial data set to load. For more details, consult the full API documentation.
70
+
Then initialise the visualisation on an element, optionally specifying the initial data set to load and any overrides to the default options. For more details, consult the full API documentation.
71
71
72
72
```
73
73
const graph = TAG.tag({
74
74
container: $container,
75
-
data: <...>,
76
-
format: "json"
75
+
data: {...},
76
+
format: "odin",
77
+
options: {...}
77
78
});
78
79
```
79
80
@@ -85,6 +86,9 @@ Tasks are managed via [`npm` scripts](https://docs.npmjs.com/misc/scripts) and t
85
86
86
87
After cloning the repository and installing the project dependencies via `npm install`, you can run the interactive demo using `npm run demo` and directing your browser to `localhost:8080`.
87
88
89
+
To run the demo on a different port, set the `PORT` environmental variable. For example, running `PORT=9000 npm run demo` will start the demo server on `localhost:9000` instead.
90
+
91
+
88
92
### Building the source
89
93
90
94
TAG is written in ES6, and uses [Sass](https://sass-lang.com/) for its styles.
0 commit comments