git.inspyration.org Git - odoo/odoo.git/blob

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