NAME
Term::Colormap - Colormaps for ANSI 256 Color Terminals!
VERSION
Version 0.13
SYNOPSIS
Provide colormaps and functions to simplify rendering colored text using ANSI 256 colors.
use Term::Colormap qw( colormap colorbar print_colored );
my $rainbow = colormap('rainbow');
colorbar($rainbow);
print_colored( $rainbow->[3], "orange" )';EXPORT
colorbar
colormap
color2rgb
print_colored
print_colored_text
color_table
add_mappingSUBROUTINES/METHODS
colorbar
Print a colorbar for a colormap.
my $rainbow = colormap('rainbow');
colorbar($rainbow); # Prints horizontal colorbar, 2 characters wide per color
colorbar($rainbow, 3); # Prints horizontal colorbar, 3 characters wide per color
colorbar($rainbow, 10, 'v'); # Prints vertical colorbar, 10 characters wide per colorcolormap
A colormap is an ordered set of color values (0-255).
Returns a colormap as an Array Reference.
See AVAILABLE COLORMAPS for colormap names.
my $rainbow = colormap('rainbow');
my $ash = colormap('ash');color2rgb
Returns rgb value for a color value.
my $rgb = color2rgb( 255 ); #eeeeee Very Light Grayrgb2color
Returns color value for an rgb color
my $color = rgb2color( 'eeeeee' ); 255 Very Light Grayprint_colored
Print text using a background color.
my $rainbow = colormap('rainbow');
print_colored( $rainbow->[3], "Text with orange background" );print_colored_text
Print colored text.
my $rainbow = colormap('rainbow');
print_colored_text( $rainbow->[3], "Orange Text" );color_table
Print color table (color, number, rgb) for a colormap.
my $rainbow = colormap('rainbow');
color_table($rainbow);add_mapping
Add custom colormaps to the list of available colormaps.
add_mapping('my_colors', [ 1, 3, 5, 7, 9 ])
color_table('my_colors');AVAILABLE COLORMAPS
rainbow - 32 colors : Red -> Orange -> Yellow -> Green -> Cyan -> Blue -> Magenta
primary - 8 colors : Black, Red, Green, Yellow, Blue, Magenta, Cyan, Off-White
bright - 8 colors : Gray, Bright Red, Bright Green, Bright Yellow,
Bright Blue, Bright Magenta, Bright Cyan, White
ash - 12 colors : Black -> Gray
snow - 12 colors : Gray -> White
gray - 24 colors : Black -> Gray -> White
blue-cyan-green - 19 colors : Blue -> Cyan -> Green
red-pink-yellow - 16 colors : Red -> Pink -> Yellow
green-orange-pink-blue - 16 colors : Green -> Orange -> Pink -> BlueAUTHOR
Felix Tubiana, <felixtubiana at gmail.com>
BUGS
Please report any bugs or feature requests to bug-term-colormap at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Term-Colormap. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Term::ColormapYou can also look for information at:
RT: CPAN's request tracker (report bugs here)
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
ACKNOWLEDGEMENTS
Inspired by Term::ANSIColor
LICENSE AND COPYRIGHT
Copyright 2014 Felix Tubiana.
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.