Class: MicrosoftGraph::Models::WorkbookTable

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/workbook_table.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new workbookTable and sets the default values.



70
71
72
 
# File 'lib/models/workbook_table.rb', line 70

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a workbook_table

Raises:

  • (StandardError) 


78
79
80
81
 
# File 'lib/models/workbook_table.rb', line 78

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return WorkbookTable.new
end

Instance Method Details

#columns ⇒ Object

Gets the columns property value. Represents a collection of all the columns in the table. Read-only.

Returns:

  • a workbook_table_column



55
56
57
 
# File 'lib/models/workbook_table.rb', line 55

def columns
    return @columns
end

#columns=(value) ⇒ Object

Sets the columns property value. Represents a collection of all the columns in the table. Read-only.

Parameters:

  • value —

    Value to set for the columns property.

Returns:

  • a void



63
64
65
 
# File 'lib/models/workbook_table.rb', line 63

def columns=(value)
    @columns = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/models/workbook_table.rb', line 86

def get_field_deserializers()
    return super.merge({
        "columns" => lambda {|n| @columns = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::WorkbookTableColumn.create_from_discriminator_value(pn) }) },
        "highlightFirstColumn" => lambda {|n| @highlight_first_column = n.get_boolean_value() },
        "highlightLastColumn" => lambda {|n| @highlight_last_column = n.get_boolean_value() },
        "legacyId" => lambda {|n| @legacy_id = n.get_string_value() },
        "name" => lambda {|n| @name = n.get_string_value() },
        "rows" => lambda {|n| @rows = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::WorkbookTableRow.create_from_discriminator_value(pn) }) },
        "showBandedColumns" => lambda {|n| @show_banded_columns = n.get_boolean_value() },
        "showBandedRows" => lambda {|n| @show_banded_rows = n.get_boolean_value() },
        "showFilterButton" => lambda {|n| @show_filter_button = n.get_boolean_value() },
        "showHeaders" => lambda {|n| @show_headers = n.get_boolean_value() },
        "showTotals" => lambda {|n| @show_totals = n.get_boolean_value() },
        "sort" => lambda {|n| @sort = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookTableSort.create_from_discriminator_value(pn) }) },
        "style" => lambda {|n| @style = n.get_string_value() },
        "worksheet" => lambda {|n| @worksheet = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookWorksheet.create_from_discriminator_value(pn) }) },
    })
end

#highlight_first_column ⇒ Object

Gets the highlightFirstColumn property value. Indicates whether the first column contains special formatting.

Returns:

  • a boolean



108
109
110
 
# File 'lib/models/workbook_table.rb', line 108

def highlight_first_column
    return @highlight_first_column
end

#highlight_first_column=(value) ⇒ Object

Sets the highlightFirstColumn property value. Indicates whether the first column contains special formatting.

Parameters:

  • value —

    Value to set for the highlightFirstColumn property.

Returns:

  • a void



116
117
118
 
# File 'lib/models/workbook_table.rb', line 116

def highlight_first_column=(value)
    @highlight_first_column = value
end

#highlight_last_column ⇒ Object

Gets the highlightLastColumn property value. Indicates whether the last column contains special formatting.

Returns:

  • a boolean



123
124
125
 
# File 'lib/models/workbook_table.rb', line 123

def highlight_last_column
    return @highlight_last_column
end

#highlight_last_column=(value) ⇒ Object

Sets the highlightLastColumn property value. Indicates whether the last column contains special formatting.

Parameters:

  • value —

    Value to set for the highlightLastColumn property.

Returns:

  • a void



131
132
133
 
# File 'lib/models/workbook_table.rb', line 131

def highlight_last_column=(value)
    @highlight_last_column = value
end

#legacy_id ⇒ Object

Gets the legacyId property value. Legacy Id used in older Excle clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and should not be parsed to any other type. Read-only.

Returns:

  • a string



138
139
140
 
# File 'lib/models/workbook_table.rb', line 138

def legacy_id
    return @legacy_id
end

#legacy_id=(value) ⇒ Object

Sets the legacyId property value. Legacy Id used in older Excle clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and should not be parsed to any other type. Read-only.

Parameters:

  • value —

    Value to set for the legacyId property.

Returns:

  • a void



146
147
148
 
# File 'lib/models/workbook_table.rb', line 146

def legacy_id=(value)
    @legacy_id = value
end

#name ⇒ Object

Gets the name property value. Name of the table.

Returns:

  • a string



153
154
155
 
# File 'lib/models/workbook_table.rb', line 153

def name
    return @name
end

#name=(value) ⇒ Object

Sets the name property value. Name of the table.

Parameters:

  • value —

    Value to set for the name property.

Returns:

  • a void



161
162
163
 
# File 'lib/models/workbook_table.rb', line 161

def name=(value)
    @name = value
end

#rows ⇒ Object

Gets the rows property value. Represents a collection of all the rows in the table. Read-only.

Returns:

  • a workbook_table_row



168
169
170
 
# File 'lib/models/workbook_table.rb', line 168

def rows
    return @rows
end

#rows=(value) ⇒ Object

Sets the rows property value. Represents a collection of all the rows in the table. Read-only.

Parameters:

  • value —

    Value to set for the rows property.

Returns:

  • a void



176
177
178
 
# File 'lib/models/workbook_table.rb', line 176

