Matplotlib 3.0 - axes.Axes.legend
matplotlib.axes.Axes.legend

matplotlib.axes.Axes.legend
-
Axes.legend(*args, **kwargs)
[source] -
कुल्हाड़ियों पर एक किंवदंती रखें।
कॉल हस्ताक्षर:
legend() legend(labels) legend(handles, labels)
कॉल हस्ताक्षर इस पद्धति का उपयोग करने के तीन अलग-अलग तरीकों के अनुरूप हैं।
1. किंवदंती में दिखाए जाने वाले तत्वों का स्वचालित पता लगाना
किंवदंती में जोड़े जाने वाले तत्व स्वचालित रूप से निर्धारित किए जाते हैं, जब आप किसी भी अतिरिक्त तर्क में पास नहीं होते हैं।
इस मामले में, कलाकार से लेबल लिया जाता है। आप उन्हें या तो कलाकार निर्माण में या कलाकार पर
set_label()
विधि कहकर निर्दिष्ट कर सकते हैं:line, = ax.plot([1, 2, 3], label='Inline label') ax.legend()
या:
line.set_label('Label via method') line, = ax.plot([1, 2, 3]) ax.legend()
एक अंडरस्कोर के साथ शुरू होने वाले लेबल को परिभाषित करके विशिष्ट लाइनों को स्वचालित किंवदंती तत्व चयन से बाहर रखा जा सकता है। यह सभी कलाकारों के लिए डिफ़ॉल्ट है, इसलिए बिना किसी तर्क के
Axes.legend
कॉल करें और लेबल को मैन्युअल रूप से सेट किए बिना परिणाम होगा कि कोई किंवदंती तैयार नहीं है।2. मौजूदा प्लॉट तत्वों को लेबल करना
लाइनों के लिए एक किंवदंती बनाने के लिए जो पहले से ही कुल्हाड़ियों पर मौजूद हैं (उदाहरण के लिए साजिश के माध्यम से), बस इस फ़ंक्शन को स्ट्रिंग्स के चलने योग्य के साथ कॉल करें, प्रत्येक लीजेंड आइटम के लिए एक। उदाहरण के लिए:
ax.plot([1, 2, 3]) ax.legend(['A simple line'])
नोट: उपयोग करने का यह तरीका हतोत्साहित करता है, क्योंकि प्लॉट तत्वों और लेबल के बीच का संबंध केवल उनके आदेश से निहित है और आसानी से मिलाया जा सकता है।
3. किंवदंती में तत्वों को स्पष्ट रूप से परिभाषित करना
पूर्ण नियंत्रण के लिए जिन कलाकारों के पास एक किंवदंती प्रविष्टि है, क्रमशः किंवदंती कलाकारों के पुनरावृत्तियों को पारित करना संभव है, इसके बाद क्रमशः किंवदंती लेबल का पुनरावृत्ति होना चाहिए:
legend((line1, line2, line3), ('label1', 'label2', 'label3'))
पैरामीटर: -
handles : sequence of Artist, optional
-
किंवदंती में शामिल होने के लिए कलाकारों की एक सूची (लाइनें, पैच)। इसे लेबल के साथ एक साथ उपयोग करें, यदि आपको किंवदंती में दिखाए गए पूर्ण नियंत्रण की आवश्यकता है और ऊपर वर्णित स्वचालित तंत्र पर्याप्त नहीं है।
इस मामले में हैंडल और लेबल की लंबाई समान होनी चाहिए। यदि वे नहीं हैं, तो उन्हें छोटी लंबाई में काट दिया जाता है।
-
labels : sequence of strings, optional
-
कलाकारों के बगल में दिखाने के लिए लेबल की एक सूची। इसे हैंडल के साथ एक साथ उपयोग करें, यदि आपको किंवदंती में दिखाए गए पूर्ण नियंत्रण की आवश्यकता है और ऊपर वर्णित स्वचालित तंत्र पर्याप्त नहीं है।
यह दिखाता है: - : वर्ग: `matplotlib.legend.Legend` उदाहरण
अन्य पैरामीटर: -
loc : int or string or pair of floats, default: rcParams["legend.loc"] ('best' for axes, 'upper right' for figures)
-
किंवदंती का स्थान। संभावित कोड हैं:
स्थान स्ट्रिंग स्थान कोड 'श्रेष्ठ' 0 'उपर से दाहिना' 1 'ऊपरी बांया' 2 'निचला बायां' 3 'निचली दाईं ओर' 4 'सही' 5 'केंद्र छोड़ दिया' 6 'सेंटर राइट' 7 'निचला केंद्र' 8 'ऊपरी केंद्र' 9 'केंद्र' 10 वैकल्पिक रूप से
x, y
-bbox_to_anchor
में (जिस स्थिति मेंbbox_to_anchor
को नजरअंदाज किया जाएगा) किंवदंती के निचले-बाएं कोने मेंx, y
2-ट्यूपल देनेbbox_to_anchor
हो सकता है। -
bbox_to_anchor : BboxBase, 2-tuple, or 4-tuple of floats
-
बॉक्स जिसका उपयोग लेजेंड को लोकेशन के साथ जोड़ने के लिए किया जाता है ।
axes.bbox
(यदिaxes.bbox
करने के लिए एक विधि के रूप में कहा जाता है) याfigure.bbox
(यदिFigure.legend
।Figure.legend
) के लिएFigure.legend
। यह तर्क किंवदंती की मनमानी नियुक्ति की अनुमति देता है।Bbox निर्देशांक की व्याख्या
bbox_transform
द्वारा दी गई समन्वय प्रणाली में की जाती है, डिफ़ॉल्ट रूप से परिवर्तनbbox_transform
या चित्रा निर्देशांक के साथ, जिसके आधार परlegend
कहा जाता है।यदि 4-ट्यूपल या
BboxBase
दिया जाता है, तो यह उस बॉक्स(x, y, width, height)
निर्दिष्ट करता है जिसे किंवदंती में रखा गया है। किंवदंती को अक्ष के निचले दाईं ओर के सबसे अच्छे स्थान पर रखने के लिए (या आंकड़ा)। ):loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)
2-ट्यूपल
(x, y)
x, y पर लोक द्वारा निर्दिष्ट किंवदंती के कोने को रखता है। उदाहरण के लिए, किंवदंती के ऊपरी दाएं कोने को कुल्हाड़ियों (या आकृति) के केंद्र में रखने के लिए निम्नलिखित कीवर्ड का उपयोग किया जा सकता है:loc='upper right', bbox_to_anchor=(0.5, 0.5)
-
ncol : integer
-
किंवदंती है कि स्तंभों की संख्या। डिफ़ॉल्ट 1 है।
-
prop : None or matplotlib.font_manager.FontProperties or dict
-
किंवदंती के फ़ॉन्ट गुण। यदि कोई नहीं (डिफ़ॉल्ट), वर्तमान
matplotlib.rcParams
का उपयोग किया जाएगा। -
fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
-
किंवदंती के फ़ॉन्ट आकार को नियंत्रित करता है। यदि मान संख्यात्मक है, तो अंक में पूर्ण फ़ॉन्ट आकार होगा। स्ट्रिंग मान वर्तमान डिफ़ॉल्ट फ़ॉन्ट आकार के सापेक्ष हैं। इस तर्क का उपयोग केवल तभी किया जाता है यदि
prop
निर्दिष्ट नहीं है। -
numpoints : None or int
-
लाइन 2
Line2D
(लाइन) के लिए लीजेंड एंट्री बनाते समय लीजेंड में मार्कर पॉइंट्स की संख्या। डिफ़ॉल्टNone
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
scatterpoints : None or int
-
PathCollection
(स्कैटर प्लॉट) के लिए लीजेंड एंट्री बनाते समय किंवदंती में मार्कर के अंक। डिफ़ॉल्टNone
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
scatteryoffsets : iterable of floats
-
स्कैटर प्लॉट लेजेंड एंट्री के लिए बनाए गए मार्कर के लिए वर्टिकल ऑफ़सेट (फ़ॉन्ट आकार के सापेक्ष)। ०.० पौराणिक कथा के आधार पर है, और १.० शीर्ष पर है। समान ऊंचाई पर सभी मार्करों को खींचने के लिए,
[0.5]
सेट करें। डिफ़ॉल्ट[0.375, 0.5, 0.3125]
। -
markerscale : None or int or float
-
मूल रूप से तैयार किए गए लोगों की तुलना में किंवदंती मार्करों के सापेक्ष आकार। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
markerfirst : bool
-
यदि सही है , तो लीजेंड मार्कर को लीजेंड लेबल के बाईं ओर रखा जाता है। यदि गलत , लीजेंड मार्कर को लीजेंड लेबल के दाईं ओर रखा जाता है। डिफ़ॉल्ट सत्य है ।
-
frameon : None or bool
-
नियंत्रित करें कि किंवदंती को पैच (फ्रेम) पर खींचा जाना चाहिए या नहीं। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
fancybox : None or bool
-
नियंत्रित करें कि क्या गोल किनारों को
FancyBboxPatch
चारों ओर सक्षम किया जाना चाहिए जो किंवदंती की पृष्ठभूमि बनाता है। डिफ़ॉल्टNone
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
shadow : None or bool
-
नियंत्रित करें कि क्या किंवदंती के पीछे छाया खींचना है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
framealpha : None or float
-
किंवदंती की पृष्ठभूमि की अल्फा पारदर्शिता को नियंत्रित करें। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। यदि छाया सक्रिय है और framealphaNone
, तो डिफ़ॉल्ट मान को अनदेखा कर दिया जाता है। -
facecolor : None or "inherit" or a color spec
-
किंवदंती की पृष्ठभूमि के रंग को नियंत्रित करें। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। यदि"inherit"
, यहrcParams["legend.numpoints"]
ले जाएगा। -
edgecolor : None or "inherit" or a color spec
-
किंवदंती की पृष्ठभूमि पैच एज रंग को नियंत्रित करें। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्य लेगा, अगर"inherit"
, यहrcParams["legend.numpoints"]
ले जाएगा। -
mode : {"expand", None}
-
यदि
mode
को"expand"
करने के लिए सेट किया गया है, तो कुल्हाड़ियों के क्षेत्र को भरने के लिए किंवदंती को क्षैतिज रूप से विस्तारित किया जाएगा (या यदि किंवदंती के आकार को परिभाषित करता है तोbbox_to_anchor
)। -
bbox_transform : None or matplotlib.transforms.Transform
-
बाउंडिंग बॉक्स के लिए परिवर्तन (
bbox_to_anchor
)।None
(डिफ़ॉल्ट) के मान के लिए Axes 'transAxes
ट्रांस्फ़ॉर्म का उपयोग किया जाएगा। -
title : str or None
-
किंवदंती का शीर्षक। डिफ़ॉल्ट कोई शीर्षक
None
(None
)। - title_fontsize: str या कोई नहीं
-
किंवदंती के शीर्षक का फ़ॉन्टकरण। डिफ़ॉल्ट डिफ़ॉल्ट फ़ॉन्ट है।
-
borderpad : float or None
-
पौराणिक सीमा के अंदर भिन्नात्मक व्हाट्सएप। फ़ॉन्ट आकार इकाइयों में मापा जाता है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
labelspacing : float or None
-
किंवदंती प्रविष्टियों के बीच ऊर्ध्वाधर स्थान। फ़ॉन्ट आकार इकाइयों में मापा जाता है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
handlelength : float or None
-
किंवदंती की लंबाई संभालती है। फ़ॉन्ट आकार इकाइयों में मापा जाता है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
handletextpad : float or None
-
किंवदंती संभाल और पाठ के बीच पैड। फ़ॉन्ट आकार इकाइयों में मापा जाता है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
borderaxespad : float or None
-
कुल्हाड़ियों और किंवदंती सीमा के बीच पैड। फ़ॉन्ट आकार इकाइयों में मापा जाता है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
columnspacing : float or None
-
स्तंभों के बीच रिक्ति। फ़ॉन्ट आकार इकाइयों में मापा जाता है। डिफ़ॉल्ट
None
, जोrcParams["legend.numpoints"]
से मूल्यrcParams["legend.numpoints"]
। -
handler_map : dict or None
-
कस्टम शब्दकोश मानचित्रण उदाहरण या एक किंवदंती हैंडलर के प्रकार। यह
handler_map
matplotlib.legend.Legend.get_legend_handler_map()
पाए गए डिफ़ॉल्ट हैंडलर मैप को अपडेट करता है।
टिप्पणियाँ
सभी प्रकार के कलाकार किंवदंती कमांड द्वारा समर्थित नहीं हैं। विवरण के लिए लीजेंड गाइड देखें।
उदाहरण
-