aspose_cells_cloud 20.11 → 20.11.1

data/lib/aspose_cells_cloud/models/icon_set.rb

@@ -0,0 +1,253 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2020 Aspose.Cells Cloud
+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.
+--------------------------------------------------------------------------------------------------------------------
+
+=end
+
+require 'date'
+
+module AsposeCellsCloud
+  # Describe the IconSet conditional formatting rule. This conditional formatting     rule applies icons to cells according to their values.
+  class IconSet
+    # Get or set the flag indicating whether to reverses the default order of the   icons in this icon set.  Default value is false.             
+    attr_accessor :reverse
+
+    # Get theAspose.Cells.ConditionalFormattingIcon from the collection
+    attr_accessor :cf_icons
+
+    # Get the CFValueObjects instance.
+    attr_accessor :cfvos
+
+    # Get or Set the icon set type to display.  Setting the type will auto check    if the current Cfvos's count is accord with the new type. If not accord,    old Cfvos will be cleaned and default Cfvos will be added.             
+    attr_accessor :icon_set_type
+
+    # Indicates whether the icon set is custom.  Default value is false.
+    attr_accessor :is_custom
+
+    # Get or set the flag indicating whether to show the values of the cells on    which this icon set is applied.  Default value is true.             
+    attr_accessor :show_value
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reverse' => :'Reverse',
+        :'cf_icons' => :'CfIcons',
+        :'cfvos' => :'Cfvos',
+        :'icon_set_type' => :'IconSetType',
+        :'is_custom' => :'IsCustom',
+        :'show_value' => :'ShowValue'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'reverse' => :'BOOLEAN',
+        :'cf_icons' => :'Array<ConditionalFormattingIcon>',
+        :'cfvos' => :'Array<ConditionalFormattingValue>',
+        :'icon_set_type' => :'String',
+        :'is_custom' => :'BOOLEAN',
+        :'show_value' => :'BOOLEAN'
+      }
+    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?(:'Reverse')
+        self.reverse = attributes[:'Reverse']
+      end
+
+      if attributes.has_key?(:'CfIcons')
+        if (value = attributes[:'CfIcons']).is_a?(Array)
+          self.cf_icons = value
+        end
+      end
+
+      if attributes.has_key?(:'Cfvos')
+        if (value = attributes[:'Cfvos']).is_a?(Array)
+          self.cfvos = value
+        end
+      end
+
+      if attributes.has_key?(:'IconSetType')
+        self.icon_set_type = attributes[:'IconSetType']
+      end
+
+      if attributes.has_key?(:'IsCustom')
+        self.is_custom = attributes[:'IsCustom']
+      end
+
+      if attributes.has_key?(:'ShowValue')
+        self.show_value = attributes[:'ShowValue']
+      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
+      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 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 &&
+          reverse == o.reverse &&
+          cf_icons == o.cf_icons &&
+          cfvos == o.cfvos &&
+          icon_set_type == o.icon_set_type &&
+          is_custom == o.is_custom &&
+          show_value == o.show_value
+    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
+      [reverse, cf_icons, cfvos, icon_set_type, is_custom, show_value].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/image_save_options.rb

