Class: Google::Apis::DocsV1::CropProperties

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/docs_v1/classes.rb,
generated/google/apis/docs_v1/representations.rb,
generated/google/apis/docs_v1/representations.rb

Overview

The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's four edges.

  • If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle.
  • If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle.
  • If all offsets and rotation angle are 0, the image is not cropped.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CropProperties

Returns a new instance of CropProperties



491
492
493
 
# File 'generated/google/apis/docs_v1/classes.rb', line 491

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#angle ⇒ Float

The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. Corresponds to the JSON property angle

Returns:

  • (Float) 


461
462
463
 
# File 'generated/google/apis/docs_v1/classes.rb', line 461

def angle
  @angle
end

#offset_bottom ⇒ Float

The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. Corresponds to the JSON property offsetBottom

Returns:

  • (Float) 


468
469
470
 
# File 'generated/google/apis/docs_v1/classes.rb', line 468

def offset_bottom
  @offset_bottom
end

#offset_left ⇒ Float

The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. Corresponds to the JSON property offsetLeft

Returns:

  • (Float) 


475
476
477
 
# File 'generated/google/apis/docs_v1/classes.rb', line 475

def offset_left
  @offset_left
end

#offset_right ⇒ Float

The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. Corresponds to the JSON property offsetRight

Returns:

  • (Float) 


482
483
484
 
# File 'generated/google/apis/docs_v1/classes.rb', line 482

def offset_right
  @offset_right
end

#offset_top ⇒ Float

The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. Corresponds to the JSON property offsetTop

Returns:

  • (Float) 


489
490
491
 
# File 'generated/google/apis/docs_v1/classes.rb', line 489

def offset_top
  @offset_top
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



496
497
498
499
500
501
502
 
# File 'generated/google/apis/docs_v1/classes.rb', line 496

def update!(**args)
  @angle = args[:angle] if args.key?(:angle)
  @offset_bottom = args[:offset_bottom] if args.key?(:offset_bottom)
  @offset_left = args[:offset_left] if args.key?(:offset_left)
  @offset_right = args[:offset_right] if args.key?(:offset_right)
  @offset_top = args[:offset_top] if args.key?(:offset_top)
end