Class: AsposeCellsCloud::PivotField

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/pivot_field.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PivotField

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 205

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'AutoShowCount')
      self.auto_show_count = attributes[:'AutoShowCount']
  end
  if attributes.has_key?(:'AutoShowField')
      self.auto_show_field = attributes[:'AutoShowField']
  end
  if attributes.has_key?(:'AutoSortField')
      self.auto_sort_field = attributes[:'AutoSortField']
  end
  if attributes.has_key?(:'BaseField')
      self.base_field = attributes[:'BaseField']
  end
  if attributes.has_key?(:'BaseIndex')
      self.base_index = attributes[:'BaseIndex']
  end
  if attributes.has_key?(:'BaseItem')
      self.base_item = attributes[:'BaseItem']
  end
  if attributes.has_key?(:'BaseItemPosition')
      self.base_item_position = attributes[:'BaseItemPosition']
  end
  if attributes.has_key?(:'CurrentPageItem')
      self.current_page_item = attributes[:'CurrentPageItem']
  end
  if attributes.has_key?(:'DataDisplayFormat')
      self.data_display_format = attributes[:'DataDisplayFormat']
  end
  if attributes.has_key?(:'DisplayName')
      self.display_name = attributes[:'DisplayName']
  end
  if attributes.has_key?(:'DragToColumn')
      self.drag_to_column = attributes[:'DragToColumn']
  end
  if attributes.has_key?(:'DragToData')
      self.drag_to_data = attributes[:'DragToData']
  end
  if attributes.has_key?(:'DragToHide')
      self.drag_to_hide = attributes[:'DragToHide']
  end
  if attributes.has_key?(:'DragToPage')
      self.drag_to_page = attributes[:'DragToPage']
  end
  if attributes.has_key?(:'DragToRow')
      self.drag_to_row = attributes[:'DragToRow']
  end
  if attributes.has_key?(:'Function')
      self.function = attributes[:'Function']
  end
  if attributes.has_key?(:'InsertBlankRow')
      self.insert_blank_row = attributes[:'InsertBlankRow']
  end
  if attributes.has_key?(:'IsAscendShow')
      self.is_ascend_show = attributes[:'IsAscendShow']
  end
  if attributes.has_key?(:'IsAscendSort')
      self.is_ascend_sort = attributes[:'IsAscendSort']
  end
  if attributes.has_key?(:'IsAutoShow')
      self.is_auto_show = attributes[:'IsAutoShow']
  end
  if attributes.has_key?(:'IsAutoSort')
      self.is_auto_sort = attributes[:'IsAutoSort']
  end
  if attributes.has_key?(:'IsAutoSubtotals')
      self.is_auto_subtotals = attributes[:'IsAutoSubtotals']
  end
  if attributes.has_key?(:'IsCalculatedField')
      self.is_calculated_field = attributes[:'IsCalculatedField']
  end
  if attributes.has_key?(:'IsIncludeNewItemsInFilter')
      self.is_include_new_items_in_filter = attributes[:'IsIncludeNewItemsInFilter']
  end
  if attributes.has_key?(:'IsInsertPageBreaksBetweenItems')
      self.is_insert_page_breaks_between_items = attributes[:'IsInsertPageBreaksBetweenItems']
  end
  if attributes.has_key?(:'IsMultipleItemSelectionAllowed')
      self.is_multiple_item_selection_allowed = attributes[:'IsMultipleItemSelectionAllowed']
  end
  if attributes.has_key?(:'IsRepeatItemLabels')
      self.is_repeat_item_labels = attributes[:'IsRepeatItemLabels']
  end
  if attributes.has_key?(:'ItemCount')
      self.item_count = attributes[:'ItemCount']
  end
  if attributes.has_key?(:'Items')
      self.items = attributes[:'Items']
  end
  if attributes.has_key?(:'Name')
      self.name = attributes[:'Name']
  end
  if attributes.has_key?(:'Number')
      self.number = attributes[:'Number']
  end
  if attributes.has_key?(:'NumberFormat')
      self.number_format = attributes[:'NumberFormat']
  end
  if attributes.has_key?(:'OriginalItems')
      self.original_items = attributes[:'OriginalItems']
  end
  if attributes.has_key?(:'PivotItems')
      self.pivot_items = attributes[:'PivotItems']
  end
  if attributes.has_key?(:'Position')
      self.position = attributes[:'Position']
  end
  if attributes.has_key?(:'ShowAllItems')
      self.show_all_items = attributes[:'ShowAllItems']
  end
  if attributes.has_key?(:'ShowCompact')
      self.show_compact = attributes[:'ShowCompact']
  end
  if attributes.has_key?(:'ShowInOutlineForm')
      self.show_in_outline_form = attributes[:'ShowInOutlineForm']
  end
  if attributes.has_key?(:'ShowSubtotalAtTop')
      self.show_subtotal_at_top = attributes[:'ShowSubtotalAtTop']
  end

