matplotlib.legend

legend 모듈은 축 및/또는 그림과 관련된 범례 그리기를 담당하는 Legend 클래스를 정의합니다.

중요한

Legend 인스턴스를 수동으로 생성할 가능성은 거의 없습니다. 대부분의 사용자는 일반적으로 함수를 통해 범례를 생성합니다 legend . 범례에 대한 자세한 내용은 범례 가이드 도 있습니다.

이 Legend클래스는 범례 핸들과 범례 텍스트의 컨테이너입니다.

범례 처리기 맵은 축 또는 그림의 아티스트(선, 패치 등)에서 범례 핸들을 만드는 방법을 지정합니다. 기본 범례 처리기는 legend_handler모듈에서 정의됩니다. 모든 아티스트 유형이 기본 범례 처리기로 처리되는 것은 아니지만 임의의 개체를 지원하도록 사용자 정의 범례 처리기를 정의할 수 있습니다.

자세한 내용은 범례 가이드 를 참조하십시오.

클래스 matplotlib.legend. DraggableLegend ( 범례 , use_blit = False , 업데이트 = 'loc' )

베이스:DraggableOffsetBox

Legend마우스 끌기를 지원하기 위해 a를 감싸 십시오.

매개변수 :

전설Legend

Legend래핑할 인스턴스입니다 .

use_blit 부울, 선택 사항

더 빠른 이미지 합성을 위해 블리팅을 사용하십시오. 자세한 내용은 FuncAnimation 을 참조하십시오 .

업데이트 {'loc', 'bbox'}, 선택사항

"loc"인 경우 완료 시 범례 의 loc 매개변수를 업데이트합니다. "bbox"인 경우 bbox_to_anchor 매개변수를 업데이트합니다.

finalize_offset ( )

클래스 matplotlib.legend. 범례 ( parent , handles , labels , * , loc = None , numpoints = None , markerscale = None , markerfirst = True , scatterpoints = None , scatteryoffsets = None , prop = None , fontsize = None , labelcolor = None , borderpad= None , labelspacing = None , handlelength = None , handleheight = None , handletextpad = None , borderaxespad = None , columnspacing = None , ncols = 1 , mode = None , fancybox = None , shadow = None , title = None , title_fontsize = None, framealpha = None , edgecolor = None , facecolor = None , bbox_to_anchor = None , bbox_transform = None , frameon = None , handler_map = None , title_fontproperties = None , alignment = 'center' , ncol = 1 )

베이스:Artist

위치 loc의 축에 범례를 배치합니다.

매개변수 :

부모 Axes또는Figure

전설을 담은 아티스트.

처리 목록Artist

범례에 추가할 아티스트(라인, 패치) 목록입니다.

str의 레이블 목록

아티스트 옆에 표시할 레이블 목록입니다. 손잡이와 라벨의 길이는 동일해야 합니다. 그렇지 않은 경우 두 길이 중 더 작은 길이로 잘립니다.

기타 매개변수 :

loc str 또는 부동 소수점 쌍, 기본값: rcParams["legend.loc"](기본값: 'best') (축의 경우 '최고', 그림의 경우 '오른쪽 상단')

범례의 위치입니다.

문자열 은 축/그림의 해당 모서리에 범례를 배치합니다.'upper left', 'upper right', 'lower left', 'lower right'

문자열 은 축/도형의 해당 모서리 중심에 범례를 배치합니다.'upper center', 'lower center', 'center left', 'center right'

문자열 'center'은 축/그림의 중심에 범례를 배치합니다.

문자열 'best'은 지금까지 정의된 9개의 위치 중 다른 그려진 아티스트와 최소한으로 겹치는 위치에 범례를 배치합니다. 이 옵션은 많은 양의 데이터가 있는 플롯의 경우 상당히 느릴 수 있습니다. 플로팅 속도는 특정 위치를 제공하면 도움이 될 수 있습니다.

위치는 축 좌표에서 범례의 왼쪽 하단 모서리 좌표를 제공하는 2-튜플일 수도 있습니다(이 경우 bbox_to_anchor 는 무시됨).

이전 버전과의 호환성을 위해 (다른 위치는 아님) 철자 를 로 지정할 수도 있고 각 "문자열" 위치를 숫자 값으로 지정할 수도 있습니다.'center right''right'

