{{ target: action-series-query }}// 可选，系列 index，可以是一个数组指定多个系列 seriesIndex?: number|Array, // 可选，系列名称，可以是一个数组指定多个系列 seriesName?: string|Array,{{/target}}

{{ target: action-data-query }}// 数据的 index，如果不指定也可以通过 name 属性根据名称指定数据 dataIndex?: number, // 可选，数据名称，在有 dataIndex 的时候忽略 name?: string{{/target}}

{{ target: action }}

action

ECharts 中支持的图表行为，通过 dispatchAction 触发。

注： 代码中的 ?: 表示该属性是可选的。EVENT: 是 action 对应触发的事件。

highlight(Action)

高亮指定的数据图形。

通过seriesName或者seriesIndex指定系列。如果要再指定某个数据可以再指定dataIndex或者name。

dispatchAction({
    type: 'highlight',
    {{ use: action-series-query }}
    // 可选，数据的 index
    dataIndex?: number,
    // 可选，数据的 名称
    name?: string
})

downplay(Action)

取消高亮指定的数据图形。

通过seriesName或者seriesIndex指定系列。如果要指定某个数据可以再指定dataIndex或者name。

dispatchAction({
    type: 'downplay',
    {{ use: action-series-query }}
    // 可选，数据的 index
    dataIndex?: number,
    // 可选，数据的 名称
    name?: string
})

legend

图例组件相关的行为，必须引入图例组件后才能使用。

legendSelect(Action)

选中图例。

dispatchAction({
    type: 'legendSelect',
    // 图例名称
    name: string
})

EVENT: legendselected

legendUnSelect(Action)

取消选中图例。

dispatchAction({
    type: 'legendUnSelect',
    // 图例名称
    name: string
})

EVENT: legendunselected

legendToggleSelect(Action)

切换图例的选中状态。

dispatchAction({
    type: 'legendToggleSelect',
    // 图例名称
    name: string
})

EVENT: legendselectchanged

legendScroll(Action)

控制图例的滚动。当 legend.type 为 'scroll' 时有效。

dispatchAction({
    type: 'legendScroll',
    scrollDataIndex: number,
    legendId: string
})

EVENT: legendscroll

tooltip

提示框组件相关的行为，必须引入提示框组件后才能使用。

showTip(Action)

显示提示框。

有下面两种使用方式。

1 指定在相对容器的位置处显示提示框，如果指定的位置无法显示则无效。

dispatchAction({
    type: 'showTip',
    // 屏幕上的 x 坐标
    x: number,
    // 屏幕上的 y 坐标
    y: number,
    // 本次显示 tooltip 的位置。只在本次 action 中生效。
    // 缺省则使用 option 中定义的 tooltip 位置。
    position: Array.<number>|string|Function
})

2 指定数据图形，根据 tooltip 的配置项显示提示框。

dispatchAction({
    type: 'showTip',
    // 系列的 index，在 tooltip 的 trigger 为 axis 的时候可选。
    seriesIndex?: number,
    {{ use: action-data-query }},
    // 本次显示 tooltip 的位置。只在本次 action 中生效。
    // 缺省则使用 option 中定义的 tooltip 位置。
    position: Array.<number>|string|Function,
})

参数position同tooltip.position相同。

hideTip(Action)

隐藏提示框。

dispatchAction({
    type: 'hideTip'
})

dataZoom

数据区域缩放组件相关的行为，必须引入数据区域缩放组件后才能使用。

dataZoom(Action)

数据区域缩放。

dispatchAction({
    type: 'dataZoom',
    // 可选，dataZoom 组件的 index，多个 dataZoom 组件时有用，默认为 0
    dataZoomIndex: number,
    // 开始位置的百分比，0 - 100
    start: number,
    // 结束位置的百分比，0 - 100
    end: number,
    // 开始位置的数值
    startValue: number,
    // 结束位置的数值
    endValue: number
})

EVENT: datazoom

takeGlobalCursor(Action)

启动或关闭 toolbox 中 dataZoom 的刷选状态。

myChart.dispatchAction({
    type: 'takeGlobalCursor',
    key: 'dataZoomSelect',
    // 启动或关闭
    dataZoomSelectActive: true
});

visualMap

视觉映射组件相关的行为，必须引入视觉映射组件后才能使用。

selectDataRange(Action)

选取映射的数值范围。

dispatchAction({
    type: 'selectDataRange',
    // 可选，visualMap 组件的 index，多个 visualMap 组件时有用，默认为 0
    visualMapIndex: number,
    // 连续型 visualMap 和 离散型 visualMap 不一样
    // 连续型的是一个表示数值范围的数组。
    // 离散型的是一个对象，键值是类目或者分段的索引。值是 `true`, `false`
    selected: Object|Array
})

å 示例：

myChart.dispatchAction({
    type: 'selectDataRange',
    // 选取 20 到 40 的值范围
    selected: [20, 40],
    // 取消选中第二段
    selected: { 1: false },
    // 取消选中类目 `优`
    selected: { '优': false }
});

EVENT: datarangeselected

timeline

时间轴组件相关的行为，必须引入时间轴组件后才能使用。

timelineChange(Action)

设置当前的时间点。

dispatchAction({
    type: 'timelineChange',
    // 时间点的 index
    currentIndex: number
})

EVENT: timelinechanged

timelinePlayChange(Action)

切换时间轴的播放状态。

dispatchAction({
    type: 'timelinePlayChange',
    // 播放状态，true 为自动播放
    playState: boolean
})

EVENT: timelineplaychanged

