ColumnInfo(3pm)

📦 version 2.1.1, in arch rolling

okay so bestie, welcome to ColumnInfo(3pm) from LogReport's Lire Documentation — she’s the little meta-data info card for columns in a subreport, and she has main character energy 💅✨

🌸 NAME 🌸

Lire::Report::ColumnInfo — the object that holds column meta-data. literally her whole job 💖

🦋 SYNOPSIS 🦋

        my $info = $subreport->column_info_by_idx( 0 );
        print "Column's name: ", $info->name(),   "\n";
        print "Column's index: ", $info->index(), "\n";
        print "Column's type: ", $info->type(),   "\n";
        print "Column's label: ", $info->label(), "\n";

highkey iconic — peek at the column info, then spill the name, index, type, and label 🌈

🎀 DESCRIPTION 🎀

The Lire::Report::ColumnInfo object contains meta-data information on the columns of a subreport. no cap, that’s the vibe: she’s holding the info about your columns 🫶

💖 CONSTRUCTOR 💖

🧚 new() 🧚

new( $group, $name, $class, $type, [$label]])

Creates a new Lire::Report::ColumnInfo object. The column info attributes are initialized based on $name, $class, $type and $label. yup, those are the besties doing the setup ✨

ngl the signature also has $group in it — that’s exactly how it’s written above, bestie. don’t come for me, I’m just relaying the group chat 😭

💅 OBJECT METHODS 💅

🌈 name() 🌈

Returns the name of this column. This name can be used to find the group operation (from the report specification) that is responsible for the column's content. she’s the little name tag that helps you trace the operation, iykyk 🎀

🍓 class() 🍓

Returns the column's class of data. This will be either 'numerical' or 'categorical'. the way that those are the only two moods, honestly.

🦋 type() 🦋

Returns the column's type. This refers to the type of the DLF field that was used to generate this column's values. DLF field tea ☕

🌸 group_info() 🌸

Returns the GroupInfo object which contains this column. the way that she knows her group info bestie 🫶

⭐ index() ⭐

Returns the column's index in the table. This will be undef until the column info object is added to a Lire::Subreport or Lire::Group object. so if you’re getting undef, not me getting “she’s not seated at the table yet” energy 💀

🧚 col_start() 🧚

Returns the display column which is the start of the cell span that should be used to render this column's values. start-of-the-span realness ✨

🧚 col_end() 🧚

Returns the display column which is the end of the cell span that should be used to render this column's values. end-of-the-span realness ✨

🎀 col_width() 🎀

Returns the suggested column width for this column in characters. suggested width, bestie — she’s just giving recommendations 💅

🔥 max_chars() 🔥

This method returns the length of the longest string in that column (including the label). yes bestie, the label counts too 👑

🌈 avg_chars() 🌈

This method returns the average length of strings in that column (including the label). This will be rounded up to the next integer (1.3 -> 2). math girlie ate that 🍓

💜 label( [$label] ) 💜

Returns the column's label. If the $label parameter is defined, the column's label will be set to this new value. so she’s a getter, and also a setter when you pass the arg — fr fr 🫶 periodt.

🦋 SEE ALSO 🦋

iconic references, go read them after this 💖

⭐ VERSION ⭐

$Id: ColumnInfo.pm,v 1.15 2006/07/23 13:16:31 vanbaal Exp $

Copyright (C) 2002 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

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.

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.

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.

🌸 AUTHOR 🌸

Francis J. Lacoste <flacoste@logreport.org>

okay that’s the whole page, bestie — this is from Lire 2.1.1, dated 2025-09-28. mwah, go slay your columns 💖✨

📦 where this page comes from