Class: Google::Apis::SheetsV4::SpreadsheetProperties

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

Properties of 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) ⇒ SpreadsheetProperties

Returns a new instance of SpreadsheetProperties



2780
2781
2782
# File 'generated/google/apis/sheets_v4/classes.rb', line 2780

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

Instance Attribute Details

#auto_recalcString

The amount of time to wait before volatile functions are recalculated. Corresponds to the JSON property autoRecalc

Returns:

  • (String)


2751
2752
2753
# File 'generated/google/apis/sheets_v4/classes.rb', line 2751

def auto_recalc
  @auto_recalc
end

#default_formatGoogle::Apis::SheetsV4::CellFormat

The format of a cell. Corresponds to the JSON property defaultFormat



2746
2747
2748
# File 'generated/google/apis/sheets_v4/classes.rb', line 2746

def default_format
  @default_format
end

#iterative_calculation_settingsGoogle::Apis::SheetsV4::IterativeCalculationSettings

Settings to control how circular dependencies are resolved with iterative calculation. Corresponds to the JSON property iterativeCalculationSettings



2778
2779
2780
# File 'generated/google/apis/sheets_v4/classes.rb', line 2778

def iterative_calculation_settings
  @iterative_calculation_settings
end

#localeString

The locale of the spreadsheet in one of the following formats:

  • an ISO 639-1 language code such as en
  • an ISO 639-2 language code such as fil, if no 639-1 code exists
  • a combination of the ISO language code and country code, such as en_US Note: when updating this field, not all locales/languages are supported. Corresponds to the JSON property locale

Returns:

  • (String)


2772
2773
2774
# File 'generated/google/apis/sheets_v4/classes.rb', line 2772

def locale
  @locale
end

#time_zoneString

The time zone of the spreadsheet, in CLDR format such as America/New_York. If the time zone isn't recognized, this may be a custom time zone such as GMT-07:00. Corresponds to the JSON property timeZone

Returns:

  • (String)


2763
2764
2765
# File 'generated/google/apis/sheets_v4/classes.rb', line 2763

def time_zone
  @time_zone
end

#titleString

The title of the spreadsheet. Corresponds to the JSON property title

Returns:

  • (String)


2756
2757
2758
# File 'generated/google/apis/sheets_v4/classes.rb', line 2756

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2785
2786
2787
2788
2789
2790
2791
2792
# File 'generated/google/apis/sheets_v4/classes.rb', line 2785

def update!(**args)
  @default_format = args[:default_format] if args.key?(:default_format)
  @auto_recalc = args[:auto_recalc] if args.key?(:auto_recalc)
  @title = args[:title] if args.key?(:title)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @locale = args[:locale] if args.key?(:locale)
  @iterative_calculation_settings = args[:iterative_calculation_settings] if args.key?(:iterative_calculation_settings)
end