def rows=(value)
    @rows = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/models/workbook_table.rb', line 184

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("columns", @columns)
    writer.write_boolean_value("highlightFirstColumn", @highlight_first_column)
    writer.write_boolean_value("highlightLastColumn", @highlight_last_column)
    writer.write_string_value("legacyId", @legacy_id)
    writer.write_string_value("name", @name)
    writer.write_collection_of_object_values("rows", @rows)
    writer.write_boolean_value("showBandedColumns", @show_banded_columns)
    writer.write_boolean_value("showBandedRows", @show_banded_rows)
    writer.write_boolean_value("showFilterButton", @show_filter_button)
    writer.write_boolean_value("showHeaders", @show_headers)
    writer.write_boolean_value("showTotals", @show_totals)
    writer.write_object_value("sort", @sort)
    writer.write_string_value("style", @style)
    writer.write_object_value("worksheet", @worksheet)
end

#show_banded_columns ⇒ Object

Gets the showBandedColumns property value. Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.

Returns:

  • a boolean



206
207
208
 
# File 'lib/models/workbook_table.rb', line 206

def show_banded_columns
    return @show_banded_columns
end

#show_banded_columns=(value) ⇒ Object

Sets the showBandedColumns property value. Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.

Parameters:

  • value —

    Value to set for the showBandedColumns property.

Returns:

  • a void



214
215
216
 
# File 'lib/models/workbook_table.rb', line 214

def show_banded_columns=(value)
    @show_banded_columns = value
end

#show_banded_rows ⇒ Object

Gets the showBandedRows property value. Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.

Returns:

  • a boolean



221
222
223
 
# File 'lib/models/workbook_table.rb', line 221

def show_banded_rows
    return @show_banded_rows
end

#show_banded_rows=(value) ⇒ Object

Sets the showBandedRows property value. Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.

Parameters:

  • value —

    Value to set for the showBandedRows property.

Returns:

  • a void



229
230
231
 
# File 'lib/models/workbook_table.rb', line 229

def show_banded_rows=(value)
    @show_banded_rows = value
end

#show_filter_button ⇒ Object

Gets the showFilterButton property value. Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.

Returns:

  • a boolean



236
237
238
 
# File 'lib/models/workbook_table.rb', line 236

def show_filter_button
    return @show_filter_button
end

#show_filter_button=(value) ⇒ Object

Sets the showFilterButton property value. Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.

Parameters:

  • value —

    Value to set for the showFilterButton property.

Returns:

  • a void



244
245
246
 
# File 'lib/models/workbook_table.rb', line 244

def show_filter_button=(value)
    @show_filter_button = value
end

#show_headers ⇒ Object

Gets the showHeaders property value. Indicates whether the header row is visible or not. This value can be set to show or remove the header row.

Returns:

  • a boolean



251
252
253
 
# File 'lib/models/workbook_table.rb', line 251

def show_headers
    return @show_headers
end

#show_headers=(value) ⇒ Object

Sets the showHeaders property value. Indicates whether the header row is visible or not. This value can be set to show or remove the header row.

Parameters:

  • value —

    Value to set for the showHeaders property.

Returns:

  • a void



259
260
261
 
# File 'lib/models/workbook_table.rb', line 259

def show_headers=(value)
    @show_headers = value
end

#show_totals ⇒ Object

Gets the showTotals property value. Indicates whether the total row is visible or not. This value can be set to show or remove the total row.

Returns:

  • a boolean



266
267
268
 
# File 'lib/models/workbook_table.rb', line 266

def show_totals
    return @show_totals
end

#show_totals=(value) ⇒ Object

Sets the showTotals property value. Indicates whether the total row is visible or not. This value can be set to show or remove the total row.

Parameters:

  • value —

    Value to set for the showTotals property.

Returns:

  • a void



274
275
276
 
# File 'lib/models/workbook_table.rb', line 274

def show_totals=(value)
    @show_totals = value
end

#sort ⇒ Object

Gets the sort property value. Represents the sorting for the table. Read-only.

Returns:

  • a workbook_table_sort



281
282
283
 
# File 'lib/models/workbook_table.rb', line 281

def sort
    return @sort
end

#sort=(value) ⇒ Object

Sets the sort property value. Represents the sorting for the table. Read-only.

Parameters:

  • value —

    Value to set for the sort property.

Returns:

  • a void



289
290
291
 
# File 'lib/models/workbook_table.rb', line 289

def sort=(value)
    @sort = value
end

#style ⇒ Object

Gets the style property value. Constant value that represents the Table style. The possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.

Returns:

  • a string



296
297
298
 
# File 'lib/models/workbook_table.rb', line 296

def style
    return @style
end

#style=(value) ⇒ Object

Sets the style property value. Constant value that represents the Table style. The possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.

Parameters:

  • value —

    Value to set for the style property.

Returns:

  • a void



304
305
306
 
# File 'lib/models/workbook_table.rb', line 304

def style=(value)
    @style = value
end

#worksheet ⇒ Object

Gets the worksheet property value. The worksheet containing the current table. Read-only.

Returns:

  • a workbook_worksheet



311
312
313
 
# File 'lib/models/workbook_table.rb', line 311

def worksheet
    return @worksheet
end

#worksheet=(value) ⇒ Object

Sets the worksheet property value. The worksheet containing the current table. Read-only.

Parameters:

  • value —

    Value to set for the worksheet property.

Returns:

  • a void



319
320
321
 
# File 'lib/models/workbook_table.rb', line 319

def worksheet=(value)
    @worksheet = value
end