Name

Svg::Simple - SVG overlay to facilitate writing SVG documents using Perl

Synopsis

Svg::Simple makes it easy to write svg using Perl syntax as in:

  my $s = Svg::Simple::new();

  $s->text(x=>10, y=>10, z_index=>1,
    cdata             =>"Hello World",
    text_anchor       =>"middle",
    alignment_baseline=>"middle",
    font_size         => 4,
    font_family       =>"Arial",
    fill              =>"black");

  $s->circle(cx=>10, cy=>10, r=>8, stroke=>"blue", fill=>"transparent", opacity=>0.5);
  say STDERR $s->print;

A - in an svg keyword can be replaced with _ to reduce line noise.

The print method automatically creates an svg to wrap around all the svg statements specified. The image so created will fill all of the available space in the browser if the image is shown by itself, else it will fill all of the available space in the parent tag containing the svg statements if the svg is inlined in html.

This package automatically tracks the dimensions of the objects specified in the svg statements and creates a viewport wide enough and high enough to display them fully in whatever space the browser allocates to the image. If you wish to set these dimensions yourself, call the print method as follows:

  say STDERR $s->print(width=>2000, height=>1000);

If you wish to inline the generated html you should remove the first two lines of the generated code using a regular expression to remove the superfluous xml headers.

Description

SVG overlay to facilitate writing SVG documents using Perl

Version 20231021.

The following sections describe the methods in each functional area of this module. For an alphabetic listing of all methods by name see Index.

Constructors

Construct and print a new SVG object.

new()

Create a new SVG object.

Example:

    my $s = Svg::Simple::new();  # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲


    $s->text(x=>10, y=>10, z_index=>1,
      cdata             =>"Hello World",
      text_anchor       =>"middle",
      alignment_baseline=>"middle",
      font_size         => 4,
      font_family       =>"Arial",
      fill              =>"black");

    $s->circle(cx=>10, cy=>10, r=>8, stroke=>"blue", fill=>"transparent", opacity=>0.5);
    owf fpe(qw(svg test svg)), $s->print;
    ok $s->print =~ m(circle)

print($svg, %options)

Print resulting svg string

     Parameter  Description
  1  $svg       Svg
  2  %options   Svg options

Example:

    my $s = Svg::Simple::new();

    $s->text(x=>10, y=>10, z_index=>1,
      cdata             =>"Hello World",
      text_anchor       =>"middle",
      alignment_baseline=>"middle",
      font_size         => 4,
      font_family       =>"Arial",
      fill              =>"black");

    $s->circle(cx=>10, cy=>10, r=>8, stroke=>"blue", fill=>"transparent", opacity=>0.5);

    owf fpe(qw(svg test svg)), $s->print;  # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲


    ok $s->print =~ m(circle)  # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲

Private Methods

AUTOLOAD($svg, %options)

SVG methods

     Parameter  Description
  1  $svg       Svg object
  2  %options   Options

Index

1 AUTOLOAD - SVG methods

2 new - Create a new SVG object.

3 print - Print resulting svg string

Installation

This module is written in 100% Pure Perl and, thus, it is easy to read, comprehend, use, modify and install via cpan:

  sudo cpan install Svg::Simple

Author

philiprbrenan@gmail.com

http://www.appaapps.com

Copyright

Copyright (c) 2016-2023 Philip R Brenan.

This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

cpanm Svg::Simple

perl -MCPAN -e shell
install Svg::Simple