# 事件与动作

通过在节点编程中配置相应的事件和动作,可与大屏中的组件进行交互。

TIP

本节仅列出组件所共有的事件和动作说明,组件特有的事件与动作,详见 组件指南 中各组件 节点编程 部分的文档。

# 事件

  1. 当数据请求发送前: 当数据请求发送前触发。

    抛出的参数为:

    {
      "filterParam": {}, // 过滤参数
      "queryParam": {} // 查询参数
    }
    
  2. 当数据请求发送后: 当数据请求发送后触发。

    抛出的参数为:组件所携带的数据。

  3. 当上卷时(支持上卷下钻的组件): 当组件上卷时触发。

    抛出的参数为:

    {
      // 当前维度字段
      "currentField": {
        "fieldAlias": "",
        "fieldName": "",
        "fieldType": ""
      },
      // 点击维度字段
      "triggerField": {
        "fieldAlias": "",
        "fieldName": "",
        "fieldType": ""
      },
      // 图表事件参数
      "eventParams": {}
    }
    
  4. 当下钻时(支持上卷下钻的组件): 当组件下钻时触发。

    抛出的参数为:

    {
      // 当前维度字段
      "currentField": {
        "fieldAlias": "",
        "fieldName": "",
        "fieldType": ""
      },
      // 下一级维度字段
      "nextField": {
        "fieldAlias": "",
        "fieldName": "",
        "fieldType": ""
      },
      // 数据
      "data": {
        "name": "",
        "value": ""
      },
      // 图表事件参数
      "eventParams": {}
    }
    
  5. 高亮事件(支持高亮的组件): 当高亮指定的数据图形时触发。 4.3+

    抛出的参数为:

    高亮系列:

    {
       // 用 index 或 id 或 name 来指定系列。
       // 可以使用数组指定多个系列。
       seriesIndex?: number | number[],
       seriesId?: string | string[],
       seriesName?: string | string[],
    
       // 数据项的 index,如果不指定也可以通过 name 属性根据名称指定数据项
       dataIndex?: number | number[],
       // 可选,数据项名称,在有 dataIndex 的时候忽略
       name?: string | string[]
     }
    

    高亮地图组件地理坐标系:

     {
       // 用 index 或 id 或 name 来指定地图组件地理坐标系。
       // 可以用数组指定多个地图组件地理坐标系。
       geoIndex?: number | number[],
       geoId?: string | string[],
       geoName?: string | string[],
    
       // 地图组件地理坐标系中 region 名称。
       // 可以是一个数组指定多个名称。
       name?: string | string[]
     }
    
  6. 取消高亮事件(支持取消高亮的组件): 当取消高亮指定的数据图形时触发。 4.3+

    抛出的参数为:

    取消高亮系列:

    {
     // 用 index 或 id 或 name 来指定系列。
     // 可以使用数组指定多个系列。
     seriesIndex?: number | number[],
     seriesId?: string | string[],
     seriesName?: string | string[],
    
     // 数据项的 index,如果不指定也可以通过 name 属性根据名称指定数据项
     dataIndex?: number | number[],
     // 可选,数据项名称,在有 dataIndex 的时候忽略
     name?: string | string[]
    }
    

    取消高亮地图组件地理坐标系:

    {
     // 用 index 或 id 或 name 来指定地图组件地理坐标系。
     // 可以用数组指定多个地图组件地理坐标系。
     geoIndex?: number | number[],
     geoId?: string | string[],
     geoName?: string | string[],
    
     // 地图组件地理坐标系中 region 名称。
     // 可以是一个数组指定多个名称。
     name?: string | string[]
    }
    

# 动作

  1. 请求数据接口: 重新请求服务端数据,上游转换器或图层节点抛出的数据将作为参数。排序参数。4.4+

    接收的参数为:

    {
      "filter": {}, // 过滤参数
      "query": {}, // 查询参数
      "sort": {
        // 排序参数
        "fieldName": "ASC" // key:字段名 value: ASC | DESC
      }
    }
    
  2. 导入数据接口: 按组件绘制格式处理数据后,导入组件,重新绘制。不需要重新请求服务端数据。

    接收的参数为:组件所携带的数据。

  3. 更新组件配置: 再次更新组件配置。需要首先在组件的配置面板中,单击复制配置到剪贴板,获取组件配置数据。再根据需要,在节点编程配置页面的数据处理节点中,更改对应样式的字段值。

    接收的参数为:组件的配置数据。

  4. 显示: 显示组件。

  5. 隐藏: 隐藏组件。

  6. 上卷(支持上卷下钻的组件): 组件上卷。

    接收的参数为:

    {
      "fieldName": "", // 字段名
      "fieldAlias": "" // 中文名
    }
    
  7. 下钻(支持上卷下钻的组件): 组件下钻。

    接收的参数为:

    {
      "name": "", // 下钻字段名称
      "seriesIndex": 0 // 系列下标
    }
    
  8. 高亮图形(支持数据图形高亮的组件): 数据图形高亮。 4.3+

    接收的参数为:

    高亮系列:

    {
       // 用 index 或 id 或 name 来指定系列。
       // 可以使用数组指定多个系列。
       seriesIndex?: number | number[],
       seriesId?: string | string[],
       seriesName?: string | string[],
    
       // 数据项的 index,如果不指定也可以通过 name 属性根据名称指定数据项
       dataIndex?: number | number[],
       // 可选,数据项名称,在有 dataIndex 的时候忽略
       name?: string | string[]
     }
    

    高亮地图组件地理坐标系:

     {
       // 用 index 或 id 或 name 来指定地图组件地理坐标系。
       // 可以用数组指定多个地图组件地理坐标系。
       geoIndex?: number | number[],
       geoId?: string | string[],
       geoName?: string | string[],
    
       // 地图组件地理坐标系中 region 名称。
       // 可以是一个数组指定多个名称。
       name?: string | string[]
     }
    
  9. 取消高亮图形(支持取消数据图形高亮的组件): 取消数据图形高亮。 4.3+

    接收的参数为:

    取消高亮系列:

    {
     // 用 index 或 id 或 name 来指定系列。
     // 可以使用数组指定多个系列。
     seriesIndex?: number | number[],
     seriesId?: string | string[],
     seriesName?: string | string[],
    
     // 数据项的 index,如果不指定也可以通过 name 属性根据名称指定数据项
     dataIndex?: number | number[],
     // 可选,数据项名称,在有 dataIndex 的时候忽略
     name?: string | string[]
    }
    

    取消地图组件地理坐标系高亮:

    {
     // 用 index 或 id 或 name 来指定地图组件地理坐标系。
     // 可以用数组指定多个地图组件地理坐标系。
     geoIndex?: number | number[],
     geoId?: string | string[],
     geoName?: string | string[],
    
     // 地图组件地理坐标系中 region 名称。
     // 可以是一个数组指定多个名称。
     name?: string | string[]
    }
    
Last Updated: 5/5/2023, 11:21:46 AM