数据洞察 WebApp 开放的接口

图表接口

1. 实例方法

通过 new iDataInsights.Plugins.Chart().XXXX 调用。

方法	描述	参数	返回值
bindCreateOption	绑定图表配置项。图表配置项需符合 Echarts 配置项	(data, style) => Object
registerComponents	注册属性面板中为图表设置输入项等创建的组件。当前支持创建的组件包含选择器、输入框、按钮	Array[component]
getData	获取当前图表关联的数据		Object。参见：图表数据
getChart	获取图表的 Echarts 实例		chartObj。参见：ECharts实例
getOption	获取图表的 Echarts 配置项		chartOption。参见：Echarts 配置项
updateChart	更新图表。该方法仅更新 Echarts　图表，不会变更 iDataInsights　中已有参数，慎用	chartOption。参见：Echarts 配置项
updateComponent	更新图表的属性面板中的输入项等组件的输入值。	String, Object

2. 静态方法

通过 iDataInsights.Plugins.Chart.XXXX 调用

static DefaultCharts

获取　iDataInsights 默认已有的所有图表类型。返回值为图表类型数组，如下表所示。

名称	类型	描述
直方图	HISTOGRAM	分类统计数据
柱状图	BARGRAPH	描述数值分布
条形图	BARCHART	描述数值分布
饼图	PIE	描述数据占比及顺序
折线图	LINE	描述和展示数据趋势
矩形树图	TREEMAP	描述数据占比及顺序
雷达图	RADAR	多维度描述数值分布
词云	WORDCLOUD	描述数据的关键词标签
散点图	SCATTER	显示数据间的相关程度
箱形图	BOXPLOT	观察数据分布和异常点
热力图	HEATCHART	展示数据分布情况
关系图	RELATIONGRAPH	展示数据间的关联情况

static DataTypes

获取　iDataInsights 的所有数据类型。返回值为iDataInsights 数据类型数组，如下表所示。

名称	类型
字符串	STRING
数值	NUMBER
日期	DATE
坐标	LOCATION

static Components

获取 iDataInsights 组件类型。返回值为包含所有组件的 Object。目前洞察提供了选择器、输入框、按钮三种组件。

3. 图表数据

通过实例方法 getData 获取到的图表数据 Object 含以下字段：

参数名	描述	类型
captions	字段名	Array
name	文件名	String
types	字段类型	Array
values	字段值	Array

分析接口

1. 实例方法

通过 new iDataInsights.Plugins.AnalystExtension().XXXX 调用。

方法	描述	参数	返回值
bindAnalyse	绑定 createOption 方法	callback
bindComponents	绑定组件	function => AnalystExtension.Components
updateComponents	更新组件的值	object
getAllDatas	获取所有数据		array
initParam	初始化分析参数	object
updateParam	更新分析参数	object
dataUpdateEvent	监听数据更新事件	function
getTurf	获取turf对象，使用 Turf 分析方法		class
getAnalysisSetting	获取分析设置信息		object

2. 静态方法

通过 iDataInsights.Plugins.AnalystExtension.XXXX 调用

static AnalystModes

返回 iDataInsights 分析模式类型，如下表所示。

类型	名称
CLIENT	本地离线分析，基于 Turf.js 的空间分析
SERVER	服务器在线分析
DISTRIBUTED	分布式分析

static DefaultAnalysis

返回 iDataInsights 分析类型。

CLIENT

类型	名称	描述
BUFFER	缓冲区	指定距离创建周边区域
ISOLINE	等值线	提取离散值生成曲线
ISOREGION	等值面	提取离散值生成面对象
OVERLAY	叠加分析	图层间空间几何运算
THIESSEN	泰森多边形	离散点生成连续多边形
IDW	反距离加权插值	通过已知点推求任意点值

SERVER

类型	名称	描述
BUFFER	缓冲区	指定距离创建周边区域
ISOLINE	等值线	提取离散值生成曲线
ISOREGION	等值面	提取离散值生成面对象
OVERLAY	叠加分析	图层间空间几何运算
THIESSEN	泰森多边形	离散点生成连续多边形
IDW	反距离加权插值	通过已知点推求任意点值

DISTRIBUTED

类型	名称	描述
AGGREGATEPOINTS	点聚合	点聚合为连续多边形区域
SUMMARYATTRIBUTES	属性汇总	统计数据集属性信息
DENSITY	密度分析	计算点指定邻域形状内的每单位面积量值
RECONSTRUCTTRACKS	轨迹重构	根据时间生成点运行轨迹
OVERLAY	叠加分析	图层间的空间几何运算
BUFFER	缓冲区	指定距离创建周边区域
BUILDREGIONGRID	构建区域格网	生成完全覆盖区域的格网面

static AnalysisResultTypes

返回 iDataInsights 分析结果类型，返回的值为 "FEATURES" 或 "URL"

static Components

返回 iDataInsights 扩展库组件枚举。目前洞察提供了选择器、输入框、按钮三种组件。

３.分析结果规范

FEATURES

// 标准的geojson格式

{

type: "FeatureCollection",

features: [{

type: "Feature",

properties: {}

geometry: {}

}]

}

