~syleam/openobject-server/exit-properly

« back to all changes in this revision

Viewing changes to bin/pychart/bar_plot_doc.py

  • Committer: pinky
  • Date: 2006-12-07 13:41:40 UTC
  • Revision ID: pinky-3f10ee12cea3c4c75cef44ab04ad33ef47432907
New trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# automatically generated by generate_docs.py.
 
2
doc="""Attributes supported by this class are:
 
3
cluster_sep(type:length in points (\\xref{unit})) default="The separation between
 
4
    clustered boxes.".
 
5
error_plus_col(type:int) default="The depth of the errorbar is extracted from 
 
6
                  this column in data. This attribute is meaningful only
 
7
                  when error_bar != None.".
 
8
direction(type:str) default="The direction the growth of the bars. The value is either 'horizontal'
 
9
                   or 'vertical'.".
 
10
legend_line_style(type:line_style.T) default="The line style used to draw a legend entry. Usually, the value is None, meaning that the value of "line_style" attribute is used.".
 
11
error_bar(type:error_bar.T) default="Specifies the style of the error bar. <<error_bar>>".
 
12
data_label_format(type:printf format string) default="The
 
13
                          format string for the label displayed besides each
 
14
                          bar.  It can be a `printf' style format
 
15
                          string, or a two-parameter function that
 
16
                          takes (x,y) values and returns a string. The appearance of the string produced here can be
 
17
controlled using escape sequences. <<font>>".
 
18
width(type:length in points (\\xref{unit})) default="Width of each box. 
 
19
@cindex width, bar chart
 
20
@cindex size, bar chart
 
21
".
 
22
bcol(type:int) default="Specifies the column from which base values (i.e., X values when attribute "direction" is "vertical", Y values otherwise) are extracted.
 
23
The
 
24
              combination of "data", "bcol", and "hcol" attributes defines
 
25
              the set of boxes drawn by this chart. See the
 
26
              below example:
 
27
              
 
28
@example
 
29
              d = [[5,10], [7,22], [8,25]]
 
30
              p = bar_plot.T(data = d, bcol = 1, hcol = 2)
 
31
@end example
 
32
 
 
33
              Here, three bars will be drawn. The X values of the bars
 
34
              will be 5, 7, and 8. The Y values of the bars will be
 
35
              10, 22, and 25, respectively. (In practice, because
 
36
              the values of bcol and hcol defaults to 1 and 2, you can
 
37
              write the above example just as "p = bar_plot.T(data = d)".
 
38
              ".
 
39
qerror_minus_col(type:int) default="The depth of the "quartile" errorbar is extracted from 
 
40
                  this column in data. This attribute is meaningful only
 
41
                  when error_bar != None. ".
 
42
_abs_data(type:list) default="Used only internally.".
 
43
label(type:str) default="The label to be displayed in the legend. <<legend>>, <<font>>".
 
44
cluster(type:tuple) default="This attribute is used to
 
45
    cluster multiple bar plots side by side in a single chart.
 
46
    The value should be a tuple of two integers. The second value should be equal to the total number of bar plots in the chart. The first value should be the relative position of this chart; 0 places this chart the leftmost, and N-1
 
47
    (where N is the 2nd value of this attribute) places this chart the rightmost. Consider the below example:
 
48
 
 
49
@example
 
50
    a = area.T(...)
 
51
    p1 = bar_plot.T(data = [[1,20][2,30]], cluster=(0,2))
 
52
    p2 = bar_plot.T(data = [[1,25],[2,10]], cluster=(1,2))
 
53
    a.add_plot(p1, p2)
 
54
    a.draw()
 
55
@end example
 
56
 
 
57
    In this example, one group of bars will be drawn side-by-side at
 
58
    position x=1, one with height 20, the other with height 25. The
 
59
    other two bars will be drawn side by side at position x=2, one
 
60
    with height 30 and the other with height 10.
 
61
    ".
 
62
hcol(type:int) default="The column from which the height of each bar is extracted.
 
63
             See also the description of the 'bcol' attribute.".
 
64
stack_on(type:any) default="The value must be either None or bar_plot.T. If not None, bars of this plot are stacked on top of another bar plot.".
 
65
qerror_plus_col(type:int) default="The depth of the "quartile" errorbar is extracted from 
 
66
                  this column in data. This attribute is meaningful only
 
67
                  when error_bar != None.".
 
68
data_label_offset(type:(x,y)) default="The location of data labels relative to the sample point. See also attribute data_label_format.".
 
69
fill_style(type:fill_style.T) default="Defines the fill style of each box.".
 
70
    The style is picked from standard styles round-robin.
 
71
    
 
72
data(type:any) default="Specifies the data points. <<chart_data>>".
 
73
line_style(type:line_style.T) default="The style of the outer frame of each box.".
 
74
legend_fill_style(type:fill_style.T) default="The fill style used to draw a legend entry. Usually, the value is None, meaning that the value of "fill_style" attribute is used.".
 
75
error_minus_col(type:int) default="Specifies the column from which the depth of the errorbar is extracted.  This attribute is meaningful only when
 
76
                  error_bar != None.
 
77
                  ".
 
78
"""
 
79