view release on metacpan or  search on metacpan

lib/Chart/Manual/Properties.pod  view on Meta::CPAN

Sections are named after the Chart type in question, except B<All> and B<NoPie>.
The format is: name ... L<type|/"DATA TYPES">, description; C<default value>.

Click on name for a longer explanation.


=head2 All

Properties available in all chart types:

L<colors-background|/colors> ... L</color> of whole image background ; C<'white'>

L<colors-datasetx|/colors> ..... L</color> of points/lines/bars of dataset number x = 0..64

L<colors-grid_lines|/colors> ... L</color> of vertical and horizontal grid lines in the plot background; C<'black'>

L<colors-x_grid_lines|/colors> . L</color> of vertical grid lines; C<'black'>

L<colors-y_grid_lines|/colors> . L</color> of horizontal grid lines; C<'black'>

L<colors-text|/colors> ......... L</color> of all text ; C<'black'>

L<colors-title|/colors> ........ L</color> of text above the graph ; C<'black'>

L<colors-x_label|/colors> ...... L</color> of x-axis label text; C<'black'>

L<colors-y_label|/colors> ...... L</color> of y-axis (left side) label text; C<'black'>

L<colors-y_label2|/colors> .... L</color> of y-axis (right side) label text; C<'black'>

L<colors-misc|/colors> ....... L</color> of boxes, ticks, axis and alike; C<'black'>

L</f_x_tick> ................ L</code> that transforms "would have" into actual tick label on left x-axis; C<undef>

L</f_y_tick> ............... L</code> that transforms "would have" into actual tick label on right y-axis; C<undef>

L</graph_border> .......... space between graph and title + legend in pixel; C<10>

L</grey_background> ...... L<bool|/boolean>: sets plot background to grey; C<'true'>

L</imagemap> ............ L<bool|/boolean>: enable imagemap_dump(); C<'false'>

L</label_font> .......... L</font> of axis labels; GD::Font->MediumBold

L</legend> .............. qw[left right top bottom none]: placement of the legend; C<'right'>

L</legend_font> ......... L</font> of the text in the legend; GD::Font->Small.

L</legend_labels> ....... (array ref): labels of colors in legend; C<undef>

L</png_border> .......... L<pos_int|/"positive integer">: space between graph parts and image edge in pixel; C<10>

L</sub_title> ........... L</string>: text below the L</title> in smaller letters; C<''>

L</text_space> .......... L<pos_int|/"positive integer">: extra space around any text; C<2>

L</title> ............... L</string>: text on top of a chart; C<''>

L</title_font> .......... L</font> of the title text; GD::Font->Large

L</transparent> ......... L<bool|/boolean>: full image background transparency; C<'false'>

L</x_label> ............. L</string>: x-axis label text; C<''>

L</y_label> ............. L</string>:label on the standard, left y-axis; C<''>

L</y_label2> ............ L</string>:label on right y-axis, if different; C<''>


=head2 NoPie

Properties available in all chart types of kinda xy-plot, not L</Pie>:

L</custom_x_ticks> ..... (array ref): [0,3,4] displays  0th, 3rd, and 4th x-tick; C<undef>

L</grid_lines> ......... L<bool|/boolean>: draw vertical and horizontal grid lines; C<'false'>

L</include_zero> ....... L<bool|/boolean>: forces y-axis to include zero; C<'false'>

L</integer_ticks_only> . L<bool|/boolean>: draw x-axis ticks with label only on whole values; C<'false'>

L</max_val> ............ L<pos_int|/"positive integer">: maximum value on y-axis; C<undef>

L</max_x_ticks> ........ L<pos_int|/"positive integer">: maximum of ticks and labels to draw on x-axis; C<100>

L</max_y_ticks> ........ L<pos_int|/"positive integer">: maximum of ticks and labels to draw on y-axis; C<100>

L</min_val> ............ L<pos_int|/"positive integer">: maximum value on y-axis; C<undef>

L</min_x_ticks> ........ L<pos_int|/"positive integer">: minimum of ticks and labels to draw on x-axis; C<6> (min 2)

L</min_y_ticks> ........ L<pos_int|/"positive integer">: minimum of ticks and labels to draw on y-axis; C<6> (min 2)

L</precision> .......... L<pos_int|/"positive integer">: nr. of numerals after the decimal point in axis labels; C<3>

L</skip_int_ticks> ..... L<pos_int|/"positive integer">: draw only n'th tick on whole x-value; C<1> (if L</integer_ticks_only>)

L</skip_x_ticks> ....... L<pos_int|/"positive integer">: draw only every n'th tick with label; C<1>

L</sort> ............... L<bool|/boolean>: sort data in ascending order; C<'false'>

