1 # -*- coding: utf-8 -*-
2 # automatically generated by generate_docs.py.
3 doc="""Attributes supported by this class are:
4 plots(type:list) default="Used only internally by pychart.".
5 loc(type:(x,y)) default="The location of the bottom-left corner of the chart.
7 @cindex location, chart
9 y_grid_style(type:line_style.T) default="The style of vertical grid lines.".
10 y_grid_interval(type:Number or function) default="The vertical grid-line interval. See also x_grid_interval".
11 x_grid_over_plot(type:int) default="If True, grid lines are drawn over plots. Otherwise, plots are drawn over grid lines.".
12 x_range(type:(x,y)) default="Specifies the range of X values that are displayed in the
13 chart. IF the value is None, both the values are computed
14 automatically from the samples. Otherwise, the value must be a
15 tuple of format (MIN, MAX). MIN and MAX must be either None or a
16 number. If None, the value is computed automatically from the
17 samples. For example, if x_range = (None,5), then the minimum X
18 value is computed automatically, but the maximum X value is fixed
20 y_coord(type:coord.T) default="Set the Y coordinate system.".
21 A linear coordinate system.
23 y_range(type:(x,y)) default="Specifies the range of Y values that are displayed in the
24 chart. IF the value is None, both the values are computed
25 automatically from the samples. Otherwise, the value must be a
26 tuple of format (MIN, MAX). MIN and MAX must be either None or a
27 number. If None, the value is computed automatically from the
28 samples. For example, if y_range = (None,5), then the minimum Y
29 value is computed automatically, but the maximum Y value is fixed
31 x_axis(type:axis.X) default="The X axis. <<axis>>.".
32 bg_style(type:fill_style.T) default="Background fill-pattern.".
33 x_coord(type:coord.T) default="Set the X coordinate system.".
34 A linear coordinate system.
36 legend(type:legend.T) default="The legend of the chart.".
37 a legend is by default displayed in the right-center of the
40 y_grid_over_plot(type:int) default="See x_grid_over_plot.".
41 x_axis2(type:axis.X) default="The second X axis. This axis should be non-None either when you want to display plots with two distinct domains or when
42 you just want to display two axes at the top and bottom of the chart.
44 y_axis2(type:axis.Y) default="The second Y axis. This axis should be non-None either when you want to display plots with two distinct ranges or when
45 you just want to display two axes at the left and right of the chart. <<axis>>".
46 x_grid_style(type:line_style.T) default="The style of horizontal grid lines.
48 y_axis(type:axis.Y) default="The Y axis. <<axis>>.".
49 border_line_style(type:line_style.T) default="Line style of the outer frame of the chart.".
50 x_grid_interval(type:Number or function) default="The horizontal grid-line interval.
52 specifies the interval at which
53 lines are drawn. If value is a function, it
54 takes two arguments, (MIN, MAX), that tells
55 the minimum and maximum values found in the
56 sample data. The function should return a list
57 of values at which lines are drawn.".
58 size(type:(x,y)) default="The size of the chart-drawing area, excluding axis labels,
59 legends, tick marks, etc.