Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-band/gantt
Gantt chart library using jsx support SVG, Canvas and SSR
https://github.com/d-band/gantt
canvas gantt-chart jsx ssr svg virtual-dom
Last synced: 2 months ago
JSON representation
Gantt chart library using jsx support SVG, Canvas and SSR
- Host: GitHub
- URL: https://github.com/d-band/gantt
- Owner: d-band
- Created: 2016-08-04T04:13:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-07-12T08:03:01.000Z (over 3 years ago)
- Last Synced: 2024-10-04T13:53:17.640Z (2 months ago)
- Topics: canvas, gantt-chart, jsx, ssr, svg, virtual-dom
- Language: JavaScript
- Homepage: https://d-band.github.io/gantt/
- Size: 573 KB
- Stars: 274
- Watchers: 14
- Forks: 60
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - d-band/gantt - Gantt chart library using jsx support SVG, Canvas and SSR (others)
README
Gantt Chart
===========
> Gantt chart library using jsx support SVG, Canvas and SSR
[](https://www.npmjs.com/package/gantt)
[](https://www.npmjs.com/package/gantt)
[](https://greenkeeper.io/)
## Install
```bash
$ npm install gantt --save
```
## Usage
[View demo online](https://d-band.github.io/gantt/)
```javascript
import { SVGGantt, CanvasGantt, StrGantt } from 'gantt';
const data = [{
id: 1,
type: 'group',
text: '1 Waterfall model',
start: new Date('2018-10-10T09:24:24.319Z'),
end: new Date('2018-12-12T09:32:51.245Z'),
percent: 0.71,
links: []
}, {
id: 11,
parent: 1,
text: '1.1 Requirements',
start: new Date('2018-10-21T09:24:24.319Z'),
end: new Date('2018-11-22T01:01:08.938Z'),
percent: 0.29,
links: [{
target: 12,
type: 'FS'
}]
}, {
id: 12,
parent: 1,
text: '1.2 Design',
start: new Date('2018-11-05T09:24:24.319Z'),
end: new Date('2018-12-12T09:32:51.245Z'),
percent: 0.78,
}];
new SVGGantt('#svg-root', data, {
viewMode: 'week'
});
new CanvasGantt('#canvas-root', data, {
viewMode: 'week'
});
const strGantt = new StrGantt(data, {
viewMode: 'week'
});
this.body = strGantt.render();
```
## API
```typescript
interface Link {
target: number,
type: 'FS' | 'FF' | 'SS' | 'SF'
}
interface Item {
id: number,
parent: number,
text: string,
start: Date,
end: Date,
percent: number,
links: Array
}
type StyleOptions = {
bgColor: string, // default: '#fff'
lineColor: string, // default: '#eee'
redLineColor: string, // default: '#f04134'
groupBack: string, // default: '#3db9d3'
groupFront: string, // default: '#299cb4'
taskBack: string, // default: '#65c16f'
taskFront: string, // default: '#46ad51'
milestone: string, // default: '#d33daf'
warning: string, // default: '#faad14'
danger: string, // default: '#f5222d'
link: string, // default: '#ffa011'
textColor: string, // default: '#222'
lightTextColor: string, // default: '#999'
lineWidth: string, // default: '1px'
thickLineWidth: string, // default: '1.4px'
fontSize: string, // default: '14px'
smallFontSize: string, // default: '12px'
fontFamily: string, // default: '-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif'
}
type Options = {
viewMode: 'day' | 'week' | 'month',
onClick: (item: Item) => {},
offsetY: number, // default: 60,
rowHeight: number, // default: 40,
barHeight: number, // default: 16,
thickWidth: number, // default: 1.4,
styleOptions: StyleOptions
}
declare class SVGGantt {
constructor(element: string | HTMLElement, data: Array, options: Options);
setData(data: Array): void; // set data and re-render
setOptions(options: Options): void; // set options and re-render
render(): void;
}
declare class CanvasGantt {
constructor(element: string | HTMLElement, data: Array, options: Options);
setData(data: Array): void; // set data and re-render
setOptions(options: Options): void; // set options and re-render
render(): void;
}
declare class StrGantt {
constructor(data: Array, options: Options);
setData(data: Array): void;
setOptions(options: Options): void;
render(): string;
}
```
## Report a issue
* [All issues](https://github.com/d-band/gantt/issues)
* [New issue](https://github.com/d-band/gantt/issues/new)
## License
Gantt is available under the terms of the MIT License.