---

title: “Image Class Documentation” date: 2025-06-28 layout: default —

Table of Contents

• 🔧 Class:Image
  • 🔹 Public:Methods
    • 🔹 add:Methods
    • 🔹 autocrop:Methods
    • 🔹 bind:Methods
    • 🔹 connect:Methods
    • 🔹 convert:Methods
    • 🔹 delete:Methods
    • 🔹 disconnect:Methods
    • 🔹 emit:Methods
    • 🔹 export:Methods
    • 🔹 find:Methods
    • 🔹 freeze:Methods
    • 🔹 get:Methods
    • 🔹 grid:Methods
    • 🔹 handler:Methods
    • 🔹 import:Methods
    • 🔹 insert:Methods
    • 🔹 install:Methods
    • 🔹 interface:Methods
    • 🔹 is:Methods
    • 🔹 lower:Methods
    • 🔹 merge:Methods
    • 🔹 metadata:Methods
    • 🔹 new:Methods
    • 🔹 notify:Methods
    • 🔹 pick:Methods
    • 🔹 policy:Methods
    • 🔹 raise:Methods
    • 🔹 ref:Methods
    • 🔹 remove:Methods
    • 🔹 replace:Methods
    • 🔹 resize:Methods
    • 🔹 select:Methods
    • 🔹 set:Methods
    • 🔹 steal:Methods
    • 🔹 stop:Methods
    • 🔹 take:Methods
    • 🔹 thaw:Methods
    • 🔹 undo:Methods
    • 🔹 ungrouped:Methods
  • 🔒 Private:Methods
    • 🔒 ref:Methods
    • 🔒 unsupported:Methods
    • 🔒 ungrouped:Methods
  • ⚙ Dunder:Methods
    • ⚙ init:Methods
    • ⚙ reduce:Methods
    • ⚙ ungrouped:Methods
• 🔧 Properties
• 🔧 Signals

  Class: Image

  🔹 Public Methods

• 🔹 add Methods

  ⚠️ add_hguide Unavailable †
  ⚠️ add_sample_point Unavailable †
  ⚠️ add_vguide Unavailable †
  

• 🔹 autocrop Methods

  ⚠️ autocrop Unavailable †
  ⚠️ autocrop_selected_layers Unavailable †
  

• 🔹 bind Methods

  ⚠️ bind_property Unavailable †
  ⚠️ bind_property_full Unavailable †
  

• 🔹 connect Methods

  ⚠️ connect Unavailable †
  ⚠️ connect_after Unavailable †
  ⚠️ connect_data Unavailable †
  ⚠️ connect_object Unavailable †
  ⚠️ connect_object_after Unavailable †
  

• 🔹 convert Methods

  ⚠️ convert_color_profile Unavailable †
  ⚠️ convert_color_profile_from_file Unavailable †
  ⚠️ convert_grayscale Unavailable †
  ⚠️ convert_indexed Unavailable †
  ⚠️ convert_precision Unavailable †
  ⚠️ convert_rgb Unavailable †
  ⚠️ convert_set_dither_matrix Unavailable †
  

• 🔹 delete Methods

  ⚠️ delete Unavailable †
  ⚠️ delete_guide Unavailable †
  ⚠️ delete_sample_point Unavailable †
  

• 🔹 disconnect Methods

  ⚠️ disconnect Unavailable †
  ⚠️ disconnect_by_func Unavailable †
  

• 🔹 emit Methods

  ⚠️ emit Unavailable †
  ⚠️ emit_stop_by_name Unavailable †
  

• 🔹 export Methods

  ⚠️ export_path_to_file Unavailable †
  ⚠️ export_path_to_string Unavailable †
  

• 🔹 find Methods

  ⚠️ find_next_guide Unavailable †
  ⚠️ find_next_sample_point Unavailable †
  ⚠️ find_property Unavailable †
  

