.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Chart::Clicker::Data::Series 3pm"
.TH Chart::Clicker::Data::Series 3pm "2016-12-28" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Chart::Clicker::Data::Series \- A series of key, value pairs representing chart data
.SH "VERSION"
.IX Header "VERSION"
version 2.90
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Chart::Clicker::Data::Series;
\&
\&  my @keys = (1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
\&  my @values = (42, 25, 86, 23, 2, 19, 103, 12, 54, 9);
\&
\&  my $series = Chart::Clicker::Data::Series\->new({
\&    keys    => \e@keys,
\&    value   => \e@values
\&  });
\&
\&  # Alternately, if you prefer
\&
\&  my $series2 = Chart::Clicker::Data::Series\->new({
\&    1  => 42,
\&    2  => 25,
\&    3  => 85,
\&    4  => 23,
\&    5  => 2,
\&    6  => 19,
\&    7  => 102,
\&    8  => 12,
\&    9  => 54,
\&    10 => 9
\&  });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Chart::Clicker::Data::Series represents a series of values to be charted.
.PP
Despite the name (keys and values) it is expected that all keys and values
will be numeric.  Values is pretty obvious, but it is important that keys
also be numeric, as otherwise we'd have no idea how to order the data.
.PP
If you want to use text labels for your domain's see Chart::Clicker::Axis's
tick_labels method.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "keys"
.IX Subsection "keys"
Set/Get the keys for this series.
.SS "add_to_keys"
.IX Subsection "add_to_keys"
Adds a key to this series.
.SS "name"
.IX Subsection "name"
Set/Get the name for this Series
.SS "range"
.IX Subsection "range"
Returns the range for this series.
.SS "values"
.IX Subsection "values"
Set/Get the values for this series.
.SH "METHODS"
.IX Header "METHODS"
.SS "key_count"
.IX Subsection "key_count"
Get the count of keys in this series.
.SS "add_to_values"
.IX Subsection "add_to_values"
Add a value to this series.
.SS "value_count"
.IX Subsection "value_count"
Get the count of values in this series.
.ie n .SS "add_pair ($key, $value)"
.el .SS "add_pair ($key, \f(CW$value\fP)"
.IX Subsection "add_pair ($key, $value)"
Convenience method to add a single key and a single value to the series.
.SS "get_value_for_key ($key)"
.IX Subsection "get_value_for_key ($key)"
Returns the value associated with the specified key.  This is necessary
because not all series will have values for every key.
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory G Watson <gphat@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Cory G Watson.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.