https://github.com/pr0m1th3as/octave-chartjs
ChartJS interface for GNU Octave
https://github.com/pr0m1th3as/octave-chartjs
Last synced: about 2 months ago
JSON representation
ChartJS interface for GNU Octave
- Host: GitHub
- URL: https://github.com/pr0m1th3as/octave-chartjs
- Owner: pr0m1th3as
- License: gpl-3.0
- Created: 2024-09-16T18:50:07.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-16T22:15:57.000Z (2 months ago)
- Last Synced: 2025-02-16T22:27:01.775Z (2 months ago)
- Language: C++
- Size: 214 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: COPYING
Awesome Lists containing this project
- awesome - octave-chartjs
README
# chartjs
A ChartJS interface for GNU Octave.
**Content:**
1. [About](#1-about)
2. [Documentation](#2-documentation)
3. [Installation](#3-installation)
## 1. About
The **chartjs** package is a collection of [classdef Classes](https://docs.octave.org/latest/classdef-Classes.html) for interfacing Octave with the [CharJS](https://www.chartjs.org/) JavaScript charting library. The package is at a very initial development stage and only supports the eight basic chart types of the CharJS library without any support for further [configuration](https://www.chartjs.org/docs/latest/configuration/) and [plugins](https://github.com/chartjs/awesome?tab=readme-ov-file#plugins) usually defined under the `options:` tag in JavaScript code.
The **chartjs** package aims to facilitate the generation of web-ready HTML code for 2D charts through the familiarity of native Octave language. All available chart-specific classdef Classes rely on the parent `Html` classdef for generating CharJS compatible json strings as well as HTML standalone code. The package also provides a `WebServer` Class for running a local web service for displaying locally the generated charts. **Note**, that this functionality is **highly experimental**, it has only been tested under Ubuntu 20.04LTS and Octave 9.1, and it has been previously reported to cause issues with Octave under Windows.
## 2. Documentation
All classdef Classes and their respective methods are documented with [texinfo](https://www.gnu.org/software/texinfo/) format, which can be accessed from the Octave command with the `help` function. Use dot notation to access the help of a particular method. For example:
```
help BarChart
help BarChart.jsonstring
```
To access the documentation of available methods inherited from the `Html` Class, type:
```
help Html.htmlstring
help Html.htmlsave
help Html.webserve
```
You can also find the entire documentation of the **chartjs** package along with its classdef index at [https://pr0m1th3as.github.io/octave-chartjs/](https://pr0m1th3as.github.io/octave-chartjs/). Alternatively, you can build the online documentation locally using the [`pkg-octave-doc`](https://github.com/gnu-octave/pkg-octave-doc) package. Assuming both packages are installed and loaded, browse to any directory of your choice with *write* permission and run:
```
package_texi2html ("chartjs")
```
## 3. Installation
To install the latest release, you need Octave (>=8.1.0) installed on your system. Install it by typing:
`pkg install -forge chartjs`
Install the latest dev version from the Octave command prompt by typing
`pkg install "https://github.com/pr0m1th3as/octave-chartjs/archive/refs/heads/main.zip"`
This package also uses the [CrowCpp](https://crowcpp.org/master/) library (header only) for running a local web service for the generated charts. You need to install the standalone [Asio C++](https://think-async.com/Asio/) library for the package to compile correctly.