• 🔹 freeze Methods

  ⚠️ freeze_channels Unavailable †
  ⚠️ freeze_layers Unavailable †
  ⚠️ freeze_notify Unavailable †
  ⚠️ freeze_paths Unavailable †
  

• 🔹 get Methods

  ⚠️ get_base_type Unavailable †
  ⚠️ get_by_id Unavailable †
  ⚠️ get_channel_by_name Unavailable †
  ⚠️ get_channel_by_tattoo Unavailable †
  ⚠️ get_channels Unavailable †
  ⚠️ get_color_profile Unavailable †
  ⚠️ get_component_active Unavailable †
  ⚠️ get_component_visible Unavailable †
  ⚠️ get_data Unavailable †
  ⚠️ get_default_new_layer_mode Unavailable †
  ⚠️ get_effective_color_profile Unavailable †
  ⚠️ get_exported_file Unavailable †
  ⚠️ get_file Unavailable †
  ⚠️ get_floating_sel Unavailable †
  ⚠️ get_guide_orientation Unavailable †
  ⚠️ get_guide_position Unavailable †
  ⚠️ get_height Unavailable †
  ⚠️ get_id Unavailable †
  ⚠️ get_imported_file Unavailable †
  ⚠️ get_item_position Unavailable †
  ⚠️ get_layer_by_name Unavailable †
  ⚠️ get_layer_by_tattoo Unavailable †
  ⚠️ get_layers Unavailable †
  ⚠️ get_metadata Unavailable †
  ⚠️ get_name Unavailable †
  ⚠️ get_palette Unavailable †
  ⚠️ get_parasite Unavailable †
  ⚠️ get_parasite_list Unavailable †
  ⚠️ get_path_by_name Unavailable †
  ⚠️ get_path_by_tattoo Unavailable †
  ⚠️ get_paths Unavailable †
  ⚠️ get_precision Unavailable †
  ⚠️ get_properties Unavailable †
  ⚠️ get_property Unavailable †
  ⚠️ get_qdata Unavailable †
  ⚠️ get_resolution Unavailable †
  ⚠️ get_sample_point_position Unavailable †
  ⚠️ get_selected_channels Unavailable †
  ⚠️ get_selected_drawables Unavailable †
  ⚠️ get_selected_layers Unavailable †
  ⚠️ get_selected_paths Unavailable †
  ⚠️ get_selection Unavailable †
  ⚠️ get_simulation_bpc Unavailable †
  ⚠️ get_simulation_intent Unavailable †
  ⚠️ get_simulation_profile Unavailable †
  ⚠️ get_tattoo_state Unavailable †
  ⚠️ get_thumbnail Unavailable †
  ⚠️ get_thumbnail_data Unavailable †
  ⚠️ get_unit Unavailable †
  ⚠️ get_width Unavailable †
  ⚠️ get_xcf_file Unavailable †
  

• 🔹 grid Methods

  ⚠️ grid_get_background_color Unavailable †
  ⚠️ grid_get_foreground_color Unavailable †
  ⚠️ grid_get_offset Unavailable †
  ⚠️ grid_get_spacing Unavailable †
  ⚠️ grid_get_style Unavailable †
  ⚠️ grid_set_background_color Unavailable †
  ⚠️ grid_set_foreground_color Unavailable †
  ⚠️ grid_set_offset Unavailable †
  ⚠️ grid_set_spacing Unavailable †
  ⚠️ grid_set_style Unavailable †
  

• 🔹 handler Methods

  ⚠️ handler_block Unavailable †
  ⚠️ handler_block_by_func Unavailable †
  ⚠️ handler_disconnect Unavailable †
  ⚠️ handler_is_connected Unavailable †
  ⚠️ handler_unblock Unavailable †
  ⚠️ handler_unblock_by_func Unavailable †
  

• 🔹 import Methods

  ⚠️ import_paths_from_file Unavailable †
  ⚠️ import_paths_from_string Unavailable †
  

• 🔹 insert Methods

  ⚠️ insert_channel Unavailable †
  ⚠️ insert_layer Unavailable †
  ⚠️ insert_path Unavailable †
  

