aspose_cells_cloud 23.9 → 23.10

data/lib/aspose_cells_cloud/models/data_sorter.rb

@@ -31,16 +31,18 @@ require 'date'
 module AsposeCellsCloud
 
   class DataSorter
-        #            
+        #Gets and sets whether case sensitive when comparing string.             
         attr_accessor :case_sensitive
-        #            
+        #Represents whether the range has headers.             
         attr_accessor :has_headers
-        #            
+        #Gets the key list of data sorter.                        
         attr_accessor :key_list
-        #            
+        #True means that sorting orientation is from left to right.            False means that sorting orientation is from top to bottom.            The default value is false.             
         attr_accessor :sort_left_to_right
-        #            
+        #Indicates whether sorting anything that looks like a number.             
         attr_accessor :sort_as_number
+        #Gets the key list of data sorter.             
+        attr_accessor :keys
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -49,7 +51,8 @@ module AsposeCellsCloud
         :'has_headers' => :'HasHeaders',
         :'key_list' => :'KeyList',
         :'sort_left_to_right' => :'SortLeftToRight',
-        :'sort_as_number' => :'SortAsNumber'
+        :'sort_as_number' => :'SortAsNumber',
+        :'keys' => :'Keys'
       }
     end
 
@@ -60,7 +63,8 @@ module AsposeCellsCloud
         :'has_headers' => :'BOOLEAN',
         :'key_list' => :'Array<SortKey>',
         :'sort_left_to_right' => :'BOOLEAN',
-        :'sort_as_number' => :'BOOLEAN'
+        :'sort_as_number' => :'BOOLEAN',
+        :'keys' => :'Array<DataSorterKey>'
       }
     end
 
@@ -87,6 +91,9 @@ module AsposeCellsCloud
       if attributes.has_key?(:'SortAsNumber')
           self.sort_as_number = attributes[:'SortAsNumber']
       end
+      if attributes.has_key?(:'Keys')
+          self.keys = attributes[:'Keys']
+      end
 
     end
 
@@ -109,6 +116,9 @@ module AsposeCellsCloud
       if @sort_as_number.nil?
           invalid_properties.push("invalid value for 'sort_as_number', sort_as_number cannot be nil.")
       end
+      if @keys.nil?
+          invalid_properties.push("invalid value for 'keys', keys cannot be nil.")
+      end
 
       return invalid_properties
     end
@@ -121,6 +131,7 @@ module AsposeCellsCloud
       return false if @key_list.nil?
       return false if @sort_left_to_right.nil?
       return false if @sort_as_number.nil?
+      return false if @keys.nil?
       return true
     end
 
@@ -133,7 +144,8 @@ module AsposeCellsCloud
           has_headers == o.has_headers &&
           key_list == o.key_list &&
           sort_left_to_right == o.sort_left_to_right &&
-          sort_as_number == o.sort_as_number 
+          sort_as_number == o.sort_as_number &&
+          keys == o.keys 
           std_dev == o.std_dev
     end
 
@@ -146,7 +158,7 @@ module AsposeCellsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ case_sensitive , has_headers , key_list , sort_left_to_right , sort_as_number ].hash
+      [ case_sensitive , has_headers , key_list , sort_left_to_right , sort_as_number , keys ].hash
     end
 
     # Builds the object from hash

data/lib/aspose_cells_cloud/models/data_sorter_key.rb

