NAME

Google::RestApi::SheetsApi4::RangeGroup - Represents a group of ranges in a Worksheet.

DESCRIPTION

A RangeGroup is a lightweight object represents a collection of ranges on which you can operate as one unit (e.g. RangeGroup::submit_values will submit all batch values for the underlying ranges).

See the description and synopsis at Google::RestApi::SheetsApi4.

SUBROUTINES

new(spreadsheet => <Spreadsheet>, ranges => <arrayref<Range>>);

Creates a new range group object for the given spreadsheet.

 spreadsheet: The parent Spreadsheet object for this range group.
 ranges: The array of ranges to be grouped into this range group.

You would not normally call this directly, you'd use Spreadsheet::range_group method to create the range group object for you.

api(%args);

Calls the parent spreadsheet's 'api' routine with the ranges added into the URI or content appropriately.

You would not normally call this directly unless you were making a Google API call not currently supported by this API framework.

append(<arrayref<Range>>);

Adds the extra ranges to this range group. No attempt is made to check for duplicate range objects.

values(%args);

Fetches the values of the spreadsheet for each range in the group. Note that there is no way to set values with this method as it is assumed that setting will be done via routine batch_values.

'args' are passed to the SheetsApi4's 'api' routine so you may add extra arguments to the 'params' as necessary.

batch_values(values => <arrayref>);

Gets or sets the queued batch values for each range in the range group. Batch values can be set on particular ranges individually, or can be set with this routine all in one shot.

submit_values(%args);

Sends the previously queued batch values to Google API, if any.

'args' are passed to the SheetsApi4's 'api' routine so you may add extra arguments to the 'params' or 'content' as necessary.

batch_requests();

Gets the queued batch requests for each range in the group.

submit_requests(%args);

Sends the previously queued requests (formatting, sheet properties etc) to Google API, if any.

'args' are passed to the SheetsApi4's 'api' routine so you may add extra arguments to the 'params' or 'content' as necessary.

iterator(%args);

Returns an iterator for this range group. Any 'args' are passed to the 'new' routine for the iterator.

has_values();

Returns a true value if any of the underlying ranges has values associated with it.

ranges();

Returns the array of Range objects in this range group.

spreadsheet();

Returns the parent Spreadsheet object.

AUTHORS

  • Robin Murray mvsjes@cpan.org

COPYRIGHT

Copyright (c) 2019, Robin Murray. All rights reserved.

This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.