[pyecharts1.7] 图例设置

本文档以及pyecharts使用手册（超链接）中的其他文档）将会持续更新。 有些内容标记为待更新的，有时间我会补充上。个人精力有限，优先发布在公众号上，有兴趣的可以关注一下哈：微信公众号「燃烧吧数据」(id：data-fired)

---

图例组件包括图例标记和图例文字。可以通过点击图例控制哪些系列不显示。

图例的设置在opts.LegendOpts()中

python3样例代码

from pyecharts import options as opts
from pyecharts.charts import Pie

data = [
    ['衬衫', 72],
    ['毛衣', 136],
    ['领带', 72],
    ['裤子', 105],
    ['风衣', 24],
    ['高跟鞋', 75],
    ['袜子', 92]
]

instance1 = (
    Pie()
        .add(series_name='', data_pair=data)
        .set_global_opts(
        title_opts=opts.TitleOpts(title="图例设置基本示例"),
        legend_opts=opts.LegendOpts(
            type_='plain',  # Optional[str]
            selected_mode='multiple',  # Union[str, bool, None]
            is_show=True,  # bool
            pos_left='right',  # Union[str, Numeric, None]
            pos_right='',  # Union[str, Numeric, None]
            pos_top='50%',  # Union[str, Numeric, None]
            pos_bottom='',  # Union[str, Numeric, None]
            orient='vertical',  # Optional[str]
            align='left',  # Optional[str]
            padding=[5, 10],  # int
            item_gap=15,  # int
            item_width=20,  # int
            item_height=20,  # int
            inactive_color='green',  # Optional[str]
            textstyle_opts=opts.TextStyleOpts(
                color='red',  # Optional[str]
                font_style=None,  # Optional[str]
                font_weight=None,  # Optional[str]
                font_family=None,  # Optional[str]
                font_size=None,  # Optional[Numeric]
                align=None,  # Optional[str]
                vertical_align=None,  # Optional[str]
                line_height=None,  # Optional[str]
                background_color='yellow',  # Optional[str]
                border_color=None,  # Optional[str]
                border_width=20,  # Optional[Numeric]
                border_radius=None,  # Union[Numeric, Sequence, None]
                padding=None,  # Union[Numeric, Sequence, None]
                shadow_color=None,  # Optional[str]
                shadow_blur=None,  # Optional[Numeric]
                width='',  # Optional[str]
                height='',  # Optional[str]
                rich=None,  # Optional[dict]
            ),  # Union[TextStyleOpts, dict, None]
            legend_icon='diamond'
        )
    )
)

type_ ：图例的类型

• 'plain'：普通图例。缺省就是普通图例。
• 'scroll'：可滚动翻页的图例。当图例数量较多时可以使用。

参见 滚动图例（垂直） 或 滚动图例（水平）。

selected_mode ：图例选择的模式

控制是否可以通过点击图例改变系列的显示状态。默认开启图例选择，可以设成 false 关闭。

除此之外也可以设成 'single' 或者 'multiple' 使用单选或者多选模式。

is_show ：是否显示图例

pos_left ：图例组件离容器左侧的距离

left 的值可以是像 20 这样的具体像素值，可以是像 '20%' 这样相对于容器高宽的百分比，也可以是 'left', 'center', 'right'。

如果 left 的值为'left', 'center', 'right'，组件会根据相应的位置自动对齐。

pos_right ：图例组件离容器右侧的距离

right 的值可以是像 20 这样的具体像素值，可以是像 '20%' 这样相对于容器高宽的百分比。

默认自适应。

pos_top ：图例组件离容器上侧的距离

top 的值可以是像 20 这样的具体像素值，可以是像 '20%' 这样相对于容器高宽的百分比，也可以是 'top', 'middle', 'bottom'。

如果 top 的值为'top', 'middle', 'bottom'，组件会根据相应的位置自动对齐。

pos_bottom ：图例组件离容器下侧的距离

bottom 的值可以是像 20 这样的具体像素值，可以是像 '20%' 这样相对于容器高宽的百分比。

默认自适应。

orient ：图例列表的布局朝向

• 'horizontal'：水平(横向)图例
• 'vertical'：垂直(竖向)图例

