Class: Google::Apis::SheetsV4::Sheet

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Sheet

Returns a new instance of Sheet.



8376
8377
8378
# File 'generated/google/apis/sheets_v4/classes.rb', line 8376

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#banded_rangesArray<Google::Apis::SheetsV4::BandedRange>

The banded (alternating colors) ranges on this sheet. Corresponds to the JSON property bandedRanges



8307
8308
8309
# File 'generated/google/apis/sheets_v4/classes.rb', line 8307

def banded_ranges
  @banded_ranges
end

#basic_filterGoogle::Apis::SheetsV4::BasicFilter

The default filter associated with a sheet. Corresponds to the JSON property basicFilter



8312
8313
8314
# File 'generated/google/apis/sheets_v4/classes.rb', line 8312

def basic_filter
  @basic_filter
end

#chartsArray<Google::Apis::SheetsV4::EmbeddedChart>

The specifications of every chart on this sheet. Corresponds to the JSON property charts



8317
8318
8319
# File 'generated/google/apis/sheets_v4/classes.rb', line 8317

def charts
  @charts
end

#column_groupsArray<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



8323
8324
8325
# File 'generated/google/apis/sheets_v4/classes.rb', line 8323

def column_groups
  @column_groups
end

#conditional_formatsArray<Google::Apis::SheetsV4::ConditionalFormatRule>

The conditional format rules in this sheet. Corresponds to the JSON property conditionalFormats



8328
8329
8330
# File 'generated/google/apis/sheets_v4/classes.rb', line 8328

def conditional_formats
  @conditional_formats
end

#dataArray<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



8338
8339
8340
# File 'generated/google/apis/sheets_v4/classes.rb', line 8338

def data
  @data
end

#developer_metadataArray<Google::Apis::SheetsV4::DeveloperMetadata>

The developer metadata associated with a sheet. Corresponds to the JSON property developerMetadata



8343
8344
8345
# File 'generated/google/apis/sheets_v4/classes.rb', line 8343

def 
  @developer_metadata
end

#filter_viewsArray<Google::Apis::SheetsV4::FilterView>

The filter views in this sheet. Corresponds to the JSON property filterViews



8348
8349
8350
# File 'generated/google/apis/sheets_v4/classes.rb', line 8348

def filter_views
  @filter_views
end

#mergesArray<Google::Apis::SheetsV4::GridRange>

The ranges that are merged together. Corresponds to the JSON property merges



8353
8354
8355
# File 'generated/google/apis/sheets_v4/classes.rb', line 8353

def merges
  @merges
end

#propertiesGoogle::Apis::SheetsV4::SheetProperties

Properties of a sheet. Corresponds to the JSON property properties



8358
8359
8360
# File 'generated/google/apis/sheets_v4/classes.rb', line 8358

def properties
  @properties
end

#protected_rangesArray<Google::Apis::SheetsV4::ProtectedRange>

The protected ranges in this sheet. Corresponds to the JSON property protectedRanges



8363
8364
8365
# File 'generated/google/apis/sheets_v4/classes.rb', line 8363

def protected_ranges
  @protected_ranges
end

#row_groupsArray<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



8369
8370
8371
# File 'generated/google/apis/sheets_v4/classes.rb', line 8369

def row_groups
  @row_groups
end

#slicersArray<Google::Apis::SheetsV4::Slicer>

The slicers on this sheet. Corresponds to the JSON property slicers

Returns:



8374
8375
8376
# File 'generated/google/apis/sheets_v4/classes.rb', line 8374

def slicers
  @slicers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
# File 'generated/google/apis/sheets_v4/classes.rb', line 8381

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