matplotlib.legend_handler#

기본 범례 처리기.

중요한

이것은 대부분의 최종 사용자에게 필요하지 않은 저수준 범례 API입니다.

이 설명서를 읽기 전에 범례 가이드 를 숙지하는 것이 좋습니다 .

범례 핸들러는 다음 서명이 있는 콜러블 객체여야 합니다.

legend_handler(legend, orig_handle, fontsize, handlebox)

legend 는 범례 자체이고, orig_handle 은 원본 플롯이고, fontsize 는 픽셀 단위의 글꼴 크기이고, handlebox 는 OffsetBox 인스턴스입니다. 호출 내에서 관련 아티스트를 생성하고( legend 및/또는 orig_handle 의 관련 속성 사용 ) 핸들박스에 추가해야 합니다. 아티스트는 글꼴 크기에 따라 크기를 조정해야 합니다(크기는 픽셀 단위, 즉 dpi 크기 값임).

이 모듈에는 다음 메서드를 사용하여 기본 클래스(HandlerBase)에서 파생된 여러 범례 처리기 클래스의 정의가 포함되어 있습니다.

def legend_artist(self, legend, orig_handle, fontsize, handlebox)
클래스 matplotlib.legend_handler. HandlerBase ( xpad = 0.0 , ypad = 0.0 , update_func = 없음 ) [소스] #

기본 범례 처리기의 기본 클래스입니다.

파생 클래스는 다음 서명이 있는 create_artists 메서드를 재정의하기 위한 것입니다.:

def create_artists(self, legend, orig_handle,
                   xdescent, ydescent, width, height, fontsize,
                   trans):

재정의된 메서드는 필요한 경우 글꼴 크기로 크기가 조정되는 지정된 차원(xdescent, ydescent, 너비, 높이)에 맞는 지정된 변환의 아티스트를 생성해야 합니다.

adjust_drawing_area ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , 글꼴 크기 ) [출처] #
create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
legend_artist ( 범례 , orig_handle , fontsize , 핸들박스 ) [출처] #

지정된 원래 아티스트/핸들에 대해 이 HandlerBase가 생성하는 아티스트를 반환합니다.

매개변수 :
전설Legend

이 레전드 아티스트가 만들어지는 레전드.

orig_handle matplotlib.artist.Artist또는 유사

이러한 범례 아티스트가 생성되는 개체입니다.

글꼴 크기 정수

글꼴 크기(픽셀)입니다. 생성되는 아티스트는 지정된 글꼴 크기에 따라 크기가 조정되어야 합니다.

손잡이matplotlib.offsetbox.OffsetBox

이 전설 항목의 아티스트를 보관하기 위해 만들어진 상자입니다. 메서드 에서 생성된 아티스트는 legend_artist이 메서드 내에서 이 핸들박스에 추가되어야 합니다.

update_prop ( legend_handle , orig_handle , legend ) [출처] #
클래스 matplotlib.legend_handler. HandlerCircleCollection ( yoffsets = 없음 , 크기 = 없음 , ** kwargs ) [출처] #

s 에 대한 처리기 CircleCollection.

매개변수 :
숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

플로트의 yoffsets 배열

범례 항목의 각 지점에 대한 y 오프셋의 길이 numpoints 목록입니다.

**kwargs

에 전달된 키워드 인수 HandlerNpoints.

create_collection ( orig_handle , 크기 , 오프셋 , offset_transform ) [소스] #
클래스 matplotlib.legend_handler. HandlerErrorbar ( xerr_size = 0.5 , yerr_size = None , marker_pad = 0.3 , numpoints = None , ** kwargs ) [출처] #

Errorbars에 대한 핸들러.

매개변수 :
marker_pad 플로트

범례 항목의 포인트 사이 패딩.

숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
get_err_size ( 범례 , xdescent , ydescent , 너비 , 높이 , 글꼴 크기 ) [출처] #
클래스 matplotlib.legend_handler. HandlerLine2D ( marker_pad = 0.3 , numpoints = 없음 , ** kwargs ) [출처] #

Line2D인스턴스 에 대한 핸들러 .

또한보십시오

HandlerLine2DCompound

라인에 한 명의 아티스트를 사용하고 마커에 대해 다른 아티스트를 사용하는 초기 핸들러 구현.

매개변수 :
marker_pad 플로트

범례 항목의 포인트 사이 패딩.

숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
클래스 matplotlib.legend_handler. HandlerLine2DCompound ( marker_pad = 0.3 , numpoints = None , ** kwargs ) [출처] #

Line2D라인 전용 아티스트와 마커 전용 아티스트의 결합에 의존하는 인스턴스의 원래 핸들러 . 향후 사용되지 않을 수 있습니다.

매개변수 :
marker_pad 플로트

범례 항목의 포인트 사이 패딩.

숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
클래스 matplotlib.legend_handler. HandlerLineCollection ( marker_pad = 0.3 , numpoints = None , ** kwargs ) [출처] #

LineCollection인스턴스 에 대한 핸들러 .

매개변수 :
marker_pad 플로트

범례 항목의 포인트 사이 패딩.

숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
get_numpoints ( 범례 ) [출처] #
클래스 matplotlib.legend_handler. HandlerNpoints ( marker_pad = 0.3 , numpoints = 없음 , ** kwargs ) [출처] #

범례 항목에 numpoints 지점 을 표시하는 범례 처리기 .

매개변수 :
marker_pad 플로트

범례 항목의 포인트 사이 패딩.

숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

get_numpoints ( 범례 ) [출처] #
get_xdata ( 범례 , xdescent , ydescent , 너비 , 높이 , 글꼴 크기 ) [출처] #
클래스 matplotlib.legend_handler. HandlerNpointsYoffsets ( numpoints = 없음 , yoffsets = 없음 , ** kwargs ) [출처] #

범례에 숫자 포인트 를 표시 하고 y 방향에서 개별적으로 오프셋할 수 있는 범례 처리기입니다 .

매개변수 :
숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

플로트의 yoffsets 배열

범례 항목의 각 지점에 대한 y 오프셋의 길이 numpoints 목록입니다.

**kwargs

에 전달된 키워드 인수 HandlerNpoints.

get_ydata ( 범례 , xdescent , ydescent , 너비 , 높이 , 글꼴 크기 ) [출처] #
클래스 matplotlib.legend_handler. HandlerPatch ( patch_func = 없음 , ** kwargs ) [소스] #

Patch인스턴스 에 대한 핸들러 .

매개변수 :
patch_func 호출 가능, 선택 사항

레전드 키 아티스트를 생성하는 기능. patch_func 에는 서명이 있어야 합니다.

def patch_func(legend=legend, orig_handle=orig_handle,
               xdescent=xdescent, ydescent=ydescent,
               width=width, height=height, fontsize=fontsize)

그 후 생성된 아티스트는 해당 update_prop 메서드가 호출되고 적절한 변환이 적용됩니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
클래스 matplotlib.legend_handler. HandlerPathCollection ( yoffsets = 없음 , 크기 = 없음 , ** kwargs ) [출처] #

PathCollection에서 사용하는 s에 대한 핸들러입니다 scatter.

매개변수 :
숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

플로트의 yoffsets 배열

범례 항목의 각 지점에 대한 y 오프셋의 길이 numpoints 목록입니다.

**kwargs

에 전달된 키워드 인수 HandlerNpoints.

create_collection ( orig_handle , 크기 , 오프셋 , offset_transform ) [소스] #
클래스 matplotlib.legend_handler. HandlerPolyCollection ( xpad = 0.0 , ypad = 0.0 , update_func = 없음 ) [소스] #

및 에서 PolyCollection사용되는 핸들러입니다 .fill_betweenstackplot

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
클래스 matplotlib.legend_handler. HandlerRegularPolyCollection ( yoffsets = 없음 , 크기 = 없음 , ** kwargs ) [출처] #

s 에 대한 처리기 RegularPolyCollection.

매개변수 :
숫자 포인트 int

범례 항목에 표시할 포인트 수입니다.

플로트의 yoffsets 배열

범례 항목의 각 지점에 대한 y 오프셋의 길이 numpoints 목록입니다.

**kwargs

에 전달된 키워드 인수 HandlerNpoints.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
create_collection ( orig_handle , 크기 , 오프셋 , offset_transform ) [소스] #
get_numpoints ( 범례 ) [출처] #
get_sizes ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , 글꼴 크기 ) [출처] #
update_prop ( legend_handle , orig_handle , legend ) [출처] #
클래스 matplotlib.legend_handler. HandlerStem ( marker_pad = 0.3 , numpoints = None , bottom = None , yoffsets = None , ** kwargs ) [출처] #

에 의해 생성된 플롯에 대한 핸들러입니다 stem.

매개변수 :
marker_pad float, 기본값: 0.3

범례 항목의 포인트 사이 패딩.

numpoints int, 선택사항

범례 항목에 표시할 포인트 수입니다.

하단 플로트, 옵션
플로트의 yoffsets 배열, 선택 사항

범례 항목의 각 지점에 대한 y 오프셋의 길이 numpoints 목록입니다.

**kwargs

에 전달된 키워드 인수 HandlerNpointsYoffsets.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
get_ydata ( 범례 , xdescent , ydescent , 너비 , 높이 , 글꼴 크기 ) [출처] #
클래스 matplotlib.legend_handler. HandlerStepPatch ( xpad = 0.0 , ypad = 0.0 , update_func = 없음 ) [소스] #

StepPatch인스턴스 에 대한 핸들러 .

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
클래스 matplotlib.legend_handler. HandlerTuple ( ndivide = 1 , pad = None , ** kwargs ) [소스] #

튜플에 대한 핸들러.

매개변수 :
ndivide int, 기본값: 1

범례 영역을 분할할 섹션 수입니다. None이면 입력 튜플의 길이를 사용합니다.

패드 플로트, 기본값: rcParams["legend.borderpad"](기본값: 0.4)

글꼴 크기의 일부 단위로 패딩합니다.

**kwargs

에 전달된 키워드 인수 HandlerBase.

create_artists ( 범례 , orig_handle , xdescent , ydescent , 너비 , 높이 , fontsize , trans ) [출처] #
matplotlib.legend_handler. update_from_first_child ( tgt , src ) [출처] #