위치 문자열	위치 코드
'베스트'	0
'오른쪽 위'	1
'왼쪽 위'	2
'왼쪽 아래'	삼
'오른쪽 아래'	4
'오른쪽'	5
'가운데 왼쪽'	6
'중앙 오른쪽'	7
'하단 중앙'	8
'상단 중앙'	9
'센터'	10

bbox_to_anchor BboxBase, 플로트의 2-튜플 또는 4-튜플

loc 과 함께 범례를 배치하는 데 사용되는 상자입니다 . 기본값은 axes.bbox(메소드로 호출된 경우 Axes.legend) 또는 figure.bbox(if Figure.legend)입니다. 이 인수를 사용하면 범례를 임의로 배치할 수 있습니다.

Bbox 좌표는 bbox_transform 에 의해 주어진 좌표계에서 해석되며 , 호출 에 따라 기본 변형 Axes 또는 Figure 좌표 가 사용 legend됩니다.

4-튜플 or 가 주어지면 범례가 배치되는 BboxBasebbox를 지정합니다 . 범례를 축(또는 그림)의 오른쪽 아래 사분면에서 최상의 위치에 배치하려면 다음을 수행하십시오.(x, y, width, height)

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

2-튜플 은 loc 에 의해 지정된 범례의 모서리 를 x, y에 배치합니다. 예를 들어 범례의 오른쪽 위 모서리를 축(또는 그림)의 중앙에 배치하려면 다음 키워드를 사용할 수 있습니다.(x, y)

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncols int, 기본값: 1

범례에 있는 열의 수입니다.

이전 버전과의 호환성을 위해 철자 ncol 도 지원되지만 사용하지 않는 것이 좋습니다. 둘 다 제공되면 ncols 가 우선합니다.

소품 없음 또는 matplotlib.font_manager.FontProperties또는 dict

범례의 글꼴 속성입니다. None(기본값)인 경우 전류 matplotlib.rcParams가 사용됩니다.

fontsize int 또는 {'xx-작은', 'x-작은', '작은', '중간', '대형', '대형', 'xx-대형'}

범례의 글꼴 크기입니다. 값이 숫자이면 크기는 포인트 단위의 절대 글꼴 크기가 됩니다. 문자열 값은 현재 기본 글꼴 크기에 상대적입니다. 이 인수는 prop 이 지정되지 않은 경우에만 사용됩니다 .

labelcolor str 또는 목록, 기본값: rcParams["legend.labelcolor"](기본값: 'None')

범례의 텍스트 색상입니다. 유효한 색상 문자열(예: 'red') 또는 색상 문자열 목록입니다. labelcolor는 'linecolor', 'markerfacecolor'(또는 'mfc') 또는 'markeredgecolor'(또는 'mec')를 사용하여 선 또는 마커의 색상과 일치하도록 만들 수도 있습니다.

rcParams["legend.labelcolor"]Labelcolor는 (기본값: ) 을 사용하여 전역적으로 설정할 수 있습니다 'None'. 없음인 경우 rcParams["text.color"](기본값: 'black')을 사용합니다.

numpoints int, 기본값: rcParams["legend.numpoints"](기본값: 1)

Line2D(선) 에 대한 범례 항목을 만들 때 범례의 마커 포인트 수입니다 .

산란점 int, 기본값: rcParams["legend.scatterpoints"](기본값: 1)

PathCollection(산점도) 에 대한 범례 항목을 생성할 때 범례의 마커 포인트 수입니다 .

float의 반복 가능한 scatteryoffsets , 기본값:[0.375, 0.5, 0.3125]

산점도 범례 항목에 대해 생성된 마커의 세로 오프셋(글꼴 크기 기준)입니다. 0.0은 범례 텍스트의 기본이고 1.0은 맨 위에 있습니다. 모든 마커를 같은 높이에 그리려면 로 설정합니다 [0.5].

markerscale float, 기본값: rcParams["legend.markerscale"](기본값: 1.0)

원래 그려진 마커와 비교한 범례 마커의 상대적인 크기입니다.

markerfirst 부울, 기본값: True

True 이면 범례 마커가 범례 레이블 왼쪽에 배치됩니다. False 이면 범례 마커가 범례 레이블 오른쪽에 배치됩니다.

프레임온 부울, 기본값: rcParams["legend.frameon"](기본값: True)

범례를 패치(프레임)에 그려야 하는지 여부입니다.

fancybox 부울, 기본값: rcParams["legend.fancybox"](기본값: True)