align ：图例标记相对于图例文字的位置

可选：

• 'auto'
• 'left'：图例标记在图例文字的左侧
• 'right'：图例标记在图例文字的右侧

默认自动，根据组件的位置和 orient 决定。

例：当组件的 left 值为 'right' (pos_left = ‘right’)以及纵向布局（orient=‘vertical’）的时候为右对齐，即为 'right'。

padding ：图例内边距

单位px，默认各方向内边距为5，接受数组分别设定上右下左边距。

使用示例：

// 设置内边距为 5
padding: 5
// 设置上下的内边距为 5，左右的内边距为 10
padding: [5, 10]
// 分别设置四个方向的内边距
padding: [
    5,  // 上
    10, // 右
    5,  // 下
    10, // 左
]

item_gap ：图例每项之间的间隔

横向布局时为水平间隔，纵向布局时为纵向间隔。

item_width ：图例标记的宽度

默认自适应

item_height ：图例标记的宽度

默认自适应

inactive_color ：图例关闭时的颜色

textstyle_opts ：图例的文本样式。

color：文字颜色。

font_style：文字字体的风格.可选：‘normal’，‘italic’，‘oblique’

font_weight：主标题文字字体的粗细，可选：‘normal’，‘bold’，‘bolder’，‘lighter’

font_family：文字的字体系列。还可以是 ‘serif’ , ‘monospace’, ‘Arial’, ‘Courier New’, ‘Microsoft YaHei’, …

font_size：文字的字体大小

align：文字水平对齐方式，默认自动

vertical_align：文字垂直对齐方式，默认自动

line_height：行高

background_color：文字块背景色。可以是直接的颜色值，例如：’#123234’, ‘red’, ‘rgba(0,23,11,0.3)’

border_color：文字块边框颜色

border_width：文字块边框宽度

border_radius：文字块的圆角

padding：文字块的内边距。例：padding: [3, 4, 5, 6]：表示 [上, 右, 下, 左] 的边距，padding: 4：表示 padding: [4, 4, 4, 4]，padding: [3, 4]：表示 padding: [3, 4, 3, 4]

shadow_color：文字块的背景阴影颜色

shadow_blur：文字块的背景阴影长度

width：文字块的宽度

height：文字块的高度

rich：在 rich 里面，可以自定义富文本样式。利用富文本样式，可以在标签中做出非常丰富的效果。具体配置可以参考一下 https://www.echartsjs.com/tutorial.html#%E5%AF%8C%E6%96%87%E6%9C%AC%E6%A0%87%E7%AD%BE

legend_icon ：图例项的 icon

ECharts 提供的标记类型包括 'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'

可以通过 'image://url' 设置为图片，其中 URL 为图片的链接，或者 dataURI。

URL 为图片链接例如：

'image://http://xxx.xxx.xxx/a/b.png'

URL 为 dataURI 例如：

'image://data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7'

可以通过 'path://' 将图标设置为任意的矢量路径。这种方式相比于使用图片的方式，不用担心因为缩放而产生锯齿或模糊，而且可以设置为任意颜色。路径图形会自适应调整为合适的大小。路径的格式参见 SVG PathData。可以从 Adobe Illustrator 等工具编辑导出。

例如：

'path://M30.9,53.2C16.8,53.2,5.3,41.7,5.3,27.6S16.8,2,30.9,2C45,2,56.4,13.5,56.4,27.6S45,53.2,30.9,53.2z M30.9,3.5C17.6,3.5,6.8,14.4,6.8,27.6c0,13.3,10.8,24.1,24.101,24.1C44.2,51.7,55,40.9,55,27.6C54.9,14.4,44.1,3.5,30.9,3.5z M36.9,35.8c0,0.601-0.4,1-0.9,1h-1.3c-0.5,0-0.9-0.399-0.9-1V19.5c0-0.6,0.4-1,0.9-1H36c0.5,0,0.9,0.4,0.9,1V35.8z M27.8,35.8 c0,0.601-0.4,1-0.9,1h-1.3c-0.5,0-0.9-0.399-0.9-1V19.5c0-0.6,0.4-1,0.9-1H27c0.5,0,0.9,0.4,0.9,1L27.8,35.8L27.8,35.8z'