PyWaffle Documentation

PyWaffle is an open source, MIT-licensed Python package for plotting waffle charts — also known as square pie charts, and, when drawn with icons, pictogram charts.

A waffle chart is a grid of blocks where one block stands for a fixed quantity, so a proportion is something the reader can count rather than estimate.

from pywaffle import waffle_chart

fig, ax = waffle_chart({"Survived": 710, "Lost": 1491}, rows=10, columns=10)

PyWaffle is also a Figure constructor class Waffle, which can be passed to matplotlib.pyplot.figure to generate a matplotlib Figure object. Both forms are fully supported — see the Quickstart.

Visit PyWaffle on Github and PyPI.

Contents:

• Installation
• Quickstart
  • Install
  • Your first chart
  • Colours, a title, and the numbers
  • Nobody rounded away
  • A continuous grid
  • Icons, for a pictogram chart
  • Several charts in one figure
  • Into a layout you already have
  • The other two ways to call it
  • Where next
• Examples
  • Basic Examples and Formats of Values
  • Figure and Axis Manipulation
  • Value Scaling and Auto-sizing
  • Title, Label and Legend
  • Block Colors
  • Plot with Characters or Icons
  • Block Shape, Spacing, Location, Direction and Arranging Style
  • Subplots
  • Adjust Figures
  • Add Other Elements
• Font Awesome Integration
  • Which Font Awesome is in use
  • Where the fonts come from
  • Using a system Font Awesome
  • Upgrading or downgrading Font Awesome
• API Reference
  • Function
  • Figure class