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

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2000-2005 by Yasushi Saito (yasushi.saito@gmail.com)
   4 #
   5 # Jockey is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by the
   7 # Free Software Foundation; either version 2, or (at your option) any
   8 # later version.
   9 #
  10 # Jockey is distributed in the hope that it will be useful, but WITHOUT
  11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13 # for more details.
  14 #
  15 doc="""Attributes supported by this class are:
  16 tic_label_offset(type:(x,y)):
  17     The location where the tick labels is drawn. Relative to the
  18     tip of the tick mark.
  19     default value=(0, 0).
  20 format(type:printf format string):
  21     The format string for tick labels. It can be a `printf' style
  22     format string, or a single-parameter function that returns a
  23     string. See also font.
  24     default value=%s.
  25 minor_tic_len(type:number):
  26     The length of minor tick marks.
  27     default value=3.
  28 label_offset(type:(x,y) or None):
  29     The location where the axis label is drawn. Relative to the
  30     left-bottom corner of the axis.
  31     default value=(None, None).
  32 grid_interval(type:Number or function):
  33     When the value is a number, it specifies the interval with which
  34     grid lines are drawn. Otherwise, the value must be a function.
  35     It must take no argument and return the list of numbers, which
  36     specifies the X or Y points where grid lines are drawn.
  37     default value=None.
  38 label(type:str):
  39     The description of the axis. See also font.
  40     default value=axis label.
  41 grid_style(type:line_style.T):
  42     The style of grid lines.
  43     default value=None.
  44 tic_interval(type:Number or function):
  45     When the value is a number, it specifies the interval with which
  46     tick marks are drawn. Otherwise, the value must be a function.
  47     It must take no argument and return the list of numbers, which
  48     specifies the X or Y points where tick marks are drawn.
  49     default value=None.
  50 line_style(type:line_style.T):
  51     The style of tick lines.
  52     default value=default.
  53 tic_len(type:number):
  54     The length of tick lines
  55     default value=6.
  56 minor_tic_interval(type:Number or function):
  57     When the value is a number, it specifies the interval with which
  58     minor tick marks are drawn. Otherwise, the value must be a function.
  59     It must take no argument and return the list of numbers, which
  60     specifies the X or Y points where minor tick marks are drawn.
  61     default value=None.
  62 first_tic_value(type:number):
  63     The location of the first tick mark. Defaults to the x_range[0]
  64     (or y_range[0]) of the area.
  65     default value=None.
  66 """