NAME
Spreadsheet::XLSX::Reader::LibXML::Chartsheet - Read xlsx chartsheets with LibXML
SYNOPSIS
See the SYNOPSIS in the Workbook class
DESCRIPTION
This documentation is intended to cover all 'chart' sheets. For review of the function and implementation of the 'tabular' data style worksheets please review the documentation for Worksheets.
Currently this class is mostly a stub to keep the package from dying if a chartsheet exists in the xlsx file to be read. It doesn't provide much functionality or indeed expose any real useful information about the chart. Please provide all suggestions to what you would like for this class to do to the issues section in the github repo
Extending the chartsheet class
I don't have any good ideas yet. Outside input welcome.
Attributes
These are attributes that contain information about the sheet. Not much else. At the end of this list it is noted that a reference to the workbook is stored in one of the attributes as well so many workbook settings can be adjusted from the chartsheet instance. (Don't)
sheet_rel_id
Definition: This is the relId of the sheet listed in the XML of the .xlsx file. You probably don't care and you should never set this value.
attribute methods Methods provided to adjust this attribute
rel_id
Definition: returns the value stored in the attribute
sheet_id
Definition: This is the Id of the sheet listed in the XML of the .xlsx file. I beleive this to be the number used in vbscript to reference the sheet. You should never set this value.
attribute methods Methods provided to adjust this attribute
sheet_id
Definition: returns the value stored in the attribute
sheet_position
Definition: This is the visual sheet position in the .xlsx file. You should never set this value.
attribute methods Methods provided to adjust this attribute
position
Definition: returns the value stored in the attribute
sheet_name
Definition: This is the visual sheet name in the .xlsx file. You should never set this value.
attribute methods Methods provided to adjust this attribute
get_name
Definition: returns the value stored in the attribute
drawing_rel_id
Definition: A chart sheet has an underlying drawing object that the chart is built on. This is the xlsx relID of that drawing object.
attribute methods Methods provided to adjust this attribute
get_drawing_rel_id
Definition: returns the value stored in the attribute
sheet_type
Definition: There are two possible kinds of sheets in an Excel file; 'worksheets' and 'chartsheets' if you are not sure what kind of sheet you have this is where the information is stored.
attribute methods Methods provided to adjust this attribute
get_sheet_type
Definition: returns the value stored in the attribute (chartsheet)
workbook_instance
Definition: This attribute holds a reference back to the workbook instance so that the worksheet has access to the global settings managed there. As a consequence many of the workbook methods are be exposed here. This includes some setter methods for workbook attributes. Beware that setting or adjusting the workbook level attributes with methods here will be universal and affect other worksheets. So don't forget to return the old value if you want the old behavour after you are done. If that doesn't make sense then don't use these methods. (Nothing to see here! Move along.)
Default: a Spreadsheet::XLSX::Reader::LibXML instance
attribute methods Methods of the workbook exposed here by the delegation of the instance to this class through this attribute
counting_from_zero
Definition: returns the "count_from_zero" in Spreadsheet::XLSX::Reader::LibXML instance state
boundary_flag_setting
Definition: returns the "file_boundary_flags" in Spreadsheet::XLSX::Reader::LibXML instance state
change_boundary_flag( $Bool )
Definition: sets the "file_boundary_flags" in Spreadsheet::XLSX::Reader::LibXML instance state (For the whole workbook!)
get_shared_string_position( $int )
Definition: returns the shared string data stored in the sharedStrings file at position $int. For more information review Spreadsheet::XLSX::Reader::LibXML::SharedStrings. This is a delegation of a delegation!
get_format_position( $int, [$header] )
Definition: returns the format data stored in the styles file at position $int. If the optional $header is passed only the data for that header is returned. Otherwise all styles for that position are returned. For more information review Spreadsheet::XLSX::Reader::LibXML::Styles. This is a delegation of a delegation!
set_empty_is_end( $Bool )
Definition: sets the "empty_is_end" in Spreadsheet::XLSX::Reader::LibXML instance state (For the whole workbook!)
is_empty_the_end
Definition: returns the "empty_is_end" in Spreadsheet::XLSX::Reader::LibXML instance state.
get_group_return_type
Definition: returns the "group_return_type" in Spreadsheet::XLSX::Reader::LibXML instance state.
set_group_return_type( (instance|unformatted|value) )
Definition: sets the "group_return_type" in Spreadsheet::XLSX::Reader::LibXML instance state (For the whole workbook!)
get_epoch_year
Definition: uses the "get_epoch_year" in Spreadsheet::XLSX::Reader::LibXML method.
get_date_behavior
Definition: This is a delegated method from the styles class (stored as a private instance in the workbook). It is held (and documented) in the Spreadsheet::XLSX::Reader::LibXML::ParseExcelFormatStrings role. It will indicate how far unformatted transformation is carried for date coercions when returning formatted values.
set_date_behavior
Definition: This is a delegated method from the styles class (stored as a private instance in the workbook). It is held (and documented) in the Spreadsheet::XLSX::Reader::LibXML::ParseExcelFormatStrings role. It will set how far unformatted transformation is carried for date coercions when returning formatted values.
get_values_only
Definition: gets the "values_only" in Spreadsheet::XLSX::Reader::LibXML instance state.
set_values_only
Definition: sets the "values_only" in Spreadsheet::XLSX::Reader::LibXML instance state (For the whole workbook!)
SUPPORT
github Spreadsheet::XLSX::Reader::LibXML/issues
TODO
1. Figure out what users want from their charts and how they want to read it.
AUTHOR
COPYRIGHT
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
This software is copyrighted (c) 2014, 2015 by Jed Lund
DEPENDENCIES
Spreadsheet::XLSX::Reader::LibXML
SEE ALSO
Spreadsheet::ParseExcel - Excel 2003 and earlier
Spreadsheet::XLSX - 2007+
Spreadsheet::ParseXLSX - 2007+
All lines in this package that use Log::Shiras are commented out