codecharta-visualization

CodeCharta

CodeCharta by MaibornWolff

Jump to Section

• Installation
• Grunt Tasks
• JSON structure
• License

Installation

[Back To Top]

Install application for desktop usage with npm

• install with npm install codecharta-visualization -g
• run with codecharta-visualization

Install application for desktop usage

• Download or build latest version for your system.
• Doubleclick the system specific Runnable. You may be required to give it executable rights.

Install project for development

• Install node 8
• Install dependencies npm install.

Once you have installed the project, you can use all grunt tasks described in the next section.

Install web application on server

• Download or build latest web version.
• Copy all files (dist/app or the downloaded directory) to a served directory which is accessible from the internet.

Grunt Tasks

[Back To Top]

Build

npm run build builds the project in dist/app. This artifact is ready to be served as a web application. npm run doc generates the esdoc documentation in dist/doc/

Test

npm run test runs all unit tests on the source files in app/ and generates a coverage report in dist/coverage/.

Run

npm run serve starts a simple web server and serves the project on localhost:9000. npm run start starts the nwjs app

Package

npm run package packages the nwjs app

Watch

npm run watch:app watches the app directory and triggers a quick rebuild. npm run watch:unit watches the unit test directory and runs tests on change.

URL Parameters used by the web application

[Back To Top]

The web application allows the usage of query parameters in the URL to set certain settings. Query params are added by appending a ? to the url, followed by a key value pair key=value. Additional parameters can be added by appending &key2=value2. E.g. http://yourdomain.com/pathtocc/index.html?file=something.json&scaling.x=2&areaMetric=myMetric

• The file parameter is a special parameter which accepts a file location. The file must be reachable through XHR.
• All other parameters are defined by the Settings class. areaMetric=myMetric therefore sets the value of settings.areaMetric to myMetric. Nested properties like settings.scale.x can be set by the query parameter scaling.x=42
• The map parameter is disabled since it would be too much for the URL bar of your browser.
• The URL in your browser gets automatically updated when you change settings through the UI. It provides a simple way to customize your links with query parameters.

JSON structure

[Back To Top]

Example Data

JSON Schema