gadget_officejs_interface_widget_gantt_html.html 3.02 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
<!DOCTYPE html>
<html>
  <head>
    <title>Gantt Interface</title>
  </head>
  <body>
    <h1>widget_gantt_interface</h1>
    <h3>A Gantt gadget allows to display various types of schedules using Gantt diagrams</h3>
    <dl>
      <dt>render</dt>
      <dd>render a Gantt diagram</dd>
      <dl>
        <dt data-parameter-required="required" data-parameter-type="object">configuration_dict</dt>
        <dd><code style="display:block;white-space:pre-wrap">

  Generic timeline gadget. The purpose of this gadget is to provide an unique
  API for various gantt libraries

  Options supported are :
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Parameters to generate a gantt",
  "properties": {
   "data_list": {
      "description": "the list of task to be displayed in timeline",
      "items": {
          "properties" : {
            "title": {
              "description": "The title of the task",
              "type": "string"
            },
            "id": {
              "description": "an identifier for the task",
              "type": "string"
            },
            "parent_id": {
              "description": "the identifier of the corresponding parent, this is optional for top level task",
              "type": "string"
            },
            "start_date": {
              "description": "task starting date",
              "type": "string"
            },
            "stop_date": {
              "description": "task end date",
              "type": "string"
            },
            "background_color": {
              "description": "task color",
              "type": "string"
            },
            "type": {
              "description": "type of task. project is for a task depending on subtast, milestone represent a milestone, and task is a standard task",
              "type": "string",
              "default": "task",
              "enum": ["task", "project", "milestone"]
            },
          },
          "additionalProperties": false,
          "type": "object",
          },
      "type": "array",
      }
  },
  "additionalProperties": false
}

  Example of options:
  { data_list : [{'id': '1',
                  'title': 'Phase 1',
                  'start_date': '2017-03-01',
                  'stop_date': '2017-04-15',
                  'type': 'project'},
                 {'id': '1.1',
                  'parent_id': '1',
                  'title': 'Task A in Phase 1',
                  'start_date': '2017-03-01',
                  'stop_date': '2017-04-10',
                  'type': 'task'},
                 {'id': '1.2',
                  'parent_id': '1.1',
                  'title': 'Task B in Phase 1',
                  'start_date': '2017-04-01',
                  'stop_date': '2017-04-15',
                  'type': 'task'},
                 {'id': '2',
                  'title': 'Phase 2',
                  'start_date': '2017-04-15',
                  'stop_date': '2017-06-30',
                  'type': 'task'}]
  }
          </code></dd>
      </dl>
    </dl>
  </body>
</html>