L</tick_label_font> .... L</font> of tick labels;  GD::Font->Small

L</tick_len> ........... L<pos_int|/"positive integer">: length of the x- and y-ticks in pixels; C<4>

L</x_grid_lines> ....... L<bool|/boolean>: vertical grid lines matching x ticks; C<'false'>

L</x_ticks> ............ qw[normal staggered vertical]: style of x-axis labels; C<'normal'>

L</xy_plot> ............ L<bool|/boolean>: forces x-y-graph, with numeric x-axis; C<'false'>

L</y_axes> ............. (C<'left'>, C<'right'>, C<'both'>): position of y-axis;C<'left'>

L</y_grid_lines> ....... L<bool|/boolean>: horizontal grid lines matching y ticks; C<'false'>


=head2 Bars

This includes Bars StackedBars and HorizontalBars.

L</spaced_bars> ........ L<bool|/boolean>: leave space between the groups of bars; C<'true'>

lib/Chart/Manual/Properties.pod  view on Meta::CPAN

=head2 skip_x_ticks

Sets the number of x-ticks and x-tick labels to skip.  (ie.  
if 'skip_x_ticks' was set to 4, Chart would draw every 4th x-tick
and x-tick label).  Default is C<undef>.

=head2 skip_y_ticks

L</HorizontalBars> only: Draw only every n'th tick with label on y-axis.
does for other charts. Defaults to C<1> (draw all).

=head2 sort

In a xy-plot, the data will be sorted ascending if set to C<'true'>.
(Should be set if the data isn't sorted, especially in Lines, Split 
and LinesPoints) In a Pareto Chart the data will be sorted descending. 
Defaults to C<'false'>.

=head2 spaced_bars

L</Bars> only: Leaves space between the groups of bars at each data point
when set to C<'true'>.  This just makes it easier to read a bar chart. 
Default is C<'true'>.

=head2 start

L</Split> only: Sets the start value of the first interval.
If the x coordinate of the first data point is zero, you should 'set' to
zero. Default is C<'undef'>.

=head2 sub_title

Write a sub-title under the L</title> in smaller letters. 
Default is empty.

=head2 text_space

Sets the amount of space left on the sides (lext and right) of text,
(title, legend, label) to make it more readable.  Defaults to C<2>.

=head2 tick_label_font

This is the font for the tick labels. It also needs 
a GD font object as an argument. Default is GD::Font->Small.

=head2 tick_len

Sets the length of the x- and y-ticks in pixels.  Default is C<4>. 

=head2 title

Content of title text. If empty, no title is drawn.  
It recognizes '\n' as a newline, and acts accordingly.
Remember, if you want to use normal quotation marks instead of single 
quotation marks then you have to quote "\\n". Default is empty.

=head2 title_font

This option changes the L</font> of the title. Default is GD::Font->Large.

=head2 transparent

Makes the background of the whole image transparent if set to C<'true'>.  
Useful for making web page images.  Default is C<'false'>.

=head2 x_grid_lines

Draws vertical grid lines matching up to x ticks if set to C<'true'>.
Default is C<'false'>.

=head2 x_label

Tells Chart what to use for the x-axis label.  If empty, no label
is drawn.  Default is empty.

=head2 x_ticks

Specifies how to draw the x-tick labels.  Valid values are 1: C<'normal'>,
2: C<'staggered'> (alternating on upper and lower row - for very long labels),
and 3: C<'vertical'> (the labels are draw upwards in right angle).
Default is C<'normal'>.

=head2 xy_plot

Forces Chart to plot a x-y-graph, which means, that the x-axis is also
numeric if set to C<'true'>. Very useful for mathematical graphs.
Works for Lines, Points, LinesPoints and ErrorBars. Split makes always a 
xy_plot. Defaults to C<'false'>.

=head2 y_label

Tells Chart what to use for labels on the standard, left y-axis.
If empty, no label is drawn.  Default is empty (C<''>).

=head2 y_label2

Text of the label on the second, right y-axis (if different from left).
If empty, no label is drawn.  Default is empty (C<''>).

=head2 y_axes

Tells Chart where to place the y-axis. Has no effect on Composite and Pie.
Valid values are C<'left'>, C<'right'> and C<'both'>. Defaults to C<'left'>.

=head2 y_grid_lines

Draws horizontal grid lines matching up to y ticks if set to C<'true'>. 
Default is C<'false'>.

=head2 y_ticks1

L<Composite> only: number of y ticks to use on the first and 
second y-axis (y_ticks2).  Please note that if you just set the 'y_ticks'
option, both axes will use that number of y ticks. Both default to undef.

=head2 y_ticks2

see L</y_ticks1>

=head1 COPYRIGHT & LICENSE

Copyright 2022 David Bonner, Herbert Breunung.