@@ -0,0 +1,270 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="DataSorterKeyrb.cs">
+   Copyright (c) 2023 Aspose.Cells Cloud
+ </copyright>
+ <summary>
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+ </summary>
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class DataSorterKey
+        #Indicates the order of sorting.             
+        attr_accessor :order
+        #Gets the sorted column index(absolute position, column A is 0, B is 1, ...).             
+        attr_accessor :index
+        #Represents the type of sorting.             
+        attr_accessor :type
+        #Represents the icon set type.             
+        attr_accessor :icon_set_type
+        #Represents the id of the icon set type.             
+        attr_accessor :icon_id
+        #Gets the sorted color.             
+        attr_accessor :color
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'order' => :'Order',
+        :'index' => :'Index',
+        :'type' => :'Type',
+        :'icon_set_type' => :'IconSetType',
+        :'icon_id' => :'IconId',
+        :'color' => :'Color'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'order' => :'String',
+        :'index' => :'Integer',
+        :'type' => :'String',
+        :'icon_set_type' => :'String',
+        :'icon_id' => :'Integer',
+        :'color' => :'Color'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'Order')
+          self.order = attributes[:'Order']
+      end
+      if attributes.has_key?(:'Index')
+          self.index = attributes[:'Index']
+      end
+      if attributes.has_key?(:'Type')
+          self.type = attributes[:'Type']
+      end
+      if attributes.has_key?(:'IconSetType')
+          self.icon_set_type = attributes[:'IconSetType']
+      end
+      if attributes.has_key?(:'IconId')
+          self.icon_id = attributes[:'IconId']
+      end
+      if attributes.has_key?(:'Color')
+          self.color = attributes[:'Color']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @order.nil?
+          invalid_properties.push("invalid value for 'order', order cannot be nil.")
+      end
+      if @index.nil?
+          invalid_properties.push("invalid value for 'index', index cannot be nil.")
+      end
+      if @type.nil?
+          invalid_properties.push("invalid value for 'type', type cannot be nil.")
+      end
+      if @icon_set_type.nil?
+          invalid_properties.push("invalid value for 'icon_set_type', icon_set_type cannot be nil.")
+      end
+      if @icon_id.nil?
+          invalid_properties.push("invalid value for 'icon_id', icon_id cannot be nil.")
+      end
+      if @color.nil?
+          invalid_properties.push("invalid value for 'color', color cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @order.nil?
+      return false if @index.nil?
+      return false if @type.nil?
+      return false if @icon_set_type.nil?
+      return false if @icon_id.nil?
+      return false if @color.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          order == o.order &&
+          index == o.index &&
+          type == o.type &&
+          icon_set_type == o.icon_set_type &&
+          icon_id == o.icon_id &&
+          color == o.color 
+          std_dev == o.std_dev
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [ order , index , type , icon_set_type , icon_id , color ].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+
+end

data/lib/aspose_cells_cloud/models/date_time_group_item.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class DateTimeGroupItem
-        #            
+        #Gets and sets the group type.            
         attr_accessor :date_time_grouping_type
-        #            
+        #Gets and sets the day of the grouped date time.            
         attr_accessor :day
-        #            
+        #Gets and sets the hour of the grouped date time.            
         attr_accessor :hour
-        #            
+        #Gets and sets the minute of the grouped date time.            
         attr_accessor :minute
-        #            
+        #Gets and sets the month of the grouped date time.            
         attr_accessor :month
-        #            
+        #Gets and sets the second of the grouped date time.            
         attr_accessor :second
-        #            
+        #Gets and sets the year of the grouped date time.            
         attr_accessor :year
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/digital_signature.rb

@@ -31,21 +31,21 @@ require 'date'
 module AsposeCellsCloud
 
   class DigitalSignature
-        #            
+        #The purpose to signature.            
         attr_accessor :comments
-        #            
+        #The time when the document was signed.            
         attr_accessor :sign_time
-        #            
+        #Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content. Default value is Empty (all zeroes) Guid.            
         attr_accessor :id
-        #            
+        #Specifies the text of actual signature in the digital signature. Default value is Empty.                        
         attr_accessor :password
-        #            
+        #Specifies an image for the digital signature. Default value is null.            
         attr_accessor :image
-        #            
+        #Specifies the class ID of the signature provider. Default value is Empty (all zeroes) Guid.                        
         attr_accessor :provider_id
-        #            
+        #If this digital signature is valid and the document has not been tampered with, this value will be true.            
         attr_accessor :is_valid
-        #            
+        #XAdES type. Default value is None(XAdES is off).            
         attr_accessor :x_ad_es_type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/display_unit_label.rb

@@ -35,7 +35,7 @@ module AsposeCellsCloud
         attr_accessor :linked_source
         #            
         attr_accessor :rotation_angle
-        #            
+        #Gets or sets the text of display unit label.            
         attr_accessor :text
         #            
         attr_accessor :text_direction

data/lib/aspose_cells_cloud/models/drop_bars.rb

@@ -31,9 +31,9 @@ require 'date'
 module AsposeCellsCloud
 
   class DropBars
-        #            
+        #Gets the .            
         attr_accessor :area
-        #            
+        #Gets the border .            
         attr_accessor :border
         #            
         attr_accessor :link

data/lib/aspose_cells_cloud/models/dynamic_filter.rb

@@ -31,11 +31,11 @@ require 'date'
 module AsposeCellsCloud
 
   class DynamicFilter
-        #            
+        #Gets and sets the dynamic filter type.             
         attr_accessor :dynamic_filter_type
-        #            
+        #Gets and sets the dynamic filter max value.             
         attr_accessor :max_value
-        #            
+        #Gets and sets the dynamic filter value.             
         attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/error_bar.rb

@@ -33,17 +33,17 @@ module AsposeCellsCloud
   class ErrorBar
         #            
         attr_accessor :link
-        #            
+        #Represents amount of error bar.                         The amount must be greater than or equal to zero.            
         attr_accessor :amount
-        #            
+        #Represents error bar display type.            
         attr_accessor :display_type
-        #            
+        #Represents negative error amount when error bar type is Custom.            
         attr_accessor :minus_value
-        #            
+        #Represents positive error amount when error bar type is Custom.            
         attr_accessor :plus_value
-        #            
+        #Indicates if formatting error bars with a T-top.            
         attr_accessor :show_marker_t_top
-        #            
+        #Represents error bar amount type.            
         attr_accessor :type
         #            
         attr_accessor :begin_arrow_length

data/lib/aspose_cells_cloud/models/fill_format.rb

@@ -31,17 +31,17 @@ require 'date'
 module AsposeCellsCloud
 
   class FillFormat
-        #            
+        #Gets and sets the fill type.             
         attr_accessor :type
-        #            
+        #Gets  object.             
         attr_accessor :solid_fill
-        #            
+        #Gets  object.             
         attr_accessor :pattern_fill
-        #            
+        #Gets  object.             
         attr_accessor :texture_fill
-        #            
+        #Gets  object.             
         attr_accessor :gradient_fill
-        #            
+        #Gets and sets the picture image data.             
         attr_accessor :image_data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/filter_column.rb

@@ -31,9 +31,9 @@ require 'date'
 module AsposeCellsCloud
 
   class FilterColumn
-        #            
+        #Gets and sets the column offset in the range.             
         attr_accessor :field_index
-        #            
+        #Gets and sets the type fo filtering data.             
         attr_accessor :filter_type
         #            
         attr_accessor :multiple_filters
@@ -47,7 +47,7 @@ module AsposeCellsCloud
         attr_accessor :icon_filter
         #            
         attr_accessor :top10_filter
-        #            
+        #Indicates whether the AutoFilter button for this column is visible.             
         attr_accessor :visibledropdown
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/floor.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class Floor
-        #            
+        #Gets or sets the border .            
         attr_accessor :border
         #            
         attr_accessor :background_color

data/lib/aspose_cells_cloud/models/font.rb

@@ -31,25 +31,25 @@ require 'date'
 module AsposeCellsCloud
 
   class Font
-        #            
+        #Gets or sets the  of the font.             
         attr_accessor :color
-        #            
+        #Gets and sets the double size of the font.             
         attr_accessor :double_size
-        #            
+        #Gets or sets a value indicating whether the font is bold.             
         attr_accessor :is_bold
-        #            
+        #Gets or sets a value indicating whether the font is italic.             
         attr_accessor :is_italic
-        #            
+        #Gets or sets a value indicating whether the font is single strikeout.             
         attr_accessor :is_strikeout
-        #            
+        #Gets or sets a value indicating whether the font is subscript.             
         attr_accessor :is_subscript
-        #            
+        #Gets or sets a value indicating whether the font is super script.             
         attr_accessor :is_superscript
-        #            
+        #Gets  or sets the name of the .             
         attr_accessor :name
-        #            
+        #Gets or sets the size of the font.             
         attr_accessor :size
-        #            
+        #Gets or sets the font underline type.             
         attr_accessor :underline
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/font_setting.rb

@@ -31,15 +31,15 @@ require 'date'
 module AsposeCellsCloud
 
   class FontSetting
-        #            
+        #Returns the font of this object.             
         attr_accessor :font
-        #            
+        #Gets the length of the characters.             
         attr_accessor :length
-        #            
+        #Gets the start index of the characters.             
         attr_accessor :start_index
-        #            
+        #Returns the text options.             
         attr_accessor :text_options
-        #            
+        #Gets the type of text node.             
         attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/format_condition.rb

@@ -31,33 +31,33 @@ require 'date'
 module AsposeCellsCloud
 
   class FormatCondition
-        #            
+        #The priority of this conditional formatting rule. This value is used to determine which                        format should be evaluated and rendered. Lower numeric values are higher priority than                        higher numeric values, where '1' is the highest priority.            
         attr_accessor :priority
-        #            
+        #Gets and sets whether the conditional format Type.            
         attr_accessor :type
-        #            
+        #True, no rules with lower priority may be applied over this rule, when this rule evaluates to true.                        Only applies for Excel 2007;            
         attr_accessor :stop_if_true
-        #            
+        #Get the conditional formatting's "AboveAverage" instance.                        The default instance's rule highlights cells that are                         above the average for all values in the range.                        Valid only for type = AboveAverage.            
         attr_accessor :above_average
-        #            
+        #Get the conditional formatting's "ColorScale" instance.                        The default instance is a "green-yellow-red" 3ColorScale .                        Valid only for type = ColorScale.            
         attr_accessor :color_scale
-        #            
+        #Get the conditional formatting's "DataBar" instance.                        The default instance's color is blue.                        Valid only for type is DataBar.            
         attr_accessor :data_bar
-        #            
+        #Gets and sets the value or expression associated with conditional formatting.            
         attr_accessor :formula1
-        #            
+        #Gets and sets the value or expression associated with conditional formatting.            
         attr_accessor :formula2
-        #            
+        #Get the conditional formatting's "IconSet" instance.                        The default instance's IconSetType is TrafficLights31.                        Valid only for type = IconSet.            
         attr_accessor :icon_set
-        #            
+        #Gets and sets the conditional format operator type.            
         attr_accessor :operator
-        #            
+        #Gets or setts style of conditional formatted cell ranges.            
         attr_accessor :style
-        #            
+        #The text value in a "text contains" conditional formatting rule.                         Valid only for type = containsText, notContainsText, beginsWith and endsWith.                        The default value is null.            
         attr_accessor :text
-        #            
+        #The applicable time period in a "date occurring…" conditional formatting rule.                         Valid only for type = timePeriod.                        The default value is TimePeriodType.Today.            
         attr_accessor :time_period
-        #            
+        #Get the conditional formatting's "Top10" instance.                        The default instance's rule highlights cells whose                        values fall in the top 10 bracket.                        Valid only for type is Top10.            
         attr_accessor :top10
         #            
         attr_accessor :link

data/lib/aspose_cells_cloud/models/formula_format_condition.rb

@@ -31,11 +31,11 @@ require 'date'
 module AsposeCellsCloud
 
   class FormulaFormatCondition
-        #            
+        #Gets and sets the value or expression associated with conditional formatting.            
         attr_accessor :formula1
-        #            
+        #Gets and sets the value or expression associated with conditional formatting.            
         attr_accessor :formula2
-        #            
+        #Gets and sets the conditional format operator type.            
         attr_accessor :operator
 
     # Attribute mapping from ruby-style variable name to JSON key.