Class: Google::Apis::SheetsV4::Sheet
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::Sheet
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb
Overview
A sheet in a spreadsheet.
Instance Attribute Summary collapse
-
#banded_ranges ⇒ Array<Google::Apis::SheetsV4::BandedRange>
The banded (alternating colors) ranges on this sheet.
-
#basic_filter ⇒ Google::Apis::SheetsV4::BasicFilter
The default filter associated with a sheet.
-
#charts ⇒ Array<Google::Apis::SheetsV4::EmbeddedChart>
The specifications of every chart on this sheet.
-
#column_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>
All column groups on this sheet, ordered by increasing range start index, then by group depth.
-
#conditional_formats ⇒ Array<Google::Apis::SheetsV4::ConditionalFormatRule>
The conditional format rules in this sheet.
-
#data ⇒ Array<Google::Apis::SheetsV4::GridData>
Data in the grid, if this is a grid sheet.
-
#developer_metadata ⇒ Array<Google::Apis::SheetsV4::DeveloperMetadata>
The developer metadata associated with a sheet.
-
#filter_views ⇒ Array<Google::Apis::SheetsV4::FilterView>
The filter views in this sheet.
-
#merges ⇒ Array<Google::Apis::SheetsV4::GridRange>
The ranges that are merged together.
-
#properties ⇒ Google::Apis::SheetsV4::SheetProperties
Properties of a sheet.
-
#protected_ranges ⇒ Array<Google::Apis::SheetsV4::ProtectedRange>
The protected ranges in this sheet.
-
#row_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>
All row groups on this sheet, ordered by increasing range start index, then by group depth.
-
#slicers ⇒ Array<Google::Apis::SheetsV4::Slicer>
The slicers on this sheet.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Sheet
constructor
A new instance of Sheet.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Sheet
Returns a new instance of Sheet.
8733 8734 8735 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8733 def initialize(**args) update!(**args) end |
Instance Attribute Details
#banded_ranges ⇒ Array<Google::Apis::SheetsV4::BandedRange>
The banded (alternating colors) ranges on this sheet.
Corresponds to the JSON property bandedRanges
8662 8663 8664 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8662 def banded_ranges @banded_ranges end |
#basic_filter ⇒ Google::Apis::SheetsV4::BasicFilter
The default filter associated with a sheet.
Corresponds to the JSON property basicFilter
8667 8668 8669 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8667 def basic_filter @basic_filter end |
#charts ⇒ Array<Google::Apis::SheetsV4::EmbeddedChart>
The specifications of every chart on this sheet.
Corresponds to the JSON property charts
8672 8673 8674 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8672 def charts @charts end |
#column_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>
All column groups on this sheet, ordered by increasing range start index,
then by group depth.
Corresponds to the JSON property columnGroups
8678 8679 8680 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8678 def column_groups @column_groups end |
#conditional_formats ⇒ Array<Google::Apis::SheetsV4::ConditionalFormatRule>
The conditional format rules in this sheet.
Corresponds to the JSON property conditionalFormats
8683 8684 8685 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8683 def conditional_formats @conditional_formats end |
#data ⇒ Array<Google::Apis::SheetsV4::GridData>
Data in the grid, if this is a grid sheet.
The number of GridData objects returned is dependent on the number of
ranges requested on this sheet. For example, if this is representing
Sheet1
, and the spreadsheet was requested with ranges
Sheet1!A1:C10
and Sheet1!D15:E20
, then the first GridData will have a
startRow/startColumn of 0
,
while the second one will have startRow 14
(zero-based row 15),
and startColumn 3
(zero-based column D).
Corresponds to the JSON property data
8695 8696 8697 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8695 def data @data end |
#developer_metadata ⇒ Array<Google::Apis::SheetsV4::DeveloperMetadata>
The developer metadata associated with a sheet.
Corresponds to the JSON property developerMetadata
8700 8701 8702 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8700 def @developer_metadata end |
#filter_views ⇒ Array<Google::Apis::SheetsV4::FilterView>
The filter views in this sheet.
Corresponds to the JSON property filterViews
8705 8706 8707 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8705 def filter_views @filter_views end |
#merges ⇒ Array<Google::Apis::SheetsV4::GridRange>
The ranges that are merged together.
Corresponds to the JSON property merges
8710 8711 8712 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8710 def merges @merges end |
#properties ⇒ Google::Apis::SheetsV4::SheetProperties
Properties of a sheet.
Corresponds to the JSON property properties
8715 8716 8717 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8715 def properties @properties end |
#protected_ranges ⇒ Array<Google::Apis::SheetsV4::ProtectedRange>
The protected ranges in this sheet.
Corresponds to the JSON property protectedRanges
8720 8721 8722 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8720 def protected_ranges @protected_ranges end |
#row_groups ⇒ Array<Google::Apis::SheetsV4::DimensionGroup>
All row groups on this sheet, ordered by increasing range start index, then
by group depth.
Corresponds to the JSON property rowGroups
8726 8727 8728 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8726 def row_groups @row_groups end |
#slicers ⇒ Array<Google::Apis::SheetsV4::Slicer>
The slicers on this sheet.
Corresponds to the JSON property slicers
8731 8732 8733 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8731 def slicers @slicers end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 8738 def update!(**args) @banded_ranges = args[:banded_ranges] if args.key?(:banded_ranges) @basic_filter = args[:basic_filter] if args.key?(:basic_filter) @charts = args[:charts] if args.key?(:charts) @column_groups = args[:column_groups] if args.key?(:column_groups) @conditional_formats = args[:conditional_formats] if args.key?(:conditional_formats) @data = args[:data] if args.key?(:data) @developer_metadata = args[:developer_metadata] if args.key?(:developer_metadata) @filter_views = args[:filter_views] if args.key?(:filter_views) @merges = args[:merges] if args.key?(:merges) @properties = args[:properties] if args.key?(:properties) @protected_ranges = args[:protected_ranges] if args.key?(:protected_ranges) @row_groups = args[:row_groups] if args.key?(:row_groups) @slicers = args[:slicers] if args.key?(:slicers) end |