Excel::Template::Element::Image - Excel::Template::Element::Image

Excel-Template documentation Contained in the Excel-Template distribution.

Index

Code Index:

NAME

Top

Excel::Template::Element::Image - Excel::Template::Element::Image

PURPOSE

Top

To insert an image into the worksheet

NODE NAME

Top

IMAGE

INHERITANCE

Top

ELEMENT

EFFECTS

Top

This will consume one column in the current row.

DEPENDENCIES

Top

None

USAGE

Top

  <image path="/Some/Full/Path" />
  <image path="/Some/Full/Path" offset="2,5" />
  <image path="/Some/Full/Path" scale="2,0.4" />
  <image path="/Some/Full/Path" offset="4,0" scale="0,2" />

Please see Spreadsheet::WriteExcel/ for more information about the offset and scaling options as well as any other restrictions that might be in place. This node does NOT perform any sort of validation upon your parameters. You are assumed to know what you are doing.

Note that the offset and scaling values are "X,Y". You must provide both values, even if the Y value is 0. If you provide a 0 value for either scaling option, Spreadsheet::WriteExcel/ will default that to 1.

AUTHOR

Top

Rob Kinyon (rob.kinyon@gmail.com)

SEE ALSO

Top

Nothing

Excel-Template documentation Contained in the Excel-Template distribution. 
package Excel::Template::Element::Image;

use strict;

BEGIN {
    use vars qw(@ISA);
    @ISA = qw(Excel::Template::Element);

    use Excel::Template::Element;
}

sub render {
    my $self = shift;
    my ($context) = @_;

    my ($row, $col, $path, $offset, $scale) = map {
        $context->get($self, $_)
    } qw( ROW COL PATH OFFSET SCALE );

    my @offsets = (0,0);
    if ( $offset =~ /^\s*([\d.]+)\s*,\s*([\d.]+)/ ) {
        @offsets = ($1,$2);
    }

    my @scales = (0,0);
    if ( $scale =~ /^\s*([\d.]+)\s*,\s*([\d.]+)/ ) {
        @scales = ($1,$2);
    }

    $context->active_worksheet->insert_bitmap(
        $row, $col, $path, @offsets, @scales,
    );

    return 1;
}

sub deltas {
    return {
        COL => +1,
    };
}

1;
__END__