API Reference

How to retrieve data

DataPool

PivotDataPool

How to create the charts

Chart

PivotChart

How to use chartit django template filters

Quick Reference for series and series_options

PivotDataPool series PivotChart series_options
[{'options': {
    'source': SomeModel.objects.all(),
    'top_n_per_cat': 10, ...
    }
  'terms': {
    'any_name_here': Sum('a_valid_field'),
    'some_other_name':{
      'func': Avg('a_valid_field),
      #any options to override
      ...
      },
    ...
    }
 },
 ... #repeat dicts with 'options' & 'terms'
 ]
[{'options': {
    #any items from HighChart series. For ex.
    'type': 'column'
    },
  'terms': [
    'a_valid_term',
    'other_valid_term': {
      #any options to override. For ex.
      'type': 'area',
      ...
      },
    ...
    ]
  },
  ... #repeat dicts with 'options' & 'terms'
  ]
DataPool series Chart series_options
[{'options': {
    'source': SomeModel.objects.all(),

    }
  'terms': [
    'a_valid_field_name',
    ..., # more valid field names
    {'any_name': 'a_valid_field_name',
     ... # more name:field_name pairs
     },
    ]
 },
 ... #repeat dicts with 'options' & 'terms'
 ]
[{'options': {
    #any items from HighChart series. For ex.
    'type': 'column'
    },
  'terms': {
    'x_name': ['y_name', 'y_name', ...],
    # only corresponding keys from DataPool
    # terms are valid names.
    ...

    }
  },
  ... #repeat dicts with 'options' & 'terms'
  ]