aspose_cells_cloud 23.8 → 23.10

data/lib/aspose_cells_cloud/models/range.rb

@@ -31,23 +31,23 @@ require 'date'
 module AsposeCellsCloud
 
   class Range
-        #Gets the count of columns in the range.            
+        #Gets the count of columns in the range.             
         attr_accessor :column_count
-        #Sets or gets the column width of this range            
+        #Sets or gets the column width of this range             
         attr_accessor :column_width
-        #Gets the index of the first column of the range.            
+        #Gets the index of the first column of the range.             
         attr_accessor :first_column
-        #Gets the index of the first row of the range.            
+        #Gets the index of the first row of the range.             
         attr_accessor :first_row
-        #Gets or sets the name of the range.            
+        #Gets or sets the name of the range.             
         attr_accessor :name
-        #Gets the range's refers to.            
+        #Gets the range's refers to.             
         attr_accessor :refers_to
-        #Gets the count of rows in the range.            
+        #Gets the count of rows in the range.             
         attr_accessor :row_count
-        #Sets or gets the height of rows in this range            
+        #Sets or gets the height of rows in this range             
         attr_accessor :row_height
-        #Gets the Aspose.Cells.Range.Worksheetobject which contains this range.            
+        #Gets the object which contains this range.             
         attr_accessor :worksheet
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/range_copy_request.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class RangeCopyRequest
-        #            
+        #copydata, copystyle, copyto, copyvalue.            
         attr_accessor :operate
-        #            
+        #Source range.             
         attr_accessor :source
-        #            
+        #Target range.            
         attr_accessor :target
-        #            
+        #Represents the paste special options.                        
         attr_accessor :paste_options
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/range_set_outline_border_request.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class RangeSetOutlineBorderRequest
-        #            
+        #Encapsulates the object that represents a range of cells within a spreadsheet.            
         attr_accessor :range
-        #            
+        #LeftBorder, RightBorder, TopBorder, BottomBorder, DiagonalDown, DiagonalUp, Vertical and Horizontal.            
         attr_accessor :border_edge
-        #            
+        #None, Thin, Medium, Dashed, Dotted, Thick, Double, Hair, MediumDashed, DashDot, MediumDashDot, DashDotDot, MediumDashDotDot and SlantedDashDot.            
         attr_accessor :border_style
-        #            
+        #Border color.            
         attr_accessor :border_color
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/range_set_style_request.rb

@@ -31,9 +31,9 @@ require 'date'
 module AsposeCellsCloud
 
   class RangeSetStyleRequest
-        #            
+        #Encapsulates the object that represents a range of cells within a spreadsheet.            
         attr_accessor :range
-        #            
+        #Represents display style of excel document,such as font,color,alignment,border,etc.                        
         attr_accessor :style
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/range_sort_request.rb

