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

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.



1850
1851
1852
# File 'generated/google/apis/docs_v1/classes.rb', line 1850

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

Instance Attribute Details

#angleFloat

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

Returns:

  • (Float)


1805
1806
1807
# File 'generated/google/apis/docs_v1/classes.rb', line 1805

def angle
  @angle
end

#brightnessFloat

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)


1811
1812
1813
# File 'generated/google/apis/docs_v1/classes.rb', line 1811

def brightness
  @brightness
end

#content_uriString

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)


1819
1820
1821
# File 'generated/google/apis/docs_v1/classes.rb', line 1819

def content_uri
  @content_uri
end

#contrastFloat

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)


1825
1826
1827
# File 'generated/google/apis/docs_v1/classes.rb', line 1825

def contrast
  @contrast
end

#crop_propertiesGoogle::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



1836
1837
1838
# File 'generated/google/apis/docs_v1/classes.rb', line 1836

def crop_properties
  @crop_properties
end

#source_uriString

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)


1842
1843
1844
# File 'generated/google/apis/docs_v1/classes.rb', line 1842

def source_uri
  @source_uri
end

#transparencyFloat

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)


1848
1849
1850
# File 'generated/google/apis/docs_v1/classes.rb', line 1848

def transparency
  @transparency
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1855
1856
1857
1858
1859
1860
1861
1862
1863
# File 'generated/google/apis/docs_v1/classes.rb', line 1855

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