.\" 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::Range 3pm" .TH Chart::Clicker::Data::Range 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::Range \- A range of Data .SH "VERSION" .IX Header "VERSION" version 2.90 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Chart::Clicker::Data::Range; \& \& my $range = Chart::Clicker::Data::Range\->new({ \& lower => 1, \& upper => 10 \& }); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Chart::Clicker::Data::Range implements a range of values. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "lower" .IX Subsection "lower" Set/Get the lower bound for this Range .SS "max" .IX Subsection "max" Set/Get the maximum value allowed for this Range. This value should only be set if you want to \s-1EXPLICITLY\s0 set the upper value. .SS "min" .IX Subsection "min" Set/Get the minimum value allowed for this Range. This value should only be set if you want to \s-1EXPLICITLY\s0 set the lower value. .SS "upper" .IX Subsection "upper" Set/Get the upper bound for this Range .SS "ticks" .IX Subsection "ticks" The number of ticks to be displayed for this range. .SH "METHODS" .IX Header "METHODS" .SS "add" .IX Subsection "add" Adds the specified range to this one. The lower is reduced to that of the provided one if it is lower, and the upper is \s-1ADDED\s0 to this range's upper. .SS "combine" .IX Subsection "combine" Combine this range with the specified so that this range encompasses the values specified. For example, adding a range with an upper-lower of 1\-10 with one of 5\-20 will result in a combined range of 1\-20. .SS "contains ($value)" .IX Subsection "contains ($value)" Returns true if supplied value falls within this range (inclusive). Otherwise returns false. .SS "span" .IX Subsection "span" Returns the span of this range, or \s-1UPPER \- LOWER.\s0 .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.