Matplotlib.artist.Artist.get_gid() in Python

Last Updated : 12 Jul, 2025

Matplotlib is a library in Python and it is numerical – mathematical extension for NumPy library. The Artist class contains Abstract base class for objects that render into a FigureCanvas. All visible elements in a figure are subclasses of Artist.

Matplotlib.artist.Artist.get_gid() Method

The get_gid() method in artist module of matplotlib library is used to get the group id.

Syntax: Artist.get_gid(self)

Parameters: This method does not accepts any parameter.

Returns: This method return the group id.

Below examples illustrate the matplotlib.artist.Artist.get_gid() function in matplotlib:

Example 1:

python3
# Implementation of matplotlib function
from matplotlib.artist import Artist 
import numpy as np 
import matplotlib.pyplot as plt 
   
  
y, x = np.mgrid[:5, 1:6] 

poly_coords = [ 
    (0.25, 2.75), (3.25, 2.75), 
    (2.25, 0.75), (0.25, 0.75) 
] 
  
fig, ax = plt.subplots() 
   
cells = ax.plot(x, y, x + y, color ='green') 

ax.add_patch( 
    plt.Polygon(poly_coords,  
                color ='forestgreen',  
                alpha = 0.5) 
    ) 

ax.margins(x = 0.1, y = 0.05) 
ax.set_aspect('equal') 
  
for i, t in enumerate(ax.patches): 
    Artist.set_gid(t, 'patch_% d' % i)
    print("Value Return :", Artist.get_gid(t))

fig.suptitle("""matplotlib.artist.Artist.get_gid()
function Example""", fontweight="bold")

plt.show()

Output:

Value Return : patch_ 0

Example 2:

python3
# Implementation of matplotlib function
from matplotlib.artist import Artist 
import numpy as np 
import matplotlib.pyplot as plt 
  
   
fig, ax = plt.subplots() 
  
circle = plt.Circle((0, 0), 5, fc ='blue') 
rect = plt.Rectangle((-5, 10), 10, 5, fc ='green') 
  
ax.add_patch(circle) 
ax.add_patch(rect) 
  
circle_tip = ax.annotate('This is a blue circle.', 
            xy =(0, 0), 
            xytext =(30, -30), 
            textcoords ='offset points', 
            color ='w', 
            ha ='left', 
            bbox = dict(boxstyle ='round, pad =.5',  
                        fc =(.1, .1, .1, .92), 
                        ec =(1., 1., 1.),  
                        lw = 1, 
                        zorder = 1), 
            ) 
  
rect_tip = ax.annotate('This is a green rectangle.', 
            xy =(-5, 10), 
            xytext =(30, 40), 
            textcoords ='offset points', 
            color ='w', 
            ha ='left', 
            bbox = dict(boxstyle ='round, pad =.5', 
                        fc =(.1, .1, .1, .92),  
                        ec =(1., 1., 1.),  
                        lw = 1, 
                        zorder = 1), 
            ) 

print("Value Return :") 
for i, t in enumerate(ax.patches): 
    Artist.set_gid(t, 'patch_% d'% i)
    print(Artist.get_gid(t)) 
  
for i, t in enumerate(ax.texts): 
    Artist.set_gid(t, 'tooltip_% d'% i)
    print(Artist.get_gid(t)) 
  
ax.set_xlim(-30, 30) 
ax.set_ylim(-30, 30) 
ax.set_aspect('equal') 

fig.suptitle("""matplotlib.artist.Artist.get_gid()
function Example""", fontweight="bold")

plt.show()

Output:

Value Return :
patch_ 0
patch_ 1
tooltip_ 0
tooltip_ 1
Comment