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 



2199
2200
2201
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2199

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



2154
2155
2156
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2154

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



2160
2161
2162
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2160

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



2168
2169
2170
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2168

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



2174
2175
2176
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2174

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



2185
2186
2187
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2185

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



2191
2192
2193
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2191

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



2197
2198
2199
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2197

def transparency
  @transparency
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2204
2205
2206
2207
2208
2209
2210
2211
2212
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2204

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