Advertising sustains the DA. Ads are hidden for members. Join today

Using the Chart API

Pie Chart created with Drupal module Chart (using the Google Image Charts library)

The Chart module provides a unified Application Programming Interface (the Chart API for short) for the integration of the Google Image Charts charting library in a Drupal site.

This Chart API is typically used by Drupal developers, by using it from within another Drupal module. Something that is typically done from within all sorts of Modules facilitating charting via the Chart module (and there are quite a few of them ...).

The Chart API can also be used by content editors with basic PHP knowledge, to edit nodes in which the appropriate PHP code is entered to basically enter the specification of the chart to be created. That requires the PHP code filter to be enable (and authorized) though, something that in general is considered as rather dangerous ... but it is an option to consider.

Drupal site builders however (or anybody not willing or able to write PHP scripts) should rather use the views integration of the chart module instead, for which no PHP scripting knowledge is required.

The child pages of this documentation page, contains more details about how to use the Chart API.

Note: This page and its child pages are still incomplete ... Some suggestions for anybody interested in contributing to get it completed:

  1. There is still quite some (outdated) google wiki docu that has to be integrated also (via new child pages of this page, so that it can be used for hyperlinking them later on), ie:
    1. Chart API Examples.
    2. The Chart API Generation functions.
    3. The Chart API Array Structure childpage is already in fairly good shape, but still contains some ??? marks.
    4. The Helper Functions (still called Utility Functions in the google wiki documentation).
    5. Documentation about Chart API Hooks has been integrated ... but has some remaining tasks to be completed.
  2. The google wiki docu overview page still has a ton of extra comments that might seem worth reviewing (to incorporate some of it around here) ...
  3. Try to complete/correct anything marked with ???, e.g. after researching the module's source code, or the issue queue ...

Chart API Array Structure

The following describes the parameters which can be entered manually or used along with the helper functions to create what is called the

Chart API Examples

Below are some examples to help you create your own charts using the API provided by the Chart module. Note that the examples differ

Chart API Generation Functions

Documentation about the Chart Generation functions still has to be migrated to this community page ... and needs further completion (e.g. to

Chart API Helper Functions

Helper Functions are available to simplify building and/or modifying the Chart API Array structure. Below is a list of all Helper Functions

Chart API Hooks

Below is a list of hooks available in the Chart module. They can be used for modifying the chart definitions (stored in $chart, an

Guide maintainers

Pierre.Vriens's picture