特定地图区域的文本标签

geo.regions[i].label

Object

图形上的文本标签，可用于说明图形的一些数据信息， 比如值，名称等，label 选项在 ECharts 2.x 中放置于 itemStyle .normal 下

在 ECharts 3 中为了让整个配置项结构更扁平合理，label 被拿出来跟 itemStyle 平级，并且跟 itemStyle 一样拥有 normal，emphasis 两个状态。

geo.regions[i].label.normal

Object 通过 normal 状态设置 ECharts 特定地图区域的文本标签。

geo.regions[i].label.normal.show

boolean [ 默认值: false ]

是否显示标签。

geo.regions[i].label.normal.position

string, Array 标签的位置。

可选：

[x, y]通过相对的百分比或者绝对像素值表示标签相对于图形包围盒左上角的位置。

示例：

// 绝对的像素值 position: [10, 10], // 相对的百分比 position: ['50%', '50%']

• 'top'
• 'left'
• 'right'
• 'bottom'
• 'inside'
• 'insideLeft'
• 'insideRight'
• 'insideTop'
• 'insideBottom'
• 'insideTopLeft'
• 'insideBottomLeft'
• 'insideTopRight'
• 'insideBottomRight'

geo.regions[i].label.normal.distance

number [ 默认值: 5 ]

距离图形元素的距离。当 position 为字符描述值（如 'top'、'insideRight'）时候有效。

参见：label position。

geo.regions[i].label.normal.rotate

number 标签旋转。从 -90 度到 90 度。正值是逆时针。

参见：label rotation。

geo.regions[i].label.normal.offset

Array 是否对文字进行偏移。默认不偏移。例如：[30, 40] 表示文字在横向上偏移 30，纵向上偏移 40。

geo.regions[i].label.normal.formatter

string, Function 标签内容格式器，支持字符串模板和回调函数两种形式，字符串模板与回调函数返回的字符串均支持用 \n 换行。

字符串模板

模板变量有 {a}、{b}、{c}，分别表示系列名，数据名，数据值。

示例：

formatter: '{b}: {c}'

回调函数

回调函数格式：

(params: Object|Array) => string

参数 params 是 formatter 需要的单个数据集。格式如下：

{
    componentType: 'series',
    // 系列类型
    seriesType: string,
    // 系列在传入的 option.series 中的 index
    seriesIndex: number,
    // 系列名称
    seriesName: string,
    // 数据名，类目名
    name: string,
    // 数据在传入的 data 数组中的 index
    dataIndex: number,
    // 传入的原始数据项
    data: Object,
    // 传入的数据值
    value: number|Array,
    // 数据图形的颜色
    color: string,

}

geo.regions[i].label.normal.color

Color [ 默认值: "#fff" ]

文字的颜色。

如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。

geo.regions[i].label.normal.fontStyle

string [ 默认值: 'normal' ]

文字字体的风格

可选：

• 'normal'
• 'italic'
• 'oblique'

geo.regions[i].label.normal.fontWeight

string [ 默认值: normal ]

文字字体的粗细

可选：

• 'normal'
• 'bold'
• 'bolder'
• 'lighter'
• 100 | 200 | 300 | 400...

geo.regions[i].label.normal.fontFamily

string [ 默认值: 'sans-serif' ]

文字的字体系列

还可以是 'serif' , 'monospace', 'Arial', 'Courier New', 'Microsoft YaHei', ...

geo.regions[i].label.normal.fontSize

number [ 默认值: 12 ]

文字的字体大小

geo.regions[i].label.normal.align

string 文字水平对齐方式，默认自动。

可选：

• 'left'
• 'center'
• 'right'

rich 中如果没有设置 align，则会取父层级的 align。例如：

{
    align: right,
    rich: {
        a: {
            // 没有设置 `align`，则 `align` 为 right
        }
    }
}

geo.regions[i].label.normal.verticalAlign

string 文字垂直对齐方式，默认自动。

可选：

• 'top'
• 'middle'
• 'bottom'

rich 中如果没有设置 verticalAlign，则会取父层级的 verticalAlign。例如：

{
    verticalAlign: bottom,
    rich: {
        a: {
            // 没有设置 `verticalAlign`，则 `verticalAlign` 为 bottom
        }
    }
}

geo.regions[i].label.normal.lineHeight

number 文本标签的行高。

rich 中如果没有设置 lineHeight，则会取父层级的 lineHeight。例如：

{
    lineHeight: 56,
    rich: {
        a: {
            // 没有设置 `lineHeight`，则 `lineHeight` 为 56
        }
    }
}

