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.



2134
2135
2136
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2134

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) 


2089
2090
2091
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2089

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) 


2095
2096
2097
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2095

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) 


2103
2104
2105
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2103

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) 


2109
2110
2111
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2109

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 angles are 0, the image is not cropped. Corresponds to the JSON property cropProperties

Returns:



2120
2121
2122
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2120

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) 


2126
2127
2128
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2126

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) 


2132
2133
2134
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2132

def transparency
  @transparency
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2139

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