Javascript Renderer for KineticGraphs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea
build
docs
src
.DS_Store
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.md
_config.yml
bundle.py
kg.js
package-lock.json
package.json
playground.zip
tsconfig.json

README.md

kg.js

Javascript Renderer for KineticGraphs

See documentation page

Here

What it does

The purpose of kg.js is to provide a way to render interactive diagrams ("KineticGraphs") defined as a JSON.

Once the page is loaded, kg.js looks for any elements with a class name kg-container. These elements should have a src attribute with a URL pointing to a JSON file. This file contains all the information necessary to render a KineticGraph and handle user interactions with it.

Each KineticGraph is a standalone diagram, and does not communicate with the outside page. In particular, you can have multiple graphs rendered from the same JSON and interact with them separately.

Each KineticGraph maintains its aspect ratio as the page window changes dimensions. If a KineticGraph includes a sidebar (an area to the right, which generally contains a caption as well as user controls like sliders), that sidebar is positioned to the right of the diagram for wide pages, and below the diagram for smaller ones. This responsive flow and layout is designed to work seamlessly with Tufte CSS; just place a KineticGraph within a figure element with class fullwidth.

Dependencies

This project is made possible by two incredible open-source technologies:

  • D3 for drawing
  • KaTeX for rendering math

For convenience, minified versions of the JS and CSS dependencies are included in this repository in the build/lib folder. This folder includes the necessary JS and CSS files as well as the fonts required for KaTex and Tufte CSS. To use these, add kg-lib.js and either kg-lib.css or kg-tufte.css. If your project already includes those libraries, you can just use kg.js.

Quick Start

This library is very much in flux and there isn't much documentation for that reason. As I create graphs, I often find that there are better ways of specifying things.

That said, if you want to play around with some JSON, try downloading playground.zip. It's a self-contained folder with everything you need to get started with no external dependencies.

Code Development

Please email me if you're interested in helping develop the code. Most development occurs during the summer months when I'm not teaching. :)