• 🔹 install Methods

  ⚠️ install_properties Unavailable †
  ⚠️ install_property Unavailable †
  

• 🔹 interface Methods

  ⚠️ interface_find_property Unavailable †
  ⚠️ interface_install_property Unavailable †
  ⚠️ interface_list_properties Unavailable †
  

• 🔹 is Methods

  ⚠️ is_dirty Unavailable †
  ⚠️ is_floating Unavailable †
  ⚠️ is_valid Unavailable †
  

• 🔹 lower Methods

  ⚠️ lower_item Unavailable †
  ⚠️ lower_item_to_bottom Unavailable †
  

• 🔹 merge Methods

  ⚠️ merge_down Unavailable †
  ⚠️ merge_visible_layers Unavailable †
  

• 🔹 metadata Methods

  ⚠️ metadata_load_thumbnail Unavailable †
  ⚠️ metadata_save_filter Unavailable †
  ⚠️ metadata_save_prepare Unavailable †
  

• 🔹 new Methods

  ⚠️ new Unavailable †
  ⚠️ new_with_precision Unavailable †
  

• 🔹 notify Methods

  ⚠️ notify Unavailable †
  ⚠️ notify_by_pspec Unavailable †
  

• 🔹 pick Methods

  ⚠️ pick_color Unavailable †
  ⚠️ pick_correlate_layer Unavailable †
  

• 🔹 policy Methods

  ⚠️ policy_color_profile Unavailable †
  ⚠️ policy_rotate Unavailable †
  

• 🔹 raise Methods

  ⚠️ raise_item Unavailable †
  ⚠️ raise_item_to_top Unavailable †
  

• 🔹 ref Methods

  ⚠️ ref Unavailable †
  ⚠️ ref_sink Unavailable †
  

• 🔹 remove Methods

  ⚠️ remove_channel Unavailable †
  ⚠️ remove_layer Unavailable †
  ⚠️ remove_path Unavailable †
  

• 🔹 replace Methods

  ⚠️ replace_data Unavailable †
  ⚠️ replace_qdata Unavailable †
  

• 🔹 resize Methods

  ⚠️ resize Unavailable †
  ⚠️ resize_to_layers Unavailable †
  

• 🔹 select Methods

  ⚠️ select_color Unavailable †
  ⚠️ select_contiguous_color Unavailable †
  ⚠️ select_ellipse Unavailable †
  ⚠️ select_item Unavailable †
  ⚠️ select_polygon Unavailable †
  ⚠️ select_rectangle Unavailable †
  ⚠️ select_round_rectangle Unavailable †
  

• 🔹 set Methods

  ⚠️ set_color_profile Unavailable †
  ⚠️ set_color_profile_from_file Unavailable †
  ⚠️ set_component_active Unavailable †
  ⚠️ set_component_visible Unavailable †
  ⚠️ set_data Unavailable †
  ⚠️ set_file Unavailable †
  ⚠️ set_metadata Unavailable †
  ⚠️ set_palette Unavailable †
  ⚠️ set_properties Unavailable †
  ⚠️ set_property Unavailable †
  ⚠️ set_resolution Unavailable †
  ⚠️ set_selected_channels Unavailable †
  ⚠️ set_selected_layers Unavailable †
  ⚠️ set_selected_paths Unavailable †
  ⚠️ set_simulation_bpc Unavailable †
  ⚠️ set_simulation_intent Unavailable †
  ⚠️ set_simulation_profile Unavailable †
  ⚠️ set_simulation_profile_from_file Unavailable †
  ⚠️ set_tattoo_state Unavailable †
  ⚠️ set_unit Unavailable †
  

• 🔹 steal Methods

  ⚠️ steal_data Unavailable †
  ⚠️ steal_qdata Unavailable †
  

• 🔹 stop Methods

  ⚠️ stop_emission Unavailable †
  ⚠️ stop_emission_by_name Unavailable †
  

