Class: AsposeSlidesCloud::Legend

Inherits:
BaseObject show all
Defined in:
lib/aspose_slides_cloud/models/legend.rb

Overview

Represents a chart legend

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Legend

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 92

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?(:'Position')
    self.position = attributes[:'Position']
  end

  if attributes.has_key?(:'X')
    self.x = attributes[:'X']
  end

  if attributes.has_key?(:'Y')
    self.y = attributes[:'Y']
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.has_key?(:'Overlay')
    self.overlay = attributes[:'Overlay']
  end

  if attributes.has_key?(:'FillFormat')
    self.fill_format = attributes[:'FillFormat']
  end

  if attributes.has_key?(:'EffectFormat')
    self.effect_format = attributes[:'EffectFormat']
  end

  if attributes.has_key?(:'LineFormat')
    self.line_format = attributes[:'LineFormat']
  end

  if attributes.has_key?(:'HasLegend')
    self.has_legend = attributes[:'HasLegend']
  end
end

Instance Attribute Details

#effect_format ⇒ Object

Get or sets the effect format.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 50

def effect_format
  @effect_format
end

#fill_format ⇒ Object

Get or sets the fill format.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 47

def fill_format
  @fill_format
end

#has_legend ⇒ Object

Get or sets value determines the visibility of legend



56
57
58
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 56

def has_legend
  @has_legend
end

#height ⇒ Object

Height



41
42
43
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 41

def height
  @height
end

#line_format ⇒ Object

Get or sets the line format.



53
54
55
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 53

def line_format
  @line_format
end

#overlay ⇒ Object

true if other elements are allowed to overlay the legend



44
45
46
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 44

def overlay
  @overlay
end

#position ⇒ Object

position



29
30
31
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 29

def position
  @position
end

#width ⇒ Object

Width



38
39
40
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 38

def width
  @width
end

#x ⇒ Object

the X location



32
33
34
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 32

def x
  @x
end

#y ⇒ Object

the Y location



35
36
37
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 35

def y
  @y
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 59

def self.attribute_map
  {
    :'position' => :'Position',
    :'x' => :'X',
    :'y' => :'Y',
    :'width' => :'Width',
    :'height' => :'Height',
    :'overlay' => :'Overlay',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
    :'has_legend' => :'HasLegend',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 75

def self.swagger_types
  {
    :'position' => :'String',
    :'x' => :'Float',
    :'y' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float',
    :'overlay' => :'BOOLEAN',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
    :'has_legend' => :'BOOLEAN',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      position == o.position &&
      x == o.x &&
      y == o.y &&
      width == o.width &&
      height == o.height &&
      overlay == o.overlay &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      line_format == o.line_format &&
      has_legend == o.has_legend
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 189

def hash
  [position, x, y, width, height, overlay, fill_format, effect_format, line_format, has_legend].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



141
142
143
144
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
152
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 148

def valid?
  position_validator = EnumAttributeValidator.new('String', ['Bottom', 'Left', 'Right', 'Top', 'TopRight'])
  return false unless position_validator.valid?(@position)
  true
end