end

Instance Attribute Details

#auto_show_countObject

Returns the value of attribute auto_show_count.



35
36
37
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 35

def auto_show_count
  @auto_show_count
end

#auto_show_fieldObject

Returns the value of attribute auto_show_field.



37
38
39
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 37

def auto_show_field
  @auto_show_field
end

#auto_sort_fieldObject

Returns the value of attribute auto_sort_field.



39
40
41
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 39

def auto_sort_field
  @auto_sort_field
end

#base_fieldObject

Returns the value of attribute base_field.



41
42
43
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 41

def base_field
  @base_field
end

#base_indexObject

Returns the value of attribute base_index.



43
44
45
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 43

def base_index
  @base_index
end

#base_itemObject

Returns the value of attribute base_item.



45
46
47
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 45

def base_item
  @base_item
end

#base_item_positionObject

Returns the value of attribute base_item_position.



47
48
49
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 47

def base_item_position
  @base_item_position
end

#current_page_itemObject

Returns the value of attribute current_page_item.



49
50
51
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 49

def current_page_item
  @current_page_item
end

#data_display_formatObject

Returns the value of attribute data_display_format.



51
52
53
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 51

def data_display_format
  @data_display_format
end

#display_nameObject

Returns the value of attribute display_name.



53
54
55
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 53

def display_name
  @display_name
end

#drag_to_columnObject

Returns the value of attribute drag_to_column.



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

def drag_to_column
  @drag_to_column
end

#drag_to_dataObject

Returns the value of attribute drag_to_data.



57
58
59
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 57

def drag_to_data
  @drag_to_data
end

#drag_to_hideObject

Returns the value of attribute drag_to_hide.



59
60
61
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 59

def drag_to_hide
  @drag_to_hide
end

#drag_to_pageObject

Returns the value of attribute drag_to_page.



61
62
63
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 61

def drag_to_page
  @drag_to_page
end

#drag_to_rowObject

Returns the value of attribute drag_to_row.



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

def drag_to_row
  @drag_to_row
end

#functionObject

Returns the value of attribute function.



65
66
67
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 65

def function
  @function
end

#insert_blank_rowObject

Returns the value of attribute insert_blank_row.



67
68
69
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 67

def insert_blank_row
  @insert_blank_row
end

#is_ascend_showObject

Returns the value of attribute is_ascend_show.



69
70
71
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 69

def is_ascend_show
  @is_ascend_show
end

#is_ascend_sortObject

Returns the value of attribute is_ascend_sort.



71
72
73
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 71

def is_ascend_sort
  @is_ascend_sort
end

#is_auto_showObject

Returns the value of attribute is_auto_show.



73
74
75
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 73

def is_auto_show
  @is_auto_show
end

#is_auto_sortObject

Returns the value of attribute is_auto_sort.



75
76
77
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 75

def is_auto_sort
  @is_auto_sort
end

#is_auto_subtotalsObject

Returns the value of attribute is_auto_subtotals.



77
78
79
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 77

def is_auto_subtotals
  @is_auto_subtotals
end

#is_calculated_fieldObject

Returns the value of attribute is_calculated_field.



79
80
81
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 79

def is_calculated_field
  @is_calculated_field
end

#is_include_new_items_in_filterObject

