.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "ChartConfig 3pm" .TH ChartConfig 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Lire::Report::ChartConfig \- Chart configuration object. .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Lire::Report::ChartConfig; \& \& my $chart = new Lire::Report::ChartConfig(); \& $chart\->title( \*(AqDownloads by Visits Scatterplot\*(Aq ) \& $chart\->type( Lire::PluginManager\->get_plugin( \*(Aqchart_type\*(Aq, \*(Aqscatterplot\*(Aq ); \& ... .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This is a Lire::Config::Dictionary subclass which is used to define a chart that will be generated from a Lire::Report::Subreport. .SH CONSTRUCTOR .IX Header "CONSTRUCTOR" .SS \fBnew()\fP .IX Subsection "new()" Creates a new Lire::Report::ChartConfig object. .SH ATTRIBUTES .IX Header "ATTRIBUTES" These are methods that wraps around the Lire::Config::Dictionary \fBget()\fR and \fBset()\fR method. .ie n .SS "basename( [ $new_basename ] )" .el .SS "basename( [ \f(CW$new_basename\fP ] )" .IX Subsection "basename( [ $new_basename ] )" Returns (and optionnally changes) the Chart\*(Aqs basename. .ie n .SS "title( [ $new_title ] )" .el .SS "title( [ \f(CW$new_title\fP ] )" .IX Subsection "title( [ $new_title ] )" Returns (and optionnally changes) the Chart\*(Aqs title. .ie n .SS "type( [ $new_type ] )" .el .SS "type( [ \f(CW$new_type\fP ] )" .IX Subsection "type( [ $new_type ] )" Returns (and optionally changes) the ChartType plugin used by this Config. .SS \fBtype_properties()\fP .IX Subsection "type_properties()" Returns the Lire::Config::Value object used to store the ChartType\*(Aqs specific properties. .SS \fBcase_var()\fP .IX Subsection "case_var()" Returns the Lire::Report::ColumnInfo object that is use to select the cases that will be part of the chart\*(Aqs data. .ie n .SS "xlabel( [ $new_xlabel ] )" .el .SS "xlabel( [ \f(CW$new_xlabel\fP ] )" .IX Subsection "xlabel( [ $new_xlabel ] )" Returns (and optionnally change) the Chart\*(Aqs X axis label.. .ie n .SS "ylabel( [ $new_ylabel ] )" .el .SS "ylabel( [ \f(CW$new_ylabel\fP ] )" .IX Subsection "ylabel( [ $new_ylabel ] )" Returns (and optionnally change) the Chart\*(Aqs Y axis label.. .SH "SEE ALSO" .IX Header "SEE ALSO" .Vb 1 \& Lire::Config::ChartSpec(3pm) Lire::ChartType(3pm) .Ve .SH VERSION .IX Header "VERSION" \&\f(CW$Id:\fR ChartConfig.pm,v 1.7 2006/07/23 13:16:31 vanbaal Exp $ .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org .PP This file is part of Lire. .PP Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .PP You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html. .SH AUTHOR .IX Header "AUTHOR" Francis J. Lacoste