openerp/pychart/axis_doc.py

   1 # -*- coding: utf-8 -*-
   2 # automatically generated by generate_docs.py.
   3 doc_x="""Attributes supported by this class are:
   4 draw_tics_above(type:int) default="If true, tick lines and labels are drawn above the axis line.".
   5 minor_tic_len(type:length in points (\\xref{unit})) default="The length of minor tick marks.  The value can be negative, in which case the tick lines are drawn right of (or above) the axis.".
   6 tic_label_offset(type:(x,y)) default="The location for drawing tick labels,
   7                             relative to the tip of the tick line.".
   8 format(type:printf format string) default="The format string for tick labels.
   9                   It can be a `printf' style format string, or
  10                   a single-parameter function that takes an X (or Y) value
  11                   and returns a string. The appearance of the string produced here can be
  12 controlled using escape sequences. <<font>>".
  13 label_offset(type:(x,y) or None) default="The location for drawing the axis label,
  14                         relative to the middle point of the axis.
  15                         If the value is None, the label is displayed
  16                         below (or to the left of) of axis at the middle.".
  17 label(type:str) default="The descriptive string displayed below (or to the left of) the axis. <<font>>.".
  18 offset(type:length in points (\\xref{unit})) default="The location of the axis.
  19                   The value of 0 draws the
  20                   axis at the left (for the Y axis) or bottom (for the X axis)
  21                   edge of the drawing area.
  22                   ".
  23 tic_interval(type:Number or function) default="When the value is a number, it specifies the interval at which tick marks are drawn. Otherwise, the value must be a function that takes no argument and returns the list of numbers. The return value specifies the X or Y points at which tick marks are drawn.".
  24 line_style(type:line_style.T) default="Specifies the style of axis and tick lines.".
  25 tic_len(type:length in points (\\xref{unit})) default="The length of tick lines. The value can be negative, in which case the tick lines are drawn right of (or above) the axis.".
  26 minor_tic_interval(type:Number or function) default="When the value is a number, it specifies the interval at which minor tick marks are drawn. Otherwise, the value must be a function that takes no argument and returns the list of numbers. The return value specifies the X or Y points at which minor tick marks are drawn.".
  27 """
  28
  29 doc_y="""Attributes supported by this class are:
  30 draw_tics_right(type:int) default="If true, tick lines and labels are drawn right of the axis line.".
  31 minor_tic_len(type:length in points (\\xref{unit})) default="The length of minor tick marks.  The value can be negative, in which case the tick lines are drawn right of (or above) the axis.".
  32 tic_label_offset(type:(x,y)) default="The location for drawing tick labels,
  33                             relative to the tip of the tick line.".
  34 format(type:printf format string) default="The format string for tick labels.
  35                   It can be a `printf' style format string, or
  36                   a single-parameter function that takes an X (or Y) value
  37                   and returns a string. The appearance of the string produced here can be
  38 controlled using escape sequences. <<font>>".
  39 label_offset(type:(x,y) or None) default="The location for drawing the axis label,
  40                         relative to the middle point of the axis.
  41                         If the value is None, the label is displayed
  42                         below (or to the left of) of axis at the middle.".
  43 label(type:str) default="The descriptive string displayed below (or to the left of) the axis. <<font>>.".
  44 offset(type:length in points (\\xref{unit})) default="The location of the axis.
  45                   The value of 0 draws the
  46                   axis at the left (for the Y axis) or bottom (for the X axis)
  47                   edge of the drawing area.
  48                   ".
  49 tic_interval(type:Number or function) default="When the value is a number, it specifies the interval at which tick marks are drawn. Otherwise, the value must be a function that takes no argument and returns the list of numbers. The return value specifies the X or Y points at which tick marks are drawn.".
  50 line_style(type:line_style.T) default="Specifies the style of axis and tick lines.".
  51 tic_len(type:length in points (\\xref{unit})) default="The length of tick lines. The value can be negative, in which case the tick lines are drawn right of (or above) the axis.".
  52 minor_tic_interval(type:Number or function) default="When the value is a number, it specifies the interval at which minor tick marks are drawn. Otherwise, the value must be a function that takes no argument and returns the list of numbers. The return value specifies the X or Y points at which minor tick marks are drawn.".
  53 """
  54