bin/pychart/axis_x_doc.py

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