summaryrefslogtreecommitdiff
path: root/bin/pychart/axis_doc.py
diff options
context:
space:
mode:
Diffstat (limited to 'bin/pychart/axis_doc.py')
-rw-r--r--bin/pychart/axis_doc.py53
1 files changed, 53 insertions, 0 deletions
diff --git a/bin/pychart/axis_doc.py b/bin/pychart/axis_doc.py
new file mode 100644
index 00000000000..48184d405a5
--- /dev/null
+++ b/bin/pychart/axis_doc.py
@@ -0,0 +1,53 @@
+# automatically generated by generate_docs.py.
+doc_x="""Attributes supported by this class are:
+draw_tics_above(type:int) default="If true, tick lines and labels are drawn above the axis line.".
+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.".
+tic_label_offset(type:(x,y)) default="The location for drawing tick labels,
+ relative to the tip of the tick line.".
+format(type:printf format string) default="The format string for tick labels.
+ It can be a `printf' style format string, or
+ a single-parameter function that takes an X (or Y) value
+ and returns a string. The appearance of the string produced here can be
+controlled using escape sequences. <<font>>".
+label_offset(type:(x,y) or None) default="The location for drawing the axis label,
+ relative to the middle point of the axis.
+ If the value is None, the label is displayed
+ below (or to the left of) of axis at the middle.".
+label(type:str) default="The descriptive string displayed below (or to the left of) the axis. <<font>>.".
+offset(type:length in points (\\xref{unit})) default="The location of the axis.
+ The value of 0 draws the
+ axis at the left (for the Y axis) or bottom (for the X axis)
+ edge of the drawing area.
+ ".
+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.".
+line_style(type:line_style.T) default="Specifies the style of axis and tick lines.".
+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.".
+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.".
+"""
+
+doc_y="""Attributes supported by this class are:
+draw_tics_right(type:int) default="If true, tick lines and labels are drawn right of the axis line.".
+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.".
+tic_label_offset(type:(x,y)) default="The location for drawing tick labels,
+ relative to the tip of the tick line.".
+format(type:printf format string) default="The format string for tick labels.
+ It can be a `printf' style format string, or
+ a single-parameter function that takes an X (or Y) value
+ and returns a string. The appearance of the string produced here can be
+controlled using escape sequences. <<font>>".
+label_offset(type:(x,y) or None) default="The location for drawing the axis label,
+ relative to the middle point of the axis.
+ If the value is None, the label is displayed
+ below (or to the left of) of axis at the middle.".
+label(type:str) default="The descriptive string displayed below (or to the left of) the axis. <<font>>.".
+offset(type:length in points (\\xref{unit})) default="The location of the axis.
+ The value of 0 draws the
+ axis at the left (for the Y axis) or bottom (for the X axis)
+ edge of the drawing area.
+ ".
+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.".
+line_style(type:line_style.T) default="Specifies the style of axis and tick lines.".
+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.".
+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.".
+"""
+