FancyBboxPatch범례의 배경을 구성하는 주변에 둥근 모서리를 활성화할지 여부 입니다.

섀도우 부울, 기본값: rcParams["legend.shadow"](기본값: False)

범례 뒤에 그림자를 그릴지 여부입니다.

framealpha float, 기본값: rcParams["legend.framealpha"](기본값: 0.8)

범례 배경의 알파 투명도입니다. 그림자 가 활성화되고 framealpha 가 이면 None기본값이 무시됩니다.

facecolor "상속" 또는 색상, 기본값: rcParams["legend.facecolor"](기본값: 'inherit')

범례의 배경색입니다. "inherit"인 경우 rcParams["axes.facecolor"](기본값: 'white')을 사용합니다.

edgecolor "상속" 또는 색상, 기본값: rcParams["legend.edgecolor"](기본값: '0.8')

범례의 배경 패치 가장자리 색상입니다. 인 경우 "inherit"take rcParams["axes.edgecolor"](기본값: 'black')를 사용합니다.

모드 {"확장", 없음}

모드 가 설정 되면 "expand"범례가 수평으로 확장되어 축 영역을 채웁니다(또는 범례의 크기를 정의하는 경우 bbox_to_anchor ).

bbox_transform 없음 또는matplotlib.transforms.Transform

경계 상자( bbox_to_anchor )의 변환입니다. (기본값) 값의 None경우 축의 transAxes변형이 사용됩니다.

제목 문자열 또는 없음

전설의 제목. 기본값은 제목 없음( None)입니다.

title_fontproperties 없음 또는 matplotlib.font_manager.FontProperties또는 사전

범례 제목의 글꼴 속성입니다. None(기본값)인 경우 title_fontsize 인수가 있으면 사용됩니다. title_fontsize 도 None이면 현재 ( rcParams["legend.title_fontsize"]기본값: None)가 사용됩니다.

