GendL Application - PIE-CHART

Object: PIE-CHART (The :GEOM-BASE Package)

Description

Generates a standard Pie Chart with colored filled pie sections. This object was inspired by the pie-chart in Marc Battyani's (marc.battyani(at)fractalconcept.com) cl-pdf, with contributions from Carlos Ungil (Carlos.Ungil(at)cern.ch).

Input Slots (optional)

BOUNDING-BOX [from BASE-OBJECT] list of two 3d points
The left front bottom and right rear top corners, in global coordinates, of the rectangular volume bounding the tree of geometric objects rooted at this object.

DATA list of numbers
The relative size for each pie piece. These will be normalized to percentages. Defaults to NIL, must be specified as non-NIL to get a result.

HIDDEN? [from VANILLA-MIXIN] boolean*
Indicates whether the object should effectively be a hidden-object even if specified in :objects. Default is nil.

IMAGE-FILE [from BASE-OBJECT] pathname or string
Points to a pre-existing image file to be displayed instead of actual geometry for this object. Defaults to nil

INCLUDE-LEGEND? boolean
Determines whether the Legend is included in standard output formats. Defaults to `t`.

LABELS&COLORS list of lists, each containing a string and a keyword symbol
This list should be the same length as `data`. These colors and labels will be assigned to each pie piece and to the legend. Defaults to NIL, must be specified as non-NIL to get a result.

LINE-COLOR keyword symbol naming color from `color-table`
. Color of the outline of the pie. Defaults to :black.

LOCAL-BOX [from BASE-OBJECT] list of two 3d points
The left front bottom and right rear top corners, in global coordinates, of the rectangular volume bounding this geometric object.

OBLIQUENESS [from BASE-OBJECT] 3x3 orthonormal matrix of double-float numbers
This is synonymous with the `orientation`.

ONCLICK-FUNCTION [from BASE-OBJECT] lambda function of zero arguments, or nil
If non-nil, this function gets invoked when the user clicks the object in graphics front-ends which support this functionality, e.g. SVG/Raphael and X3DOM.

RADIUS number
The radius of the pie. Defaults to 0.35 times the `width`.

ROOT [from VANILLA-MIXIN] gdl instance*
The root-level node in this object's ``tree'' (instance hierarchy).

SAFE-CHILDREN [from VANILLA-MIXIN] list of gdl instances*
All objects from the :objects specification, including elements of sequences as flat lists. Any children which throw errors come back as a plist with error information

STRINGS-FOR-DISPLAY [from VANILLA-MIXIN] string or list of strings*
Determines how the name of objects of this type will be printed in most places. This defaults to the name-for-display (generally the part's name as specified in its parent), followed by an index number if the part is an element of a sequence.

TITLE string
Title for the chart. Defaults to the empty string.

TITLE-COLOR keyword symbol naming color from `color-table`
. Color of title text. Defaults to :black.

TITLE-FONT string
Currently this must be a PDF font name. Defaults to "Helvetica."

TITLE-FONT-SIZE number
Size in points of title font. Defaults to 12.

VISIBLE-CHILDREN [from VANILLA-MIXIN] list of gdl instances*
Additional objects to display in Tatu tree. Typically this would be a subset of hidden-children. Defaults to NIL.

Input Slots (optional, defaulting)

CENTER [from BASE-OBJECT] 3d point
Indicates in global coordinates where the center of the reference box of this object should be located.

DISPLAY-CONTROLS [from BASE-OBJECT] plist
May contain keywords and values indicating display characteristics for this object. The following keywords are recognized currently: :color color keyword from the color-table parameter, or an HTML-style hexidecimal RGB string value, e.g. "#FFFFFF" for pure white. Defaults to :black. :line-thickness an integer, defaulting to 1, indicating relative line thickness for wireframe representations of this object. :dash-pattern (currently PDF/PNG/JPEG only). This is a list of two or three numbers which indicate the length, in pixels, of the dashes and blank spaces in a dashed line. The optional third number indicates how far into the line or curve to start the dash pattern.

HEIGHT [from BASE-OBJECT] number
Z-axis dimension of the reference box. Defaults to zero.

LENGTH [from BASE-OBJECT] number
Y-axis dimension of the reference box. Defaults to zero.

ORIENTATION [from BASE-OBJECT] 3x3 matrix of double-float numbers
Indicates the absolute Rotation Matrix used to create the coordinate system of this object. This matrix is given in absolute terms (i.e. with respect to the root's orientation), and is generally created with the alignment function. It should be an orthonormal matrix, meaning each row is a vector with a magnitude of one (1.0).

WIDTH [from BASE-OBJECT] number
X-axis dimension of the reference box. Defaults to zero.

Examples


 (in-package :gdl-user)
 
 (define-object pie-sample (pie-chart)
   :computed-slots
   ((data (list 30 70))
   
    (labels&colors '(("Expenses" :red) ("Revenue" :green)))
   
    (width 200) 
   
    (title "Cash Flow")))

 (generate-sample-drawing :objects (make-object 'pie-sample))

Package Documentation