Chart.js charts for Wagtail
Project description
Wagtail Charts
Chart.js charts in Wagtail, edited and customised from the Wagtail admin
Getting started
Assuming you have a Wagtail project up and running:
pip install wagtailcharts
Add wagtailcharts
to your settings.py in the INSTALLED_APPS section, before the core wagtail packages:
INSTALLED_APPS = [ # ... 'wagtailcharts', # ... ]
Add a wagtailcharts ChartBlock to one of your StreamFields:
from wagtailcharts.blocks import ChartBlock class ContentBlocks(StreamBlock): chart_block = ChartBlock()
Include your streamblock in one of your pages
class HomePage(Page): body = StreamField(ContentBlocks()) content_panels = Page.content_panels + [ StreamFieldPanel('body'), ]
Add the wagtailcharts_tags
templatetag to your template and call the render_charts
tag just before your </body>
closing tag.
Please note that you must render your chart block so that the render_charts
tag can detect the charts.
Here is a tiny example of a page rendering template:
{% load wagtailcore_tags wagtailcharts_tags %} {% block content %} <div class="container-fluid"> <div class="row"> <div class="col-6"> <h1>{{self.title}}</h1> <div class="excerpt">{{self.excerpt|richtext}}</div> </div> </div> {% for block in self.body %} {% include_block block %} {% endfor %} </div> {% endblock %} {% block extra_js %} {% render_charts %} {% endblock %}
Configuration
ChartBlock
accepts a few extra arguments in addition to the standard StructBlock
arguments.
colors
A tuple of color tuples defining the available colors in the editor.
from wagtailcharts.blocks import ChartBlock COLORS = ( ('#ff0000', 'Red'), ('#00ff00', 'Green'), ('#0000ff', 'Blue'), ) class ContentBlocks(StreamBlock): chart_block = ChartBlock(colors=COLORS)
Dependencies
- This project relies on Jspreadsheet Community Edition for data entry and manipulation.
- Charts are rendered using Chart.js.
- 100% stacked bar charts use a plugin https://github.com/y-takey/chartjs-plugin-stacked100
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Built Distribution
Hashes for wagtailcharts-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e7f9f60c6f5f4b2fb2a1966ed33a59f92e527673ce59a899ace14f3f2da03ec |
|
MD5 | 43c1184878ab4500cb46b4e15cef525f |
|
BLAKE2-256 | 0cce9bb2d20b01e7dc66e7694b284cf4dbd3717b7383e5a24da8fee17e6b1066 |