Returns the value of attribute is_include_new_items_in_filter.



81
82
83
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 81

def is_include_new_items_in_filter
  @is_include_new_items_in_filter
end

#is_insert_page_breaks_between_itemsObject

Returns the value of attribute is_insert_page_breaks_between_items.



83
84
85
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 83

def is_insert_page_breaks_between_items
  @is_insert_page_breaks_between_items
end

#is_multiple_item_selection_allowedObject

Returns the value of attribute is_multiple_item_selection_allowed.



85
86
87
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 85

def is_multiple_item_selection_allowed
  @is_multiple_item_selection_allowed
end

#is_repeat_item_labelsObject

Returns the value of attribute is_repeat_item_labels.



87
88
89
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 87

def is_repeat_item_labels
  @is_repeat_item_labels
end

#item_countObject

Returns the value of attribute item_count.



89
90
91
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 89

def item_count
  @item_count
end

#itemsObject

Returns the value of attribute items.



91
92
93
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 91

def items
  @items
end

#nameObject

Returns the value of attribute name.



93
94
95
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 93

def name
  @name
end

#numberObject

Returns the value of attribute number.



95
96
97
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 95

def number
  @number
end

#number_formatObject

Returns the value of attribute number_format.



97
98
99
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 97

def number_format
  @number_format
end

#original_itemsObject

Returns the value of attribute original_items.



99
100
101
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 99

def original_items
  @original_items
end

#pivot_itemsObject

Returns the value of attribute pivot_items.



101
102
103
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 101

def pivot_items
  @pivot_items
end

#positionObject

Returns the value of attribute position.



103
104
105
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 103

def position
  @position
end

#show_all_itemsObject

Returns the value of attribute show_all_items.



105
106
107
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 105

def show_all_items
  @show_all_items
end

#show_compactObject

Returns the value of attribute show_compact.



107
108
109
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 107

def show_compact
  @show_compact
end

#show_in_outline_formObject

Returns the value of attribute show_in_outline_form.



109
110
111
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 109

def show_in_outline_form
  @show_in_outline_form
end

#show_subtotal_at_topObject

Returns the value of attribute show_subtotal_at_top.



111
112
113
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 111

def show_subtotal_at_top
  @show_subtotal_at_top
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 114

def self.attribute_map
  {
    :'auto_show_count' => :'AutoShowCount',
    :'auto_show_field' => :'AutoShowField',
    :'auto_sort_field' => :'AutoSortField',
    :'base_field' => :'BaseField',
    :'base_index' => :'BaseIndex',
    :'base_item' => :'BaseItem',
    :'base_item_position' => :'BaseItemPosition',
    :'current_page_item' => :'CurrentPageItem',
    :'data_display_format' => :'DataDisplayFormat',
    :'display_name' => :'DisplayName',
    :'drag_to_column' => :'DragToColumn',
    :'drag_to_data' => :'DragToData',
    :'drag_to_hide' => :'DragToHide',
    :'drag_to_page' => :'DragToPage',
    :'drag_to_row' => :'DragToRow',
    :'function' => :'Function',
    :'insert_blank_row' => :'InsertBlankRow',
    :'is_ascend_show' => :'IsAscendShow',
    :'is_ascend_sort' => :'IsAscendSort',
    :'is_auto_show' => :'IsAutoShow',
    :'is_auto_sort' => :'IsAutoSort',
    :'is_auto_subtotals' => :'IsAutoSubtotals',
    :'is_calculated_field' => :'IsCalculatedField',
    :'is_include_new_items_in_filter' => :'IsIncludeNewItemsInFilter',
    :'is_insert_page_breaks_between_items' => :'IsInsertPageBreaksBetweenItems',
    :'is_multiple_item_selection_allowed' => :'IsMultipleItemSelectionAllowed',
    :'is_repeat_item_labels' => :'IsRepeatItemLabels',
    :'item_count' => :'ItemCount',
    :'items' => :'Items',
    :'name' => :'Name',
    :'number' => :'Number',
    :'number_format' => :'NumberFormat',
    :'original_items' => :'OriginalItems',
    :'pivot_items' => :'PivotItems',
    :'position' => :'Position',
    :'show_all_items' => :'ShowAllItems',
    :'show_compact' => :'ShowCompact',
    :'show_in_outline_form' => :'ShowInOutlineForm',
    :'show_subtotal_at_top' => :'ShowSubtotalAtTop'
  }