@@ -0,0 +1,222 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="RangeSortRequestrb.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 RangeSortRequest
+        #Summary description for DataSorter.            
+        attr_accessor :data_sorter
+        #Encapsulates the object that represents a range of cells within a spreadsheet.            
+        attr_accessor :cell_area
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data_sorter' => :'DataSorter',
+        :'cell_area' => :'CellArea'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data_sorter' => :'DataSorter',
+        :'cell_area' => :'Range'
+      }
+    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?(:'DataSorter')
+          self.data_sorter = attributes[:'DataSorter']
+      end
+      if attributes.has_key?(:'CellArea')
+          self.cell_area = attributes[:'CellArea']
+      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 @data_sorter.nil?
+          invalid_properties.push("invalid value for 'data_sorter', data_sorter cannot be nil.")
+      end
+      if @cell_area.nil?
+          invalid_properties.push("invalid value for 'cell_area', cell_area 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 @data_sorter.nil?
+      return false if @cell_area.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 &&
+          data_sorter == o.data_sorter &&
+          cell_area == o.cell_area 
+          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
+      [ data_sorter , cell_area ].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/row.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class Row
-        #            
+        #Gets the group level of the row.            
         attr_accessor :group_level
-        #            
+        #Gets and sets the row height in unit of Points.            
         attr_accessor :height
-        #            
+        #Gets the index of this row.            
         attr_accessor :index
-        #            
+        #Indicates whether the row contains any data            
         attr_accessor :is_blank
-        #            
+        #Indicates that row height and default font height matches.            
         attr_accessor :is_height_matched
-        #            
+        #Indicates whether the row is hidden.            
         attr_accessor :is_hidden
-        #            
+        #Represents the style of this row.            
         attr_accessor :style
         #            
         attr_accessor :link

data/lib/aspose_cells_cloud/models/save_options.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class SaveOptions
-        #            
+        #Save format name            
         attr_accessor :save_format
         #The cached file folder is used to store some large data.            
         attr_accessor :cached_file_folder
@@ -39,11 +39,11 @@ module AsposeCellsCloud
         attr_accessor :clear_data
         #If true and the directory does not exist, the directory will be automatically created before saving the file.                        
         attr_accessor :create_directory
-        #            
+        #whether http compression is to be used.            
         attr_accessor :enable_http_compression
-        #            
+        #Indicates whether refreshing chart cache data            
         attr_accessor :refresh_chart_cache
-        #            
+        #Indicates whether sorting defined names before saving file.            
         attr_accessor :sort_names
         #Indicates whether validate merged areas before saving the file.The default value is false.                        
         attr_accessor :validate_merged_areas

data/lib/aspose_cells_cloud/models/scroll_bar.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class ScrollBar
-        #            
+        #Gets or sets the current value.            
         attr_accessor :current_value
-        #            
+        #Gets or sets the amount that the scroll bar or spinner is incremented a line scroll.            
         attr_accessor :incremental_change
-        #            
+        #Indicates whether this is a horizontal scroll bar.            
         attr_accessor :is_horizontal
-        #            
+        #Gets or sets the maximum value of a scroll bar or spinner range.            
         attr_accessor :max
-        #            
+        #Gets or sets the minimum value of a scroll bar or spinner range.            
         attr_accessor :min
-        #            
+        #Gets or sets page change            
         attr_accessor :page_change
-        #            
+        #Indicates whether the shape has 3-D shading.            
         attr_accessor :shadow
         #            
         attr_accessor :name

data/lib/aspose_cells_cloud/models/series.rb

@@ -31,101 +31,101 @@ require 'date'
 module AsposeCellsCloud
 
   class Series
-        #            
+        #Represents the background area of Series object.            
         attr_accessor :area
-        #            
+        #Gets or sets the 3D shape type used with the 3-D bar or column chart.            
         attr_accessor :bar3_d_shape_type
-        #            
+        #Represents border of Series object.            
         attr_accessor :border
-        #            
+        #Gets or sets the scale factor for bubbles in the specified chart group.                         It can be an integer value from 0 (zero) to 300,                         corresponding to a percentage of the default size.                        Applies only to bubble charts.            
         attr_accessor :bubble_scale
-        #            
+        #Gets or sets the bubble sizes values of the chart series.            
         attr_accessor :bubble_sizes
-        #            
+        #Gets the number of the data values.            
         attr_accessor :count_of_data_values
-        #            
+        #Represents the DataLabels object for the specified ASeries.            
         attr_accessor :data_labels
-        #            
+        #Gets the series's name that displays on the chart graph.            
         attr_accessor :display_name
-        #            
+        #Returns or sets the size of the hole in a doughnut chart group.                         The hole size is expressed as a percentage of the chart size, between 10 and 90 percent.            
         attr_accessor :doughnut_hole_size
-        #            
+        #Returns a  object that represents the down bars on a line chart.                        Applies only to line charts.            
         attr_accessor :down_bars
-        #            
+        #Returns a  object that represents the drop lines for a series on the line chart or area chart.                        Applies only to line chart or area charts.            
         attr_accessor :drop_lines
-        #            
+        #The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.            
         attr_accessor :explosion
-        #            
+        #Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).                         Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.            
         attr_accessor :first_slice_angle
-        #            
+        #Returns or sets the space between bar or column clusters, as a percentage of the bar or column width.                        The value of this property must be between 0 and 500.            
         attr_accessor :gap_width
-        #            
+        #True if the series has a three-dimensional appearance.                         Applies only to bubble charts.            
         attr_accessor :has3_d_effect
-        #            
+        #True if the chart has drop lines.                        Applies only to line chart or area charts.            
         attr_accessor :has_drop_lines
-        #            
+        #True if the line chart has high-low lines.                          Applies only to line charts.            
         attr_accessor :has_hi_lo_lines
-        #            
+        #True if the series has leader lines.            
         attr_accessor :has_leader_lines
-        #            
+        #True if a radar chart has category axis labels. Applies only to radar charts.            
         attr_accessor :has_radar_axis_labels
-        #            
+        #True if a stacked column chart or bar chart has series lines or                        if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections.                         Applies only to stacked column charts, bar charts, Pie of Pie charts, or Bar of Pie charts.            
         attr_accessor :has_series_lines
-        #            
+        #True if a line chart has up and down bars.                        Applies only to line charts.            
         attr_accessor :has_up_down_bars
-        #            
+        #Returns a HiLoLines object that represents the high-low lines for a series on a line chart.                         Applies only to line charts.            
         attr_accessor :hi_lo_lines
-        #            
+        #Indicates whether the threshold value is automatic.            
         attr_accessor :is_auto_split
-        #            
+        #Represents if the color of points is varied.                         The chart must contain only one series.            
         attr_accessor :is_color_varied
-        #            
+        #Represents leader lines on a chart. Leader lines connect data labels to data points.                         This object isn’t a collection; there’s no object that represents a single leader line.            
         attr_accessor :leader_lines
-        #            
+        #Gets the legend entry according to this series.            
         attr_accessor :legend_entry
         #            
         attr_accessor :line
-        #            
+        #Gets the marker.            
         attr_accessor :marker
-        #            
+        #Gets or sets the name of the data series.            
         attr_accessor :name
-        #            
+        #Specifies how bars and columns are positioned.                        Can be a value between – 100 and 100.                         Applies only to 2-D bar and 2-D column charts.            
         attr_accessor :overlap
-        #            
+        #Indicates if this series is plotted on second value axis.            
         attr_accessor :plot_on_second_axis
-        #            
+        #Gets the collection of points in a series in a chart.            
         attr_accessor :points
-        #            
+        #Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart,                         as a percentage of the size of the primary pie.                        Can be a value from 5 to 200.            
         attr_accessor :second_plot_size
-        #            
+        #Returns a SeriesLines object that represents the series lines for a stacked bar chart or a stacked column chart.                        Applies only to stacked bar and stacked column charts.            
         attr_accessor :series_lines
-        #            
+        #True if the series has a shadow.            
         attr_accessor :shadow
-        #            
+        #Gets the  object that holds the visual shape properties of the Series.            
         attr_accessor :shape_properties
-        #            
+        #True if negative bubbles are shown for the chart group. Valid only for bubble charts.            
         attr_accessor :show_negative_bubbles
-        #            
+        #Gets or sets what the bubble size represents on a bubble chart.            
         attr_accessor :size_represents
-        #            
+        #Represents curve smoothing.                         True if curve smoothing is turned on for the line chart or scatter chart.                        Applies only to line and scatter connected by lines charts.            
         attr_accessor :smooth
-        #            
+        #Returns or sets a value that how to determine which data points are in the second pie or bar on a pie of pie or bar of                        pie chart.            
         attr_accessor :split_type
-        #            
+        #Returns or sets a value that shall be used to determine which data points are in the second pie or bar on                        a pie of pie or bar of pie chart.            
         attr_accessor :split_value
-        #            
+        #Returns an object that represents a collection of all the trendlines for the series.            
         attr_accessor :trend_lines
-        #            
+        #Gets or sets a data series' type.            
         attr_accessor :type
-        #            
+        #Returns an DropBars object that represents the up bars on a line chart.                        Applies only to line charts.            
         attr_accessor :up_bars
-        #            
+        #Represents the data of the chart series.            
         attr_accessor :values
-        #            
+        #Represents X direction error bar of the series.            
         attr_accessor :x_error_bar
-        #            
+        #Represents the x values of the chart series.            
         attr_accessor :x_values
-        #            
+        #Represents Y direction error bar of the series.            
         attr_accessor :y_error_bar
         #            
         attr_accessor :link

data/lib/aspose_cells_cloud/models/shadow_effect.rb

@@ -31,19 +31,19 @@ require 'date'
 module AsposeCellsCloud
 
   class ShadowEffect
-        #            
+        #Gets and sets the lighting angle. Range from 0 to 359.9 degrees.             
         attr_accessor :angle
-        #            
+        #Gets and sets the blur of the shadow. Range from 0 to 100 points.             
         attr_accessor :blur
-        #            
+        #Gets and sets the color of the shadow.             
         attr_accessor :color
-        #            
+        #Gets and sets the distance of the shadow. Range from 0 to 200 points.             
         attr_accessor :distance
-        #            
+        #Gets and sets the preset shadow type of the shadow.             
         attr_accessor :preset_type
-        #            
+        #Gets and sets the size of the shadow. Range from 0 to 2.0.             Meaningless in inner shadow.             
         attr_accessor :size
-        #            
+        #Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).             
         attr_accessor :transparency
 
     # Attribute mapping from ruby-style variable name to JSON key.