/ 
Spreadsheet-HTML-1.22
River stage one • 1 direct dependent • 1 total dependent
/ Spreadsheet::HTML::Presets::Scroll

NAME

Spreadsheet::HTML::Presets::Scroll - Generate scrolling HTML table cells and backgrounds.

DESCRIPTION

This is a container for Spreadsheet::HTML preset methods. These methods are not meant to be called from this package. Instead, use the Spreadsheet::HTML interface:

use Spreadsheet::HTML;
my $generator = Spreadsheet::HTML->new( data => \@data );
print $generator->scroll;

# or
use Spreadsheet::HTML qw( scroll );
print scroll( data => \@data );

METHODS

  • scroll( fgdirection, bgdirection, interval, jquery, %params )

    Moves the contents (fgdirection for CDATA, bgdirection for attributes) of each cell in the direction specified. Valid values are up, down, left and right, or you can optionally use fx and/or fy instead of fgdirection to specify which axis(es) to scroll, as well as bx and by instead of bgdirection.

    scroll( fgdirection => 'left' )

# same as
scroll( fx => -1 )

# produce diagonal (left and up)
scroll( fx => -1, fy => -1 )

    Set the timer with interval (defaults to 200 miliseconds).

    scroll( fgdirection => 'right', interval => 500 )

    Uses Google's jQuery API unless you specify another URI via the jquery param. Javascript will be minified via Javascript::Minifier if it is installed.

    Virtually all other Spreadsheet::HTML generating methods/procedures also can additionally specify scroll et. al. as a literal parameters:

    print $generator->landscape( scroll => 1, by => -1, bx => 1 )

SEE ALSO

Spreadsheet::HTML

The interface for this functionality.

Spreadsheet::HTML::Presets

More presets.

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2024 Jeff Anderson.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.