NAME

Chart::OFC2::Axis - OFC2 axis base module

SYNOPSIS

use Chart::OFC2::Axis;
my $x_axis = Chart::OFC2::XAxis->new(
    'labels' => [ 'Jan', 'Feb', 'Mar', 'Apr', 'May' ],
),

DESCRIPTION

X or Y axis for OFC2.

PROPERTIES

subtype 'Chart-OFC2-YAxis'
    => as 'Object'
    => where { $_[0]->isa('Chart::OFC2::YAxis') };
subtype 'Chart-OFC2-XAxis' 
    => as 'Object'
    => where { $_[0]->isa('Chart::OFC2::XAxis') };

has 'name'        => ( is => 'rw', isa => enum(['x_axis', 'y_axis', 'y_axis_right']), required => 1 );
has 'labels'      => ( is => 'rw', isa => 'Chart-OFC2-Labels', coerce  => 1);
has 'stroke'      => ( is => 'rw', isa => 'Int', );
has 'colour'      => ( is => 'rw', isa => 'Str',  );
has 'offset'      => ( is => 'rw', isa => 'Bool', );
has 'grid_colour' => ( is => 'rw', isa => 'Str', );
has '3d'          => ( is => 'rw', isa => 'Bool', );
has 'steps'       => ( is => 'rw', isa => 'Int', );
has 'visible'     => ( is => 'rw', isa => 'Bool',  );
has 'min'         => ( is => 'rw', isa => 'Num|Str|Undef', );   # can be 'a' for auto too
has 'max'         => ( is => 'rw', isa => 'Num|Str|Undef', );   # can be 'a' for auto too

METHODS

TO_JSON()

Returns HashRef that is possible to give to encode_json() function.

Chart::OFC2::XAxis

X axis object.

extends 'Chart::OFC2::Axis';

PROPERTIES

has '+name'       => ( default => 'x_axis', );
has 'tick_height' => ( is => 'rw', isa => 'Int', );

Chart::OFC2::YAxis

y axis object.

extends 'Chart::OFC2::Axis';

PROPERTIES

has '+name'        => ( default => 'y_axis' );
has 'tick_length' => ( is => 'rw', isa => 'Int', );

Chart::OFC2::YAxisRight

y axis on the right side object.

extends 'Chart::OFC2::YAxis';

PROPERTIES

has '+name' => ( default => 'y_axis_right' );

AUTHOR

Jozef Kutej