File Coverage

blib/lib/Geo/Leaflet/Circle.pm

Criterion	Covered	Total	%
statement	25	25	100.0
branch	6	12	50.0
condition			n/a
subroutine	8	8	100.0
pod	4	4	100.0
total	43	49	87.7

package Geo::Leaflet::Circle;
use strict;
use warnings;
use base qw{Geo::Leaflet::Objects};

our $VERSION = '0.04';
our $PACKAGE = __PACKAGE__;

=head1 NAME

Geo::Leaflet::Circle - Leaflet circle object

=head1 SYNOPSIS

  use Geo::Leaflet;
  my $map    = Geo::Leaflet->new;
  my $circle = $map->circle(
                            lat     => $lat,
                            lon     => $lon,
                            radius  => $radius,
                            options => {},
                           );

=head1 DESCRIPTION

This package constructs a Leaflet circle object for use on a L map.

=head1 PROPERTIES

=head2 lat

=cut

sub lat {
  my $self       = shift;
  $self->{'lat'} = shift if @_;
  die("Error: lat required") unless defined $self->{'lat'};
  return $self->{'lat'};
}

=head2 lon

=cut

sub lon {
  my $self       = shift;
  $self->{'lon'} = shift if @_;
  die("Error: lon required") unless defined $self->{'lon'};
  return $self->{'lon'};
}

=head2 radius

=cut

sub radius {
  my $self          = shift;
  $self->{'radius'} = shift if @_;
  return $self->{'radius'};
}

=head2 options

=head1 METHODS

=head2 stringify

=cut

sub _method_name {'circle'};

sub stringify {
  my $self             = shift;
  my $options          = $self->options;
  $options->{'radius'} = $self->radius if defined $self->radius; #radius is set in options
  return $self->stringify_base([$self->lat, $self->lon]);
}

=head1 SEE ALSO

=head1 AUTHOR

Michael R. Davis

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2024 by Michael R. Davis

MIT LICENSE

=cut

1;