.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Chart::Clicker::Data::Series::HighLow 3pm" .TH Chart::Clicker::Data::Series::HighLow 3pm "2022-10-14" "perl v5.34.0" "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::HighLow \- Series data with additional attributes for High\-Low charts .SH "VERSION" .IX Header "VERSION" version 2.90 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Chart::Clicker::Data::Series::HighLow; \& \& my @keys = (); \& my @values = (); \& my @highs = (); \& my @lows = (); \& my @opens = (); \& \& my $series = Chart::Clicker::Data::Series::HighLow\->new({ \& keys => \e@keys, \& values => \e@values, \& highs => \e@highs, \& lows => \e@lows, \& opens => \e@opens \& }); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Chart::Clicker::Data::Series::HighLow is an extension of the Series class that provides storage for a three new variables called for use with the CandleStick renderer. The general idea is: .PP .Vb 10 \& \-\-\- <\-\- High \& | \& | \& \- <\-\- max of Open, Value \& | | \& | | \& \- <\-\- min of Open, Value \& | \& | \& \-\-\- <\-\- Low .Ve .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "highs" .IX Subsection "highs" Set/Get the highs for this series. .SS "lows" .IX Subsection "lows" Set/Get the lows for this series. .SS "opens" .IX Subsection "opens" Set/Get the opens for this series. .SH "METHODS" .IX Header "METHODS" .SS "add_to_highs" .IX Subsection "add_to_highs" Adds a high to this series. .SS "get_high ($index)" .IX Subsection "get_high ($index)" Get a high by it's index. .SS "high_count" .IX Subsection "high_count" Gets the count of sizes in this series. .SS "add_to_lows" .IX Subsection "add_to_lows" Adds a high to this series. .SS "get_low ($index)" .IX Subsection "get_low ($index)" Get a low by it's index. .SS "low_count" .IX Subsection "low_count" Gets the count of lows in this series. .SS "add_to_opens" .IX Subsection "add_to_opens" Adds an open to this series. .SS "get_open" .IX Subsection "get_open" Get an open by it's index. .SS "open_count" .IX Subsection "open_count" Gets the count of opens in this series. .SH "AUTHOR" .IX Header "AUTHOR" Cory G Watson .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.