geo.regions[i].label.normal.backgroundColor

string, Object [ 默认值: 'transparent' ]

文字块背景色。

可以是直接的颜色值，例如：'#123234', 'red', rgba(0,23,11,0.3)'。

可以支持使用图片，例如：

backgroundColor: {
    image: 'xxx/xxx.png'
    // 这里可以是图片的 URL，
    // 或者图片的 dataURI，
    // 或者 HTMLImageElement 对象，
    // 或者 HTMLCanvasElement 对象。
}

当使用图片的时候，可以使用 width 或 height 指定高宽，也可以不指定自适应。

如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。

geo.regions[i].label.normal.borderColor

string [ 默认值: 'transparent' ]

文字块边框颜色。

如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。

geo.regions[i].label.normal.borderWidth

number [ 默认值: 0 ]

文字块边框宽度。

geo.regions[i].label.normal.borderRadius

number, Array [ 默认值: 0 ]

文字块的圆角。

geo.regions[i].label.normal.padding

number, Array [ 默认值: 0 ]

文字块的内边距。例如：

• padding: [3, 4, 5, 6]：表示 [上, 右, 下, 左] 的边距。
• padding: 4：表示 padding: [4, 4, 4, 4]。
• padding: [3, 4]：表示 padding: [3, 4, 3, 4]。

注意，文字块的 width 和 height 指定的是内容高宽，不包含 padding。

geo.regions[i].label.normal.shadowColor

string [ 默认值: 'transparent' ]

文字块的背景阴影颜色。

geo.regions[i].label.normal.shadowBlur

number [ 默认值: 0 ]

文字块的背景阴影长度。

geo.regions[i].label.normal.shadowOffsetX

number [ 默认值: 0 ]

文字块的背景阴影 X 偏移。

geo.regions[i].label.normal.shadowOffsetY

number [ 默认值: 0 ]

文字块的背景阴影 Y 偏移。

geo.regions[i].label.normal.width

number, string 文字块的宽度。一般不用指定，不指定则自动是文字的宽度。在想做表格项或者使用图片时，可能会使用它。

注意，文字块的 width 和 height 指定的是内容高宽，不包含 padding。

width 也可以是百分比字符串，如 '100%'。表示的是所在文本块的 contentWidth（即不包含文本块的 padding）的百分之多少。

之所以以 contentWidth 做基数，因为每个文本片段只能基于 content box 布局。如果以 outerWidth 做基数，则百分比的计算在实用中不具有意义，可能会超出。

注意，如果不定义 rich 属性，则不能指定 width 和 height。

geo.regions[i].label.normal.height

number, string 文字块的高度。一般不用指定，不指定则自动是文字的高度。在使用图片时，可能会使用它。

注意，文字块的 width 和 height 指定的是内容高宽，不包含 padding；如果不定义 rich 属性，则不能指定 width 和 height。

geo.regions[i].label.normal.textBorderColor

string [ 默认值: 'transparent' ]

文字本身的描边颜色。

如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。

geo.regions[i].label.normal.textBorderWidth

number [ 默认值: 0 ]

文字本身的描边宽度。

geo.regions[i].label.normal.textShadowColor

string [ 默认值: 'transparent' ]

文字本身的阴影颜色。

geo.regions[i].label.normal.textShadowBlur

number [ 默认值: 0 ]

文字本身的阴影长度。

geo.regions[i].label.normal.textShadowOffsetX

number [ 默认值: 0 ]

文字本身的阴影 X 偏移。

geo.regions[i].label.normal.textShadowOffsetY

number [ 默认值: 0 ]

文字本身的阴影 Y 偏移。

geo.regions[i].label.normal.rich

Object 在 rich 里面，可以自定义富文本样式。利用富文本样式，可以在标签中做出非常丰富的效果。

例如：

label: {
    normal: {

        // 在文本中，可以对部分文本采用 rich 中定义样式。
        // 这里需要在文本中使用标记符号：
        // `{styleName|text content text content}` 标记样式名。
        // 注意，换行仍是使用 '\n'。
        formatter: [
            '{a|这段文本采用样式a}',
            '{b|这段文本采用样式b}这段用默认样式{x|这段用样式x}'
        ].join('\n'),

        rich: {
            a: {
                color: 'red',
                lineHeight: 10
            },
            b: {
                backgroundColor: {
                    image: 'xxx/xxx.jpg'
                },
                height: 40
            },
            x: {
                fontSize: 18,
                fontFamily: 'Microsoft YaHei',
                borderColor: '#449933',
                borderRadius: 4
            },
            ...
        }
    }
}