title_fontsize int 또는 {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, 기본값: rcParams["legend.title_fontsize"](기본값: None)

범례 제목의 글꼴 크기입니다. 참고: 이는 title_fontproperties 와 결합할 수 없습니다 . 다른 글꼴 속성과 함께 글꼴 크기를 설정하려면 title_fontproperties 에서 크기 매개변수를 사용하세요 .

정렬 {'가운데', '왼쪽', '오른쪽'}, 기본값: '가운데'

범례 제목과 항목 상자의 정렬. 항목은 단일 블록으로 정렬되므로 마커가 항상 정렬됩니다.

borderpad float, 기본값: rcParams["legend.borderpad"](기본값: 0.4)

범례 테두리 내부의 소수 공백(글꼴 크기 단위)입니다.

레이블 간격 부동, 기본값: rcParams["legend.labelspacing"](기본값: 0.5)

범례 항목 사이의 세로 간격(글꼴 크기 단위)입니다.

핸들 길이 부동, 기본값: rcParams["legend.handlelength"](기본값: 2.0)

글꼴 크기 단위의 범례 핸들 길이입니다.

핸들 높이 부동, 기본값: rcParams["legend.handleheight"](기본값: 0.7)

범례 핸들의 높이(글꼴 크기 단위)입니다.

handletextpad float, 기본값: rcParams["legend.handletextpad"](기본값: 0.8)

범례 핸들과 텍스트 사이의 패드(글꼴 크기 단위)입니다.

borderaxespad float, 기본값: rcParams["legend.borderaxespad"](기본값: 0.5)

글꼴 크기 단위의 축과 범례 테두리 사이의 패드입니다.

열 간격 부동, 기본값: rcParams["legend.columnspacing"](기본값: 2.0)

열 사이의 간격(글꼴 크기 단위)입니다.

handler_map 사전 또는 없음

인스턴스 또는 유형을 범례 핸들러에 매핑하는 사용자 정의 사전. 이 handler_map 은 에 있는 기본 핸들러 맵을 업데이트합니다 matplotlib.legend.Legend.get_legend_handler_map.

메모

사용자는 bbox_to_anchor 키워드 인수 를 사용하여 범례의 임의 위치를 ​​지정할 수 있습니다 . bbox_to_anchorBboxBase 는 2개 또는 4개의 float로 구성된 튜플(또는 여기에서 파생됨) 일 수 있습니다 . 자세한 내용 set_bbox_to_anchor은 참조하십시오.

범례 위치 는 정규화된 축 좌표에서 범례의 왼쪽 아래 모서리로 해석되는 2개의 부동 소수점 튜플을 사용하여 loc 을 설정하여 지정할 수 있습니다 .

코드 = {'최고': 0, '중앙': 10, ' 왼쪽 중앙': 6, ' 오른쪽 중앙': 7, '중앙 하단 ': 8, ' 왼쪽 하단': 3, ' 오른쪽 하단': 4, '오른쪽': 5, ' 가운데 위': 9, ' 왼쪽 위': 2, ' 오른쪽 위': 1}

포함 ( 이벤트 )

아티스트에 마우스 이벤트가 포함되어 있는지 테스트합니다.

매개변수 :

마우스 이벤트matplotlib.backend_bases.MouseEvent

반환 :

부울 포함

반지름 내에 값이 있는지 여부입니다.

세부 정보

선택 반경에 포함된 지점과 같은 이벤트 컨텍스트 세부 정보의 아티스트별 사전입니다. 자세한 내용은 개별 아티스트 하위 클래스를 참조하세요.

그리기 ( 렌더러 )

지정된 렌더러를 사용하여 아티스트(및 그 자식)를 그립니다.

아티스트가 보이지 않으면 효과가 없습니다( Artist.get_visible False 반환).

매개변수 :

렌더러 RendererBase하위 클래스.

메모

이 메서드는 Artist 하위 클래스에서 재정의됩니다.

draw_frame ( b )

범례 상자 패치를 그릴지 여부를 설정합니다.

매개변수 :

b 부울

get_alignment ( )

범례 상자의 정렬 값 가져오기

get_bbox_to_anchor ( )

범례가 고정될 bbox를 반환합니다.

get_children ( )

Artistthis 의 자식 목록을 반환합니다 Artist.

classmethod get_default_handler_map ( )

모든 범례가 공유하는 전역 기본 핸들러 맵을 반환합니다.

get_draggable ( )

True범례를 드래그할 수 있으면 반환 하고 False그렇지 않으면 반환합니다.

get_frame ( )

Rectangle범례를 구성하는 데 사용된 를 반환합니다 .

get_frame_on ( )

범례 상자 패치가 그려졌는지 가져옵니다.

static get_legend_handler ( legend_handler_map , orig_handle )

orig_handler 에 해당하는 legend_handler_map 에서 범례 핸들러를 반환합니다 .

legend_handler_map 은 사전 객체여야 합니다(get_legend_handler_map 메서드에서 반환됨).

먼저 orig_handle 자체가 legend_handler_map의 키 인지 확인 하고 관련 값을 반환합니다. 그렇지 않으면 메서드 해결 순서에서 각 클래스를 확인합니다. 일치하는 키가 없으면 를 반환합니다 None.

get_legend_handler_map ( )

이 범례 인스턴스의 핸들러 맵을 반환합니다.

get_lines ( )

Line2D범례 의 s 목록을 반환합니다 .

get_patches ( )

Patch범례 의 s 목록을 반환합니다 .

get_texts ( )

Text범례 의 s 목록을 반환합니다 .

get_tightbbox ( 렌더러 = 없음 )

와 Artist.get_window_extent같지만 클리핑이 포함됩니다.

매개변수 :

렌더러 RendererBase서브클래스

그림을 그리는 데 사용할 렌더러(예: fig.canvas.get_renderer())

반환 :

Bbox

둘러싸는 경계 상자(그림 픽셀 좌표).

get_title ( )

Text범례 제목 의 인스턴스를 반환합니다 .

get_window_extent ( 렌더러 = 없음 )

디스플레이 공간에서 아티스트의 경계 상자를 가져옵니다.

경계 상자의 너비와 높이는 음수가 아닙니다.

하위 클래스는 경계 상자 "단단한" 계산에 포함되도록 재정의해야 합니다. 기본값은 0, 0에서 빈 경계 상자를 반환하는 것입니다.

이 기능을 사용할 때 주의하십시오. 아티스트의 아티스트 창 범위가 변경되면 결과가 업데이트되지 않습니다. 범위는 축 제한, 그림 크기 또는 사용된 캔버스 변경과 같은 변환 스택의 변경으로 인해 변경될 수 있습니다(그림을 저장할 때 수행됨). 이로 인해 인터랙티브 Figure가 화면에서는 정상적으로 보이지만 잘못 저장되는 예기치 않은 동작이 발생할 수 있습니다.

set ( * , agg_filter=<UNSET> , alignment=<UNSET> , alpha=<UNSET> , animated=<UNSET> , bbox_to_anchor=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET > , draggable=<UNSET> , frame_on=<UNSET> , gid=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , ncols=<UNSET> , path_effects=<UNSET> , 선택기=<설정 해제> ,래스터화=<설정 해제> ,sketch_params=<UNSET> , snap=<UNSET> , title=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , zorder=<UNSET> )

한 번에 여러 속성을 설정합니다.

지원되는 속성은

재산	설명
agg_filter	(m, n, 3) 부동 소수점 배열과 dpi 값을 사용하고 (m, n, 3) 배열과 이미지의 왼쪽 하단에서 두 오프셋을 반환하는 필터 함수
alignment	{'가운데', '왼쪽', '오른쪽'}.
alpha	스칼라 또는 없음
animated	부울
bbox_to_anchor	BboxBase또는 튜플
clip_box	Bbox
clip_on	부울
clip_path	패치 또는 (경로, 변환) 또는 없음
draggable	부울
figure	Figure
frame_on	부울
gid	str
in_layout	부울
label	물체
mouseover	부울
ncols	알려지지 않은
path_effects	AbstractPathEffect
picker	None 또는 bool 또는 float 또는 호출 가능
rasterized	부울
sketch_params	(스케일: float, 길이: float, 임의성: float)
snap	부울 또는 없음
title	str
transform	Transform
url	str
visible	부울
zorder	뜨다

set_alignment ( 정렬 )

범례 제목과 항목 상자의 정렬을 설정합니다.

항목은 단일 블록으로 정렬되므로 마커가 항상 정렬됩니다.

매개변수 :

정렬 {'가운데', '왼쪽', '오른쪽'}.

set_bbox_to_anchor ( bbox , 변환 = 없음 )

범례가 고정될 bbox를 설정합니다.

매개변수 :

bbox BboxBase또는 튜플

경계 상자는 다음과 같은 방법으로 지정할 수 있습니다.

• BboxBase인스턴스 _

• 주어진 변환 의 튜플 (None인 경우 정규화된 축 좌표)(left, bottom, width, height)

• 너비와 높이가 0으로 간주되는 튜플입니다 .(left, bottom)

• None , bbox 앵커링을 제거하고 상위 bbox를 사용합니다.

변형 Transform, 선택 사항

경계 상자에 적용할 변환입니다. 지정하지 않으면 부모의 경계 상자에 대한 변환을 사용합니다.

classmethod set_default_handler_map ( handler_map )

모든 범례가 공유하는 전역 기본 핸들러 맵을 설정합니다.

set_draggable ( state , use_blit = False , update = 'loc' )

범례의 마우스 끌기 지원을 활성화하거나 비활성화합니다.

매개변수 :

상태 부울

마우스 드래그 활성화 여부.

use_blit 부울, 선택 사항

더 빠른 이미지 합성을 위해 블리팅을 사용하십시오. 자세한 내용은 FuncAnimation 을 참조하십시오 .

업데이트 {'loc', 'bbox'}, 선택사항

드래그할 때 변경할 범례 매개변수:

• 'loc': 범례 의 loc 매개변수 업데이트

• 'bbox': 범례의 bbox_to_anchor 매개변수 업데이트

반환 :

DraggableLegend또는 없음

상태 인 경우 헬퍼 인스턴스를 True반환합니다 . DraggableLegend그렇지 않으면 None 을 반환합니다 .

set_frame_on ( b )

범례 상자 패치를 그릴지 여부를 설정합니다.

매개변수 :

b 부울

set_ncols ( ncols )

열 수를 설정합니다.

set_title ( 제목 , 소품 = 없음 )

범례 제목 및 제목 스타일을 설정합니다.

매개변수 :

제목 문자열

범례 제목입니다.

소품 font_manager.FontProperties또는 str또는pathlib.Path

범례 제목의 글꼴 속성입니다. 이면 에 str의해 구문 분석된 fontconfig 패턴으로 해석됩니다 FontProperties. 이면 pathlib.Path글꼴 파일의 절대 경로로 해석됩니다.

classmethod update_default_handler_map ( handler_map )

모든 범례가 공유하는 전역 기본 핸들러 맵을 업데이트합니다.

조오더 = 5