View Source GoogleApi.Sheets.V4.Model.SheetProperties (google_api_sheets v0.31.0)

Properties of a sheet.

Attributes

dataSourceSheetProperties (type: GoogleApi.Sheets.V4.Model.DataSourceSheetProperties.t, default: nil) - Output only. If present, the field contains DATA_SOURCE sheet specific properties.
gridProperties (type: GoogleApi.Sheets.V4.Model.GridProperties.t, default: nil) - Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. row_count.
hidden (type: boolean(), default: nil) - True if the sheet is hidden in the UI, false if it's visible.
index (type: integer(), default: nil) - The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were three sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.
rightToLeft (type: boolean(), default: nil) - True if the sheet is an RTL sheet instead of an LTR sheet.
sheetId (type: integer(), default: nil) - The ID of the sheet. Must be non-negative. This field cannot be changed once set.
sheetType (type: String.t, default: nil) - The type of sheet. Defaults to GRID. This field cannot be changed once set.
tabColor (type: GoogleApi.Sheets.V4.Model.Color.t, default: nil) - The color of the tab in the UI. Deprecated: Use tab_color_style.
tabColorStyle (type: GoogleApi.Sheets.V4.Model.ColorStyle.t, default: nil) - The color of the tab in the UI. If tab_color is also set, this field takes precedence.
title (type: String.t, default: nil) - The name of the sheet.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Sheets.V4.Model.SheetProperties{
  dataSourceSheetProperties:
    GoogleApi.Sheets.V4.Model.DataSourceSheetProperties.t() | nil,
  gridProperties: GoogleApi.Sheets.V4.Model.GridProperties.t() | nil,
  hidden: boolean() | nil,
  index: integer() | nil,
  rightToLeft: boolean() | nil,
  sheetId: integer() | nil,
  sheetType: String.t() | nil,
  tabColor: GoogleApi.Sheets.V4.Model.Color.t() | nil,
  tabColorStyle: GoogleApi.Sheets.V4.Model.ColorStyle.t() | nil,
  title: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.