toolbox

工具栏组件相关的行为，必须引入工具栏组件后才能使用。

restore(Action)

重置 option。

dispatchAction({
    type: 'restore'
})

EVENT: restore

pie

饼图相关的行为，必须引入饼图后才能使用。

{{ use: action-select( componentType=‘pie’, name=‘饼图扇形’ ) }}

geo

地图组件相关的行为，必须引入地图组件后才能使用。

{{ use: action-select( componentType=‘geo’, name=‘地图区域’ ) }}

map

地图图表相关的行为，必须引入地图图表后才能使用。

{{ use: action-select( componentType=‘map’, name=‘地图区域’ ) }}

graph

关系图 相关的行为，必须引入 关系图 后才能使用。

focusNodeAdjacency(Action)

将指定的节点以及其所有邻接节点高亮。

dispatchAction({
    type: 'focusNodeAdjacency',

    // 使用 seriesId 或 seriesIndex 或 seriesName 来定位 series.
    seriesId: 'xxx',
    seriesIndex: 0,
    seriesName: 'nnn',

    // 使用 dataIndex 来定位节点。
    dataIndex: 12
})

最后会抛出 focusNodeAdjacency 事件。

unfocusNodeAdjacency(Action)

将指定的节点以及其所有邻接节点高亮。

dispatchAction({
    type: 'unfocusNodeAdjacency',

    // 使用 seriesId 或 seriesIndex 或 seriesName 来定位 series.
    seriesId: 'xxx',
    seriesIndex: 0,
    seriesName: 'nnn'
})

最后会抛出 unfocusNodeAdjacency 事件。

brush

区域选择相关的行为。

brush

触发此 action 可设置或删除 chart 中的选框，例如：

myChart.dispatchAction({
    type: 'brush',
    areas: [ // areas 表示选框的集合，可以指定多个选框。
             // 如果 areas 为空，则删除所有选框。
             // 注意这并非增量接口而是全量接口，所以应包括所有的选框。
        { // 选框一：

            // 指定此选框是“坐标系选框”，属于 index 为 0 的 geo 坐标系。
            // 也可以通过 xAxisIndex 或 yAxisIndex 来指定此选框属于直角坐标系。
            // 如果没有指定，则此选框属于“全局选框”。不属于任何坐标系。
            // 属于『坐标系选框』，可以随坐标系一起缩放平移。属于全局的选框不行。
            geoIndex: 0,
            // xAxisIndex: 0,
            // yAxisIndex: 0,

            // 指定选框的类型。可以为 'polygon', 'rect', 'lineX', 'lineY'
            brushType: 'polygon',

            // 如果是“全局选框”，则使用 range 来描述选框的范围（里面是像素坐标）。
            range: [
                ...
            ],
            // 如果是“坐标系选框”，则使用 coordRange 来指定选框的范围（里面是坐标系坐标）。
            coordRange: [
                // 这个例子中，因为指定了 geoIndex，所以 coordRange 里单位是经纬度。
                [119.72,34.85],[119.68,34.85],[119.5,34.84],[119.19,34.77]
            ]
        },
        ... // 选框二、三、四、...
    ]
});

其中，areas 中的 range 和 coordRange 的格式，根据 brushType 不同而不同：

• brushType 为 ‘rect’ range 和 coordRange 的格式为：[[minX, maxX], [minY, maxY]]
• brushType 为 ‘lineX’ 或 ‘lineY’ range 和 coordRange 的格式为：[min, maxX]
• brushType 为 ‘polygon’ range 和 coordRange 的格式为：[[point1X, point1X], [point2X, point2X], ...]

range 和 coordRange 的区别是：

• 当此选框为『全局选框』时，使用 range。
• 当此选框为『坐标系选框』时（即指定了 geoIndex 或 xAxisIndex 或 yAxisIndex 时），使用 coordRange。
• range 的单位为 像素，coordRange 的单位为 坐标系单位，比如 geo 中，coordRange 单位为经纬度，直角坐标系中，coordRange 单位为对应轴的数据的单位。

takeGlobalCursor

刷选模式的开关。使用此 action 可将当前鼠标变为可刷选状态。 事实上，点击 toolbox 中的 brush 按钮时，就是通过这个 action，将当前普通鼠标变为刷选器的。例如：

此 action 对应的事件为 globalCursorTaken。

api.dispatchAction({
    type: 'takeGlobalCursor',
    // 如果想变为“可刷选状态”，必须设置。不设置则会关闭“可刷选状态”。
    key: 'brush',
    brushOption: {
        // 参见 brush 组件的 brushType。如果设置为 false 则关闭“可刷选状态”。
        brushType: string,
        // 参见 brush 组件的 brushMode。如果不设置，则取 brush 组件的 brushMode 设置。
        brushMode: string
    }
});

{{ target: action-select }}

${componentType}Select(Action)

选中指定的${name}。

dispatchAction({
    type: '${componentType}Select',
    {{ use: action-series-query }}
    {{ use: action-data-query }}
})

EVENT: ${componentType}selected

${componentType}UnSelect(Action)

取消选中指定的${name}。

dispatchAction({
    type: '${componentType}UnSelect',
    {{ use: action-series-query }}
    {{ use: action-data-query }}
})

EVENT: ${componentType}unselected

${componentType}ToggleSelect(Action)

切换指定的${name}选中状态。

dispatchAction({
    type: '${componentType}ToggleSelect',
    {{ use: action-series-query }}
    {{ use: action-data-query }}
})

EVENT: ${componentType}selectchanged