The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Graphics-Grid-0.0000_02
River stage zero No dependents
1 ++
/ Graphics::Grid::Grob::Lines

NAME

Graphics::Grid::Grob::Lines - Lines grob

VERSION

version 0.0000_02

SYNOPSIS

    use Graphics::Grid::Grob::Lines;
    my $lines = Graphics::Grid::Grob::Lines->new(
            x => [ 0, 0.5, 1, 0.5 ],
            y => [ 0.5, 1, 0.5, 0 ],
            gp => Graphics::Grid::GPar->new()
    );

    # or use the function interface
    use Graphics::Grid::Functions qw(:all);
    my $lines = lines_grob(%params);

DESCRIPTION

This class represents a "lines" graphical object. It is a subclass of Graphics::Grid::Grob::Polyline. The difference is that this class assumes all points are for the same line.

ATTRIBUTES

x

A Grahpics::Grid::Unit object specifying x-values.

Default to unit([0, 1], "npc").

y

A Grahpics::Grid::Unit object specifying y-values.

Default to unit([0, 1], "npc").

x and y combines to define the points in the lines. x and y shall have same length. For example, the default values of x and y defines a line from point (0, 0) to (1, 1). If they have less than two elements, it is surely not enough to make a line and nothing would be drawn.

gp

An object of Graphics::Grid::GPar. Default is an empty gpar object.

vp

A viewport object. When drawing a grob, if the grob has this attribute, the viewport would be temporily pushed onto the global viewport stack before drawing takes place, and be poped after drawing. If the grob does not have this attribute set, it would be drawn on the existing current viewport in the global viewport stack.

elems

Get number of sub-elements in the grob.

Grob classes shall implement a _build_elems() method to support this attribute.

For this module elems always returns 1.

SEE ALSO

Graphics::Grid::Functions

Graphics::Grid::Grob

Graphics::Grid::Grob::Polyline

AUTHOR

Stephan Loyd <sloyd@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Stephan Loyd.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.