Class: Google::Apis::DriveV3::TeamDrive::BackgroundImageFile

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

Overview

An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive. teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

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

Returns a new instance of BackgroundImageFile.



2588
2589
2590
 
# File 'generated/google/apis/drive_v3/classes.rb', line 2588

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

Instance Attribute Details

#id ⇒ String

The ID of an image file in Drive to use for the background image. Corresponds to the JSON property id

Returns:

  • (String) 


2561
2562
2563
 
# File 'generated/google/apis/drive_v3/classes.rb', line 2561

def id
  @id
end

#width ⇒ Float

The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. Corresponds to the JSON property width

Returns:

  • (Float) 


2570
2571
2572
 
# File 'generated/google/apis/drive_v3/classes.rb', line 2570

def width
  @width
end

#x_coordinate ⇒ Float

The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. Corresponds to the JSON property xCoordinate

Returns:

  • (Float) 


2578
2579
2580
 
# File 'generated/google/apis/drive_v3/classes.rb', line 2578

def x_coordinate
  @x_coordinate
end

#y_coordinate ⇒ Float

The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. Corresponds to the JSON property yCoordinate

Returns:

  • (Float) 


2586
2587
2588
 
# File 'generated/google/apis/drive_v3/classes.rb', line 2586

def y_coordinate
  @y_coordinate
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2593
2594
2595
2596
2597
2598
 
# File 'generated/google/apis/drive_v3/classes.rb', line 2593

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @width = args[:width] if args.key?(:width)
  @x_coordinate = args[:x_coordinate] if args.key?(:x_coordinate)
  @y_coordinate = args[:y_coordinate] if args.key?(:y_coordinate)
end