URL

[

{

serviceType: "RESTDATA",

serviceAddress: "{ip:port}/iserver/services/{name}/rest"

},

{

serviceType: "RESTMAP",

serviceAddress: "{ip:port}/iserver/services/{name}/rest"

}

]

菜单标签页接口

1. 实例方法

通过 new iDataInsights.Plugins.MenuTabsExtension().XXXX 调用

方法	描述	参数	返回值	备注
initPane	初始化面板	Array[]	void	传入参数的数组元素为： { id: 创建实例时的菜单id（必须是创建实例时传入的id之一）, catalogID: 菜单id对应显示的左侧目录面板ID, containerID: 菜单id对应显示的中间面板ID }
createComponents	创建用户自定义组件	Function		此方法中使用到的 dom 节点最好使用 initPane 方法中传入的各面板id
bindComponents	绑定组件	tabID，Function	void	此方法当前仅支持向 catalog 面板添加组件
getAllDatas	获取已添加的所有数据信息	void	Array
addCustomToolBarBtn	添加用户自定义工具条按钮	tabID，Array	void
setDefaultAddDataWindowTabs	设置添加数据窗口显示哪些菜单页。参见：defaultAddDataWindowTabsId	Array	void

2. 静态方法

通过 iDataInsights.Plugins.MenuTabsExtension.XXXX 调用

static defaultMenuTabsId

返回 iDataInsights 默认的三种菜单模式 id

类型	名称	说明
di-tab-worktable	工作台模式	对应的面板从左到右依次为：数据目录（左），卡片工作台（中间），工具/卡片属性面板（右）
di-tab-data	数据模式	对应的面板从左到右依次为：数据名目录（左），数据表（右）
di-tab-console	终端模式	对应的面板从左到右依次为：数据目录（左），python工作台（中间），输出面板（右）

static defaultToolBarButtonId

返回 iDataInsights 工具栏的默认按钮 id

类型	名称	说明
"avatar"	用户头像按钮
"setting"	设置按钮
"viewSetting"	视图设置按钮	di-tab-data和di-tab-console模式无此功能
"fullScreen"	全屏显示按钮
"share"	分享按钮
"output"	导出按钮	di-tab-data和di-tab-console模式无此功能
"save"	保存按钮
"addChart"	添加视图按钮	di-tab-data和di-tab-console模式无此功能
"changeskin"	换肤按钮

static defaultAddDataWindowTabsId

返回 iDataInsights 添加数据窗口默认的添加方式对应的菜单页 id

类型	名称	说明
"add-data-file-upload"	添加数据窗口上传文件菜单页ID
"add-data-sample-data"	添加数据窗口示例数据菜单页ID
"add-data-my-data"	添加数据窗口我的数据菜单页ID
"add-data-my-server"	添加数据窗口我的服务菜单页ID

DataManager 与 CommonComponents

1. DataManager 实例方法

通过 new iDataInsights.Plugins.DataManager().XXXX 调用。

方法	描述	参数	返回值
afterDeleteData	删除数据会触发的函数	void
afterAddedDataToWorkSpace	添加数据完成会触发的函数	void
afterGetWorkSpaceCompleted	获取工作空间完成会触发的函数	void
getDataIndexInCatalog	通过DI中的数据id找到当前数据在左侧列表中的索引	number
getAllData	获取通过添加数据窗口已经添加至项目的所有数据		Array 通过添加数据窗口添加的所有数据
deleteWorkspaceData	删除工作空间中指定id的数据

2. CommonComponents 实例方法

通过 new iDataInsights.Plugins.CommonComponents().XXXX 调用。

方法	描述	参数
showTopMessage	顶部消息提示	void
openAddDataWindow	打开添加数据窗口	void

3. CommonComponents 静态方法

通过 iDataInsights.Plugins.CommonComponents.XXXX 调用。

static MessageTypes

返回 iDataInsights 三种消息类型：SUCCESS：成功、FAILED:失败、WARNING:提醒

static Components

目前洞察提供了选择器、输入框、按钮三种组件。

组件接口

扩展开发目前提供了按钮、输入框、选择器三种组件。

按钮（BUTTON）

参数名	描述	类型	是否必须	是否唯一	备注
type	组件id	String	true	true	建议使用当前属性值
value	显示文本	String	true	false
onClick	点击事件	Function	true	false

输入框（INPUT）

参数名	描述	类型	是否必须	是否唯一	备注
type	组件id	String	true	true	建议使用当前属性值
name	组件标签	String, Number	false	false
value	显示文本	String	false	false
onBlur	失去焦点事件	Function	true	false
pattern	过滤输入值的正则表达式	RegExp	false	false
placeholder	规定可描述输入字段预期值的简短信息提示	String	false	false

选择器（SELECT）

参数名	描述	类型	是否必须	是否唯一	备注
type	组件id	String	true	true	建议使用当前属性值
name	组件标签	String	false	false
value	选中项	String, Number	false	false	类型和values中的值一致
values	选项列表	Array	true	false	列表值为字符串或数值类型
onChange	选中项改变事件	Function	true	false	(value, type) => {}