progress-gantt

Table of Contents

• ProgressGantt
  • Parameters
  • draw
    • Parameters
  • remove
  • imageSource
  • svgSource

ProgressGantt

Draw a progress gantt.

Play with the settings of the progress-gantt by visiting the progress-gantt playground.

Install in your Node project with

npm i progress-gantt

and use it inside your code via

const progressGantt = require('progress-gantt');

or, alternatively

import progressGantt from 'progress-gantt';

Create the new progress gantt objects via

let diagram = progressGantt(settings);

Parameters

• settings Object The configuration object for the progress gantt. All data for the progress gantt is provided with this object.
  • settings.svg Object The DOM tree element, wich must be an svg tag. The progress gantt will be attached to this DOM tree element. Example:

    settings.svg = document.getElementById('progressGantt');

    'progressGantt' is the id of a svg tag.
  • settings.id String? The id of a domtree svg element, to which the progress gantt will be bound to. The id will only be used in case settings.svg is not provided.
  • settings.width Number? Width in pixels for the progress gantt without borders and margins. Default is 600.
  • settings.height Number? Height in pixels for the progress gantt without borders and margins. Default is 400.
  • settings.fontSize Number? Size in pixels for all labels. Default is 16
  • settings.fontFamily String? The font to use for all labels. Default is sans-serif.
  • settings.margin {top: Number, right: Number, bottom: Number, left: Number}? The margin for the progress gantt. Default values are:

    settings.margin = {
    top: 0,
    right: 0,
    bottom: 0,
    left: 0 }
    

draw

Draw the progress gantt.

Parameters

• settings Object? The configuration object for the progress gantt. Optional. If provided, will overwrite the settings object already given to the constructor.

remove

Clear the progress gantt.

imageSource

Draw the progress gantt and return the result as a string which can be assigned to the SRC attribute of an HTML IMG tag.

Returns string

svgSource

Draw the progress gantt and return the result as a SVG tag string.

Returns string