Class: Imagekitio::Models::ExtensionItem::RemoveBg::Options

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Imagekitio::Models::ExtensionItem::RemoveBg::Options

Defined in:

lib/imagekitio/models/extensions.rb

Overview

See Also:

• #options

Instance Attribute Summary

• #add_shadow ⇒ Boolean^?

  Whether to add an artificial shadow to the result.

• #bg_color ⇒ String^?

  Specifies a solid color background using hex code (e.g., “81d4fa”, “fff”) or color name (e.g., “green”).

• #bg_image_url ⇒ String^?

  Sets a background image from a URL.

• #semitransparency ⇒ Boolean^?

  Allows semi-transparent regions in the result.

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from Imagekitio::Internal::Type::BaseModel

Instance Attribute Details

#add_shadow ⇒ Boolean^?

Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos.

Returns:

• (Boolean, nil)

# File 'lib/imagekitio/models/extensions.rb', line 40

optional :add_shadow, Imagekitio::Internal::Type::Boolean

#bg_color ⇒ String^?

Specifies a solid color background using hex code (e.g., “81d4fa”, “fff”) or color name (e.g., “green”). If this parameter is set, ‘bg_image_url` must be empty.

Returns:

• (String, nil)

# File 'lib/imagekitio/models/extensions.rb', line 48

optional :bg_color, String

#bg_image_url ⇒ String^?

Sets a background image from a URL. If this parameter is set, ‘bg_color` must be empty.

Returns:

• (String, nil)

# File 'lib/imagekitio/models/extensions.rb', line 55

optional :bg_image_url, String

#semitransparency ⇒ Boolean^?

Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows.

Returns:

• (Boolean, nil)

# File 'lib/imagekitio/models/extensions.rb', line 62

optional :semitransparency, Imagekitio::Internal::Type::Boolean