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

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

Overview

The properties of an image.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ImageProperties

Returns a new instance of ImageProperties.



2064
2065
2066
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2064

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) 


2019
2020
2021
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2019

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) 


2025
2026
2027
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2025

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) 


2033
2034
2035
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2033

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) 


2039
2040
2041
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2039

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 4 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:



2050
2051
2052
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2050

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) 


2056
2057
2058
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2056

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

Returns:

  • (Float) 


2062
2063
2064
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2062

def transparency
  @transparency
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2069
2070
2071
2072
2073
2074
2075
2076
2077
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2069

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