Class: Google::Apis::DocsV1::ImageProperties

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 more...

Overview

The properties of an image.

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) ⇒ ImageProperties

Returns a new instance of ImageProperties

[View source]

1672
1673
1674
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1672

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

Instance Attribute Details

#angle ⇒ Float

The clockwise rotation angle of the image, in radians. Corresponds to the JSON property angle

Returns:

  • (Float) 

1626
1627
1628
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1626

def angle
  @angle
end

#brightness ⇒ Float

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. Corresponds to the JSON property brightness

Returns:

  • (Float) 

1632
1633
1634
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1632

def brightness
  @brightness
end

#content_uri ⇒ String

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. Corresponds to the JSON property contentUri

Returns:

  • (String) 

1640
1641
1642
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1640

def content_uri
  @content_uri
end

#contrast ⇒ Float

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. Corresponds to the JSON property contrast

Returns:

  • (Float) 

1646
1647
1648
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1646

def contrast
  @contrast
end

#crop_properties ⇒ Google::Apis::DocsV1::CropProperties

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. Corresponds to the JSON property cropProperties

Returns:


1658
1659
1660
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1658

def crop_properties
  @crop_properties
end

#source_uri ⇒ String

The source URI is the URI used to insert the image. The source URI can be empty. Corresponds to the JSON property sourceUri

Returns:

  • (String) 

1664
1665
1666
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1664

def source_uri
  @source_uri
end

#transparency ⇒ Float

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. Corresponds to the JSON property transparency

Returns:

  • (Float) 

1670
1671
1672
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1670

def transparency
  @transparency
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1677

def update!(**args)
  @angle = args[:angle] if args.key?(:angle)
  @brightness = args[:brightness] if args.key?(:brightness)
  @content_uri = args[:content_uri] if args.key?(:content_uri)
  @contrast = args[:contrast] if args.key?(:contrast)
  @crop_properties = args[:crop_properties] if args.key?(:crop_properties)
  @source_uri = args[:source_uri] if args.key?(:source_uri)
  @transparency = args[:transparency] if args.key?(:transparency)
end