Difference between revisions of "Making a Pie Chart"

From Scribus Wiki
Jump to: navigation, search
(But wait! There's more!)
Line 165: Line 165:
  if scribus.haveDoc():         
  if scribus.haveDoc():         
     scribus.placeSVG(svgfile, 100, 100) # This will place your SVG on the current page - works on 1.5.3svn at least
     scribus.placeSVG(svgfile, 100, 100) # This will place your SVG on the current page - works on 1.5.3svn at least
    Totalframe = scribus.createText(340, 300, 100, 50)
    scribus.insertText("Total = " + str(total), 0, Totalframe)

Revision as of 20:23, 13 November 2016

This article is part of the Scripts series.

The difficulty with making a pie chart with Scribus is that, if there is a way to use the various drawing tools to do it, the programming is quite beyond anything one would want to tackle. What we need then, is a more elegant way. Fortunately, with SVGs, there is a way.

What you cannot do is draw a circle, then subdivide it, because what we really want is a series of segments like variably sized pieces of pie, each of which can have its own fill color. What I want to show in this page is the process of putting information together to make the python script you will find at the end.

SVG Specifications and Drawing Arcs

For the details and much more information about SVG specifications, check this link.

Abcpie.png Let's start with this example pie chart segment. It turns out that the way we are going to use SVG specs to tell a program how to draw this shape is to start with point 1, draw a line to point 2, then draw the arc from 2 to 3, then go back to 1.

Here is the path command that will accomplish this:

<path d="M 200,200 l 150,0 a150,150 0 0,0 -37,-97 z" 
fill="red" stroke="black" stroke-width="2" stroke-linejoin="round" />

The first line shows our directions. M is the command for our starting point, the center of our pie circle, and relates to a point relative to the screen origin of our SVG space -- the upper left hand corner. After this all subsequent commands will be relative ones (in this example). Next the l says to draw a line from the starting point 150 X-units, but Y stays the same. (For this first segment, we could have used the h command, which will draw a horizontal line, but we need to generalize our process, and most or all of the other segments will not have a horizontal line.)

Now we draw our arc, using the a command, which is followed by X and Y radii, each of which we have set to 150 -- if they were not equal, we would be drawing an elliptical arc. Next are three zeros, but only the middle might need to be changed for our pie chart. Since we are only specifying two points along a hypothetical circle, we need to specify whether we will take the short route or the long route around the circle. Our middle zero says to take the short route (our piece of pie is less than half the pie).

Now, the tricky part. The last two numbers (-37, -97) are the relative distances from point 2 to point 3, in Cartesian X,Y computer-display coordinates. Finally, the z at the end says to complete this shape to a closed form -- go back to point 1.

How do we figure out these relative measurements along our arc? Trigonometry.

Trigonometry Awakens

Let's think about what pie charts represent. Pie charts merely show us visually how some whole list of data values is subdivided into its components, with the size of each piece corresponding to the size of its share of the pie. So to know how big this piece should display, I need to divide it by the total size of the pie. Since the circle of our pie spans 360°, our formula looks like this:

  angle = [(size of piece)/total] × 360 

which gives us the angle of the circle occupied by our segment.

123pie.png We're trying to figure out the X,Y coordinates of point 3 relative to the center -- remember those relative commands we used above in the SVG file? Once we know those coordinates, subtracting them from the coordinates of point 2 will give us our relative values for the SVG path command. So we imagine a right triangle, with 1-3 being its hypoteneuse. The coordinates of point 3 are x = base, y = height of this imaginary triangle. The distance 1-3 is our radius, and so if we also know the angle of our pie piece:
  x = cos(angle) × radius
  y = sin(angle) × radius
But what about the next segment? We relied on the starting line being along the X-axis for our calculations. For the subsequent segments, let's stay with that reference point. We don't necessarily need to know the angle occupied by each segment, what we need are the corner points for our SVG calculations.

Add the original data value for the first pie piece to the value of the second, and divide that by the total, for the fraction of our pie circle:

  angle = [(size of piece A + size of piece B)/total] × 360 

Now if we use our cosine and sine formulas again with this obtuse angle, we will get the correct X,Y values for point 4.

Eventually, we work our way around the pie, so that we have the coordinates for all these points, making the relative calculations as we go, as you see in piechart.py. From a mathematical point-of-view, we end up with more consistent results when we calculate from the same starting point. If we made successive calculations by shifting the reference point, we are likely to see additive errors related to the slight imprecision of our calculations -- the result might be either a gap or an overlap with the final segment.

Using piechart.py

When you start piechart.py, you first get a requester asking for the filename to save to. Whatever you enter, ".svg" will be appended to your name.

Next a requester appears asking for data -- your data values from which the calculations and pie chart will be created. After you enter one number, the requester appears again and will keep reappearing until you press Enter with no entry, or enter "0" (the number).

A message box appears telling you that the file has been created.

News for 1.5.3svn

Originally I was trying to use an undocumented command importSVG(), and could not get this to work. There is now a command placeSVG(), and this does work as expected, so I have edited the script to add this. The SVG will still be saved also.

Some Examples
Piechart1.png Here are two examples of output with the same data. The one on the right can be made by changing piechart.py so that the bordercolor is 'none', setting the stroke-width to "0", or editing in Scribus.


Piechart3.png This last example can easily be done in Scribus -- first ungroup the SVG (Item > Ungroup, keyboard: Ctrl+Shift+G (Ctrl+U in and, or find in Context Menu - right-click on SVG). Then individual segments can be selected and manipulated/edited in various ways. If you want to change the fill color of an individual segment, you must ungroup first.
Incidentally, all the drawings in this
Wiki page were made using piechart.py,
then afterprocessing with Scribus,
followed by a screen grab.

Don't Try This At Home (or At Work/School)

Here is a note on the interaction between aesthetics and an accurate depiction of data. You will sometimes see pie charts given a "tilted" appearance, presumably to enhance the aesthetic appeal. This example is made to show what happens when you do this. In both of these partial pie charts, the wedges are made from identical data. On the right, even though these segments should appear the same overall size to reflect their data, they do not, or at least it is hard to discern -- the position of the segment on the pie affects its apparent size. Piechart5.png


#!/usr/bin/env python
# File piechart.py
# Created 2006-05-29
# Gregory Pittman
# Automatically creates a piechart SVG file
# from a list of data
# Script works with Scribus versions 1.2.x, 1.3.3.x, 1.3.4+, and 1.5.3svn
from __future__ import division

import math
import scribus
# We'll create a list L, append to it, then copy the list to a file at the end
L = ['<?xml version="1.0" encoding="UTF-8" standalone="no"?>\n']
L.append('<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"\n') 
L.append('<svg width="20cm" height="20cm" xmlns="http://www.w3.org/2000/svg" version="1.1">\n')
svgfile = scribus.valueDialog('SVG File','Enter name of file to save to\n".svg" will be appended')
svgfile = svgfile + '.svg'
sectors = []
while 1:
    newvalue = scribus.valueDialog('Data Entry','Enter Data\n Enter 0 or no value to End')
    if (newvalue == ''):
        newvalue = '0'
    newnum = float(newvalue)
    if newnum == 0:break
total = 0
i = 0
seg = 0
radius = 150
startx = 200   # The screen x-origin: center of pie chart
starty = 200   # The screen y-origin: center of pie chart
lastx = radius # Starting coordinates of 
lasty = 0      # the first arc
ykey = 25
# If you don't like my colors -- here's where to fix the ugliness. 
# If you need more than 9, add as many as you like
colors = ['red','blue','yellow','magenta','orange','slateblue','slategrey','greenyellow','wheat']
bordercolor = 'black'
for n in sectors:
    total = total + n  # we have to do this ahead, since we need the total for the next for loop

for n in sectors:
    arc = "0"                   # default is to draw short arc (< 180 degrees)
    seg = n/total * 360 + seg   # this angle will be current plus all previous
    if ((n/total * 360) > 180): # just in case this piece is > 180 degrees
        arc = "1"
    radseg = math.radians(seg)  # we need to convert to radians for cosine, sine functions
    nextx = int(math.cos(radseg) * radius)
    nexty = int(math.sin(radseg) * radius)

# The weirdly placed minus signs [eg, (-(lasty))] are due to the fact that
# our calculations are for a graph with positive Y values going up, but on the
# screen positive Y values go down.

    L.append('<path d="M '+str(startx)+','+str(starty) + ' l '+str(lastx)+','+str(-(lasty))+' a' + str(radius) + ',' + str(radius) + ' 0 ' + arc + ',0 '+str(nextx - lastx)+','+str(-(nexty - lasty))+ ' z" \n') 
    L.append('fill="'+colors[i]+'" stroke="' + bordercolor + '" stroke-width="2" stroke-linejoin="round" />\n')
    L.append('<rect x="375" y="'+ str(ykey) + '" width="40" height="30" fill="'+colors[i] + '" stroke="black" stroke-width="1"/>\n') # this line and next create the key
    ykey = ykey + 35
# We are writing the XML commands one segment at a time, so we abandon old points
# we don't need anymore, and nextx becomes lastx for the next segment
    lastx = nextx
    lasty = nexty
    i += 1
L.append('</svg>')         # End tag for the SVG file
output = open(svgfile,'w') # We've done all the calculations and filled
output.writelines(L)       # up list L with our commands, so now we just
output.close()             # write to a file all at once.
endmessage = svgfile + ' was created'
scribus.messageBox("Finished",endmessage,icon=scribus.ICON_NONE,button1=scribus.BUTTON_OK)  # Just for some user feedback

 if scribus.haveDoc():         
    scribus.placeSVG(svgfile, 100, 100) # This will place your SVG on the current page - works on 1.5.3svn at least
    Totalframe = scribus.createText(340, 300, 100, 50)
    scribus.insertText("Total = " + str(total), 0, Totalframe)

But wait! There's more!

What about a key for our piechart? Easy. Somewhere around the line lasty = 0 add this line:

ykey = 25

Then just before the line lastx = nextx add these two lines:

    L.append('<rect x="375" y="'+ str(ykey) + '" width="40" height="30" fill="'+colors[i] + '" stroke="black" stroke-width="1"/>\n')
    ykey = ykey + 35

I've updated the script above with these changes.

So now, when we run this new modified script, we get:

Piechart4.png A recommendation you will find in the Scribus Documentation is that when you get ready to add text labels and any other annotations to this piechart, you will want to do these in Scribus, since this will lead to a better result in your eventual PDF as far as text resolution.

If for some reason you may not want a key, and will simply add annotations to the pie itself, you can ungroup your SVG and delete these key elements. Alternatively, add another requester at the beginning asking if a key is desired, then turn the L.append('<rect... statement into a conditional with an if depending on the requester response. If you are not making a key, the assignment and changes in the ykey variable do not matter.

Could there POSSIBLY be more?

Sure, but consider this your homework.

Look at this fragment from Creating a Graph, Part 2:

    caption = "Scale for this graph\n\n" "X: " + str(xmark) + "units/mark\n" + "Y: "
    caption = caption + str(ymark) + "units/mark\n" + str(xscale) + " pts/unit (X)\n"
    caption = caption + str(yscale) + " pts/unit (Y)"
# These caption statements can be combined to one line
    S = scribus.createText(200, 120, 150, 80)
    scribus.setTextColor("Blue", S)
    scribus.setText(caption, S)
    scribus.setTextAlignment(1, S)
    scribus.setFont("Nimbus Roman No9 L Bold", S)
    scribus.setFontSize(8, S)

With some modifications you could add a text frame to piechart.py, giving you the numbers you added and the percentages of the total they represent, just in case you need that for your annotations. Just remember, you will print the text frame on your page, not add it to the SVG.