@@ -0,0 +1,373 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2020 Aspose.Cells Cloud
+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.
+--------------------------------------------------------------------------------------------------------------------
+
+=end
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class ImageSaveOptions
+    attr_accessor :enable_http_compression
+
+    attr_accessor :save_format
+
+    # Make the workbook empty after saving the file.
+    attr_accessor :clear_data
+
+    # The cached file folder is used to store some large data.
+    attr_accessor :cached_file_folder
+
+    # Indicates whether validate merged areas before saving the file. The default value is false.             
+    attr_accessor :validate_merged_areas
+
+    attr_accessor :refresh_chart_cache
+
+    # If true and the directory does not exist, the directory will be automatically created before saving the file.             
+    attr_accessor :create_directory
+
+    attr_accessor :sort_names
+
+    attr_accessor :chart_image_type
+
+    attr_accessor :embeded_image_name_in_svg
+
+    attr_accessor :horizontal_resolution
+
+    attr_accessor :image_format
+
+    attr_accessor :is_cell_auto_fit
+
+    attr_accessor :one_page_per_sheet
+
+    attr_accessor :only_area
+
+    attr_accessor :printing_page
+
+    attr_accessor :print_with_status_dialog
+
+    attr_accessor :quality
+
+    attr_accessor :tiff_compression
+
+    attr_accessor :vertical_resolution
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enable_http_compression' => :'EnableHTTPCompression',
+        :'save_format' => :'SaveFormat',
+        :'clear_data' => :'ClearData',
+        :'cached_file_folder' => :'CachedFileFolder',
+        :'validate_merged_areas' => :'ValidateMergedAreas',
+        :'refresh_chart_cache' => :'RefreshChartCache',
+        :'create_directory' => :'CreateDirectory',
+        :'sort_names' => :'SortNames',
+        :'chart_image_type' => :'ChartImageType',
+        :'embeded_image_name_in_svg' => :'EmbededImageNameInSvg',
+        :'horizontal_resolution' => :'HorizontalResolution',
+        :'image_format' => :'ImageFormat',
+        :'is_cell_auto_fit' => :'IsCellAutoFit',
+        :'one_page_per_sheet' => :'OnePagePerSheet',
+        :'only_area' => :'OnlyArea',
+        :'printing_page' => :'PrintingPage',
+        :'print_with_status_dialog' => :'PrintWithStatusDialog',
+        :'quality' => :'Quality',
+        :'tiff_compression' => :'TiffCompression',
+        :'vertical_resolution' => :'VerticalResolution'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'enable_http_compression' => :'BOOLEAN',
+        :'save_format' => :'String',
+        :'clear_data' => :'BOOLEAN',
+        :'cached_file_folder' => :'String',
+        :'validate_merged_areas' => :'BOOLEAN',
+        :'refresh_chart_cache' => :'BOOLEAN',
+        :'create_directory' => :'BOOLEAN',
+        :'sort_names' => :'BOOLEAN',
+        :'chart_image_type' => :'String',
+        :'embeded_image_name_in_svg' => :'String',
+        :'horizontal_resolution' => :'Integer',
+        :'image_format' => :'String',
+        :'is_cell_auto_fit' => :'BOOLEAN',
+        :'one_page_per_sheet' => :'BOOLEAN',
+        :'only_area' => :'BOOLEAN',
+        :'printing_page' => :'String',
+        :'print_with_status_dialog' => :'Integer',
+        :'quality' => :'Integer',
+        :'tiff_compression' => :'String',
+        :'vertical_resolution' => :'Integer'
+      }
+    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?(:'EnableHTTPCompression')
+        self.enable_http_compression = attributes[:'EnableHTTPCompression']
+      end
+
+      if attributes.has_key?(:'SaveFormat')
+        self.save_format = attributes[:'SaveFormat']
+      end
+
+      if attributes.has_key?(:'ClearData')
+        self.clear_data = attributes[:'ClearData']
+      end
+
+      if attributes.has_key?(:'CachedFileFolder')
+        self.cached_file_folder = attributes[:'CachedFileFolder']
+      end
+
+      if attributes.has_key?(:'ValidateMergedAreas')
+        self.validate_merged_areas = attributes[:'ValidateMergedAreas']
+      end
+
+      if attributes.has_key?(:'RefreshChartCache')
+        self.refresh_chart_cache = attributes[:'RefreshChartCache']
+      end
+
+      if attributes.has_key?(:'CreateDirectory')
+        self.create_directory = attributes[:'CreateDirectory']
+      end
+
+      if attributes.has_key?(:'SortNames')
+        self.sort_names = attributes[:'SortNames']
+      end
+
+      if attributes.has_key?(:'ChartImageType')
+        self.chart_image_type = attributes[:'ChartImageType']
+      end
+
+      if attributes.has_key?(:'EmbededImageNameInSvg')
+        self.embeded_image_name_in_svg = attributes[:'EmbededImageNameInSvg']
+      end
+
+      if attributes.has_key?(:'HorizontalResolution')
+        self.horizontal_resolution = attributes[:'HorizontalResolution']
+      end
+
+      if attributes.has_key?(:'ImageFormat')
+        self.image_format = attributes[:'ImageFormat']
+      end
+
+      if attributes.has_key?(:'IsCellAutoFit')
+        self.is_cell_auto_fit = attributes[:'IsCellAutoFit']
+      end
+
+      if attributes.has_key?(:'OnePagePerSheet')
+        self.one_page_per_sheet = attributes[:'OnePagePerSheet']
+      end
+
+      if attributes.has_key?(:'OnlyArea')
+        self.only_area = attributes[:'OnlyArea']
+      end
+
+      if attributes.has_key?(:'PrintingPage')
+        self.printing_page = attributes[:'PrintingPage']
+      end
+
+      if attributes.has_key?(:'PrintWithStatusDialog')
+        self.print_with_status_dialog = attributes[:'PrintWithStatusDialog']
+      end
+
+      if attributes.has_key?(:'Quality')
+        self.quality = attributes[:'Quality']
+      end
+
+      if attributes.has_key?(:'TiffCompression')
+        self.tiff_compression = attributes[:'TiffCompression']
+      end
+
+      if attributes.has_key?(:'VerticalResolution')
+        self.vertical_resolution = attributes[:'VerticalResolution']
+      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
+      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 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 &&
+          enable_http_compression == o.enable_http_compression &&
+          save_format == o.save_format &&
+          clear_data == o.clear_data &&
+          cached_file_folder == o.cached_file_folder &&
+          validate_merged_areas == o.validate_merged_areas &&
+          refresh_chart_cache == o.refresh_chart_cache &&
+          create_directory == o.create_directory &&
+          sort_names == o.sort_names &&
+          chart_image_type == o.chart_image_type &&
+          embeded_image_name_in_svg == o.embeded_image_name_in_svg &&
+          horizontal_resolution == o.horizontal_resolution &&
+          image_format == o.image_format &&
+          is_cell_auto_fit == o.is_cell_auto_fit &&
+          one_page_per_sheet == o.one_page_per_sheet &&
+          only_area == o.only_area &&
+          printing_page == o.printing_page &&
+          print_with_status_dialog == o.print_with_status_dialog &&
+          quality == o.quality &&
+          tiff_compression == o.tiff_compression &&
+          vertical_resolution == o.vertical_resolution
+    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
+      [enable_http_compression, save_format, clear_data, cached_file_folder, validate_merged_areas, refresh_chart_cache, create_directory, sort_names, chart_image_type, embeded_image_name_in_svg, horizontal_resolution, image_format, is_cell_auto_fit, one_page_per_sheet, only_area, printing_page, print_with_status_dialog, quality, tiff_compression, vertical_resolution].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