end

.swagger_typesObject

Attribute type mapping.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 159

def self.swagger_types
  {
    :'auto_show_count' => :'Integer',
    :'auto_show_field' => :'Integer',
    :'auto_sort_field' => :'Integer',
    :'base_field' => :'Integer',
    :'base_index' => :'Integer',
    :'base_item' => :'Integer',
    :'base_item_position' => :'String',
    :'current_page_item' => :'Integer',
    :'data_display_format' => :'String',
    :'display_name' => :'String',
    :'drag_to_column' => :'BOOLEAN',
    :'drag_to_data' => :'BOOLEAN',
    :'drag_to_hide' => :'BOOLEAN',
    :'drag_to_page' => :'BOOLEAN',
    :'drag_to_row' => :'BOOLEAN',
    :'function' => :'String',
    :'insert_blank_row' => :'BOOLEAN',
    :'is_ascend_show' => :'BOOLEAN',
    :'is_ascend_sort' => :'BOOLEAN',
    :'is_auto_show' => :'BOOLEAN',
    :'is_auto_sort' => :'BOOLEAN',
    :'is_auto_subtotals' => :'BOOLEAN',
    :'is_calculated_field' => :'BOOLEAN',
    :'is_include_new_items_in_filter' => :'BOOLEAN',
    :'is_insert_page_breaks_between_items' => :'BOOLEAN',
    :'is_multiple_item_selection_allowed' => :'BOOLEAN',
    :'is_repeat_item_labels' => :'BOOLEAN',
    :'item_count' => :'Integer',
    :'items' => :'Array<String>',
    :'name' => :'String',
    :'number' => :'Integer',
    :'number_format' => :'String',
    :'original_items' => :'Array<String>',
    :'pivot_items' => :'Array<PivotItem>',
    :'position' => :'Integer',
    :'show_all_items' => :'BOOLEAN',
    :'show_compact' => :'BOOLEAN',
    :'show_in_outline_form' => :'BOOLEAN',
    :'show_subtotal_at_top' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 503

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_show_count == o.auto_show_count &&
      auto_show_field == o.auto_show_field &&
      auto_sort_field == o.auto_sort_field &&
      base_field == o.base_field &&
      base_index == o.base_index &&
      base_item == o.base_item &&
      base_item_position == o.base_item_position &&
      current_page_item == o.current_page_item &&
      data_display_format == o.data_display_format &&
      display_name == o.display_name &&
      drag_to_column == o.drag_to_column &&
      drag_to_data == o.drag_to_data &&
      drag_to_hide == o.drag_to_hide &&
      drag_to_page == o.drag_to_page &&
      drag_to_row == o.drag_to_row &&
      function == o.function &&
      insert_blank_row == o.insert_blank_row &&
      is_ascend_show == o.is_ascend_show &&
      is_ascend_sort == o.is_ascend_sort &&
      is_auto_show == o.is_auto_show &&
      is_auto_sort == o.is_auto_sort &&
      is_auto_subtotals == o.is_auto_subtotals &&
      is_calculated_field == o.is_calculated_field &&
      is_include_new_items_in_filter == o.is_include_new_items_in_filter &&
      is_insert_page_breaks_between_items == o.is_insert_page_breaks_between_items &&
      is_multiple_item_selection_allowed == o.is_multiple_item_selection_allowed &&
      is_repeat_item_labels == o.is_repeat_item_labels &&
      item_count == o.item_count &&
      items == o.items &&
      name == o.name &&
      number == o.number &&
      number_format == o.number_format &&
      original_items == o.original_items &&
      pivot_items == o.pivot_items &&
      position == o.position &&
      show_all_items == o.show_all_items &&
      show_compact == o.show_compact &&
      show_in_outline_form == o.show_in_outline_form &&
      show_subtotal_at_top == o.show_subtotal_at_top 
      std_dev == o.std_dev
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 584

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



650
651
652
653
654
655
656
657
658
659
660
661
662
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 650

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 563

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


550
551
552
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 550

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



556
557
558
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 556

def hash
  [ auto_show_count , auto_show_field , auto_sort_field , base_field , base_index , base_item , base_item_position , current_page_item , data_display_format , display_name , drag_to_column , drag_to_data , drag_to_hide , drag_to_page , drag_to_row , function , insert_blank_row , is_ascend_show , is_ascend_sort , is_auto_show , is_auto_sort , is_auto_subtotals , is_calculated_field , is_include_new_items_in_filter , is_insert_page_breaks_between_items , is_multiple_item_selection_allowed , is_repeat_item_labels , item_count , items , name , number , number_format , original_items , pivot_items , position , show_all_items , show_compact , show_in_outline_form , show_subtotal_at_top ].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 333

def list_invalid_properties
  invalid_properties = Array.new
  if @auto_show_count.nil?
      invalid_properties.push("invalid value for 'auto_show_count', auto_show_count cannot be nil.")
  end
  if @auto_show_field.nil?
      invalid_properties.push("invalid value for 'auto_show_field', auto_show_field cannot be nil.")
  end
  if @auto_sort_field.nil?
      invalid_properties.push("invalid value for 'auto_sort_field', auto_sort_field cannot be nil.")
  end
  if @base_field.nil?
      invalid_properties.push("invalid value for 'base_field', base_field cannot be nil.")
  end
  if @base_index.nil?
      invalid_properties.push("invalid value for 'base_index', base_index cannot be nil.")
  end
  if @base_item.nil?
      invalid_properties.push("invalid value for 'base_item', base_item cannot be nil.")
  end
  if @base_item_position.nil?
      invalid_properties.push("invalid value for 'base_item_position', base_item_position cannot be nil.")
  end
  if @current_page_item.nil?
      invalid_properties.push("invalid value for 'current_page_item', current_page_item cannot be nil.")
  end
  if @data_display_format.nil?
      invalid_properties.push("invalid value for 'data_display_format', data_display_format cannot be nil.")
  end
  if @display_name.nil?
      invalid_properties.push("invalid value for 'display_name', display_name cannot be nil.")
  end
  if @drag_to_column.nil?
      invalid_properties.push("invalid value for 'drag_to_column', drag_to_column cannot be nil.")
  end
  if @drag_to_data.nil?
      invalid_properties.push("invalid value for 'drag_to_data', drag_to_data cannot be nil.")
  end
  if @drag_to_hide.nil?
      invalid_properties.push("invalid value for 'drag_to_hide', drag_to_hide cannot be nil.")
  end
  if @drag_to_page.nil?
      invalid_properties.push("invalid value for 'drag_to_page', drag_to_page cannot be nil.")
  end
  if @drag_to_row.nil?
      invalid_properties.push("invalid value for 'drag_to_row', drag_to_row cannot be nil.")
  end
  if @function.nil?
      invalid_properties.push("invalid value for 'function', function cannot be nil.")
  end
  if @insert_blank_row.nil?
      invalid_properties.push("invalid value for 'insert_blank_row', insert_blank_row cannot be nil.")
  end
  if @is_ascend_show.nil?
      invalid_properties.push("invalid value for 'is_ascend_show', is_ascend_show cannot be nil.")
  end
  if @is_ascend_sort.nil?
      invalid_properties.push("invalid value for 'is_ascend_sort', is_ascend_sort cannot be nil.")
  end
  if @is_auto_show.nil?
      invalid_properties.push("invalid value for 'is_auto_show', is_auto_show cannot be nil.")
  end
  if @is_auto_sort.nil?
      invalid_properties.push("invalid value for 'is_auto_sort', is_auto_sort cannot be nil.")
  end
  if @is_auto_subtotals.nil?
      invalid_properties.push("invalid value for 'is_auto_subtotals', is_auto_subtotals cannot be nil.")
  end
  if @is_calculated_field.nil?
      invalid_properties.push("invalid value for 'is_calculated_field', is_calculated_field cannot be nil.")
  end
  if @is_include_new_items_in_filter.nil?
      invalid_properties.push("invalid value for 'is_include_new_items_in_filter', is_include_new_items_in_filter cannot be nil.")
  end
  if @is_insert_page_breaks_between_items.nil?
      invalid_properties.push("invalid value for 'is_insert_page_breaks_between_items', is_insert_page_breaks_between_items cannot be nil.")
  end
  if @is_multiple_item_selection_allowed.nil?
      invalid_properties.push("invalid value for 'is_multiple_item_selection_allowed', is_multiple_item_selection_allowed cannot be nil.")
  end
  if @is_repeat_item_labels.nil?
      invalid_properties.push("invalid value for 'is_repeat_item_labels', is_repeat_item_labels cannot be nil.")
  end
  if @item_count.nil?
      invalid_properties.push("invalid value for 'item_count', item_count cannot be nil.")
  end
  if @items.nil?
      invalid_properties.push("invalid value for 'items', items cannot be nil.")
  end
  if @name.nil?
      invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end
  if @number.nil?
      invalid_properties.push("invalid value for 'number', number cannot be nil.")
  end
  if @number_format.nil?
      invalid_properties.push("invalid value for 'number_format', number_format cannot be nil.")
  end
  if @original_items.nil?
      invalid_properties.push("invalid value for 'original_items', original_items cannot be nil.")
  end
  if @pivot_items.nil?
      invalid_properties.push("invalid value for 'pivot_items', pivot_items cannot be nil.")
  end
  if @position.nil?
      invalid_properties.push("invalid value for 'position', position cannot be nil.")
  end
  if @show_all_items.nil?
      invalid_properties.push("invalid value for 'show_all_items', show_all_items cannot be nil.")
  end
  if @show_compact.nil?
      invalid_properties.push("invalid value for 'show_compact', show_compact cannot be nil.")
  end
  if @show_in_outline_form.nil?
      invalid_properties.push("invalid value for 'show_in_outline_form', show_in_outline_form cannot be nil.")
  end
  if @show_subtotal_at_top.nil?
      invalid_properties.push("invalid value for 'show_subtotal_at_top', show_subtotal_at_top cannot be nil.")
  end

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



630
631
632
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 630

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



636
637
638
639
640
641
642
643
644
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 636

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



624
625
626
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 624

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/aspose_cells_cloud/models/pivot_field.rb', line 458

def valid?
  return false if @auto_show_count.nil?
  return false if @auto_show_field.nil?
  return false if @auto_sort_field.nil?
  return false if @base_field.nil?
  return false if @base_index.nil?
  return false if @base_item.nil?
  return false if @base_item_position.nil?
  return false if @current_page_item.nil?
  return false if @data_display_format.nil?
  return false if @display_name.nil?
  return false if @drag_to_column.nil?
  return false if @drag_to_data.nil?
  return false if @drag_to_hide.nil?
  return false if @drag_to_page.nil?
  return false if @drag_to_row.nil?
  return false if @function.nil?
  return false if @insert_blank_row.nil?
  return false if @is_ascend_show.nil?
  return false if @is_ascend_sort.nil?
  return false if @is_auto_show.nil?
  return false if @is_auto_sort.nil?
  return false if @is_auto_subtotals.nil?
  return false if @is_calculated_field.nil?
  return false if @is_include_new_items_in_filter.nil?
  return false if @is_insert_page_breaks_between_items.nil?
  return false if @is_multiple_item_selection_allowed.nil?
  return false if @is_repeat_item_labels.nil?
  return false if @item_count.nil?
  return false if @items.nil?
  return false if @name.nil?
  return false if @number.nil?
  return false if @number_format.nil?
  return false if @original_items.nil?
  return false if @pivot_items.nil?
  return false if @position.nil?
  return false if @show_all_items.nil?
  return false if @show_compact.nil?
  return false if @show_in_outline_form.nil?
  return false if @show_subtotal_at_top.nil?
  return true
end