• 🔹 take Methods

  ⚠️ take_selected_channels Unavailable †
  ⚠️ take_selected_layers Unavailable †
  ⚠️ take_selected_paths Unavailable †
  

• 🔹 thaw Methods

  ⚠️ thaw_channels Unavailable †
  ⚠️ thaw_layers Unavailable †
  ⚠️ thaw_notify Unavailable †
  ⚠️ thaw_paths Unavailable †
  

• 🔹 undo Methods

  ⚠️ undo_disable Unavailable †
  ⚠️ undo_enable Unavailable †
  ⚠️ undo_freeze Unavailable †
  ⚠️ undo_group_end Unavailable †
  ⚠️ undo_group_start Unavailable †
  ⚠️ undo_is_enabled Unavailable †
  ⚠️ undo_thaw Unavailable †
  

• 🔹 ungrouped Methods

  ⚠️ attach_parasite Unavailable †
  ⚠️ chain Unavailable †
  ⚠️ clean_all Unavailable †
  ⚠️ compat_control Unavailable †
  ⚠️ crop Unavailable †
  ⚠️ detach_parasite Unavailable †
  ⚠️ duplicate Unavailable †
  ⚠️ flatten Unavailable †
  ⚠️ flip Unavailable †
  ⚠️ floating_sel_attached_to Unavailable †
  ⚠️ force_floating Unavailable †
  ⚠️ getv Unavailable †
  ⚠️ id_is_valid Unavailable †
  ⚠️ list_properties Unavailable †
  ⚠️ newv Unavailable †
  ⚠️ override_property Unavailable †
  ⚠️ reorder_item Unavailable †
  ⚠️ rotate Unavailable †
  ⚠️ run_dispose Unavailable †
  ⚠️ scale Unavailable †
  ⚠️ unref Unavailable †
  ⚠️ unset_active_channel Unavailable †
  ⚠️ watch_closure Unavailable †
  ⚠️ weak_ref Unavailable †
  

  🔒 Private Methods

• 🔒 ref Methods

  ⚠️ **ref** _Unavailable †
  ⚠️ **ref_sink** _Unavailable †
  

• 🔒 unsupported Methods

  ⚠️ **unsupported_data_method** _Unavailable †
  ⚠️ **unsupported_method** _Unavailable †
  

• 🔒 ungrouped Methods

  ⚠️ **force_floating** _Unavailable †
  ⚠️ **unref** _Unavailable †
  

  ⚙ Dunder Methods

• ⚙ init Methods

  • __init__ (self, /, *args, **kwargs)
    
  • __init_subclass__ ()
    

• ⚙ reduce Methods

  • __reduce__ (self, /)
    
  • __reduce_ex__ (self, protocol, /)
    

• ⚙ ungrouped Methods

  • __class__ (name, bases, dict_)
    ⚠️ __copy__ Unavailable †
    ⚠️ __deepcopy__ Unavailable †
    
  • __delattr__ (self, name, /)
    
  • __dir__ (self, /)
    
  • __eq__ (self, value, /)
    
  • __format__ (self, format_spec, /)
    
  • __ge__ (self, value, /)
    
  • __getattribute__ (self, name, /)
    
  • __getstate__ (self, /)
    
  • __gt__ (self, value, /)
    
  • __hash__ (self, /)
    
  • __le__ (self, value, /)
    
  • __lt__ (self, value, /)
    
  • __ne__ (self, value, /)
    
  • __new__ (*args, **kwargs)
    
  • __repr__ (self, /)
    
  • __setattr__ (self, name, value, /)
    
  • __sizeof__ (self, /)
    
  • __str__ (self, /)
    
  • __subclasshook__ (object, /)
    

    🏷️ Properties

  • id: gint (read/write)
    

    📣 Signals

    
    - None found

† Methods marked as “Unavailable” exist at the C/GObject layer but are not callable via GIMP Python introspection.
These may become accessible in future releases or via plugin-level extensions.