1. 内容概述
Actions 主要用于控制可视化组件在设计以及预览/运行时具有哪些数据探索类的操作能力，如下图所示的红框区域中的功能（图中以柱状图设计状态为例）。
2. interface
interface IAction extends CommonDefNS.IMember {
type: ActionType;
}
3. Action Type
| action | interface | 描述 | 示例 | 设计状态下是否可用 | 运行状态下是否可用 |
|---|---|---|---|---|---|
filter | 为可视化组件添加数据过滤功能。
| {
"type": "filter"
}
| y | y | |
sort | 为可视化组件添加排序功能。
当启用sort功能后， 需要在消费dataView的地方自行根据dataView的sort字段信息对数据进行排序 | {
"type": "sort"
}
| y | y | |
rank | 为可视化组件添加排名功能。
| {
"type": "rank"
}
| y | y | |
convertVisual | interface IConvertVisualAction extends IAction {
disableChangePivotSetting?: boolean;
disableChangeChartType?: boolean;
}
| 为组件增加设计状态时转换图表类型的功能和运行状态下修改数据绑定的功能。
| {
"type": "convertVisual"
}
| y | y |
edit | 为组件添加编辑能力，例如内置的富文本或筛选器组件。
| {
"type": "edit"
}
| y | n | |
focus | 为组件添加聚焦功能。
| {
"type": "focus"
}
| y | y | |
showData | interface IShowDataAction extends IAction {
disableCustomData?: boolean;
rule: DataBindingDefNS.IConversionRules;
}
| 为组件添加聚焦状态时显示数据透视表的能力。
参数：
| {
"type": "showData",
"rule":
{
"out": [
{
"mode": "post",
"execute": [
{
"source": "dimensions",
"target": "columns",
"cmd": "all"
}]
}]
}
}
| y | n |
export | interface IExportAction extends IAction {
disablePNG?: boolean;
disableExcel?: boolean;
}
| 为组件添加导出能力。
参数： disablePNG：禁用“导出PNG图片” disableExcel：禁用“导出数据”。 | {
"type": "export"
}
| n | y |
annotation | 为组件添加批注功能。
| {
"type": "annotation"
}
| y | n | |
extension （扩展操作） | enum ExtensionType {
Toggle = 'toggle',
Enum = 'enum',
ReferenceLine = '_referenceLine',
TrendLine = '_trendLine',
ImagePicker = '_imagePicker',
ConditionalFormat = '_conditionalFormat',
}
interface IExtensionAction extends IAction {
path: string;
extensionType: ExtensionType;
horizontal?: boolean;
}
interface IToggleExtension extends IExtensionAction {
toggleState?: Array<CommonDefNS.ILocalizable & CommonDefNS.IIconable>;
}
interface IEnumExtension extends IExtensionAction {
items: CommonDefNS.IEnumItem[];
}
interface IReferenceLineExtension extends IExtensionAction {
axis?: CommonDefNS.IEnumItem[];
_scope?: boolean;
_constOnly?: boolean;
}
interface IConditionalFormatExtension extends IExtensionAction {
roleNameList?: string[];
dataRole?: string;
}
| Extension action is a special action. It will map the value from the visual property. So you can add some property editor on action bar. Currently, we support toggle, enum editor. 用于将组件的某些属性映射到操作栏中。这样您就可以将部分常用属性的设置添加到操作栏中，使其用起来更加便利。 目前支持添加到操作栏中的属性包括切换类型（toggle）和枚举类型（enum）的属性。 注意 当添加了扩展项以后，需要添加关键字“path”，它的值为属性的名称。 参数： path：映射的属性名称。 extensionType：对应的操作 horizontal: 应显示为水平还是垂直。 Toggle特有参数： toggleState: 定义 true 状态时的表现和icon；false 状态时的表现和icon。 Enum特有参数： item:下拉项目。 | {
"type": "extension",
"name": "showBorder",
"displayName": "Show Border",
"path": "showBorder",
"extensionType": "toggle",
"toggleState": [
{
"displayName": "show",
"iconCss": "icon-expand"
},
{
"displayName": "hide",
"iconCss": "icon-expand"
}]
}
| y | y |
event （事件类操作） | interface IEventAction extends IAction {
horizontal?: boolean;
}
| 自定义操作按钮。 在EventService上添加一个侦听器，如果单击此操作按钮，则将调用callback。 | {
"name": "log",
"type": "event",
"icon": "",
"displayName": "Log Event Test"
}
| y | y |
