The open interfaces in DataInsights WebApps

Feedback

Chart interface

1.Instance method

Call by new iDataInsights.Plugins.Chart().XXXX.

Method Description Parameter Return Value

 bindCreateOption

Binding chart configuration items, the chart configuration items must conform to the Echarts configuration items

 (data, style) => Object

  

 registerComponents

Register the components created by setting input items for the chart in the property panel. The currently supported components include selector, input box, and button

Array[component]

  

getData

Get the data associated with the current chartObject. See: Chart data

 

Object. See: Chart data

getChart

Get the Echarts instance of the chart

 

chartObj. See: ECharts instance

getOption

Get the Echarts configuration items of the chart

 

 chartOption. See: Echarts configuration items

updateChart

Update the chart.This method only updates Echarts charts without changing the existed parameters in iDataInsights, please use it with caution

chartOption. See: Echarts configuration items

  

updateComponent

Update the input values of components such as input items in the properties panel of the chart

 String, Object

  

2.Static method

Call by iDataInsights.Plugins.Chart.XXXX.

Get all the chart types included by default in iDataInsights. The return value is an array of chart types, as shown in the following table.

Name

 Type Description
histogram HISTOGRAM Classification statistics

bar graph

 BARGRAPH Describe the numerical distribution
bar chart BARCHART Describe the numerical distribution
pie chart PIE Describe the proportion and order of data
line chart LINE Describe and display the data trends
tree map TREEMAP Describe the proportion and order of data
radar map RADAR Multi-dimensional description of numerical distribution
word cloud WORDCLOUD Describe keyword tags of data
scatter diagram SCATTER Show the degree of correlation between data
box-plot BOXPLOT Observe the distribution and abnormal points of data
heat map HEATCHART Show the distribution of data
relational graph RELATIONGRAPH Show the relevance of data

Get all the data types of iDataInsights. The return value is an array of iDataInsights data types, as shown in the following table.

Name

Type
string STRING
number NUMBER
date DATE
coordinate LOCATION

 

Get the iDataInsights component type. The return value is an Object containing all components. Currently, DataInsights provides three components: selector, input box, and button.

3.Chart data

The chart data Object obtained by the instance method getData contains the following fields:

Parameter Description Type
captions field name Array
name filename String
types field type Array
values field value Array

 

Analysis interface

1.Instance method

Call by new iDataInsights.Plugins.AnalystExtension().XXXX.

Method Description Parameter Return Value
bindAnalyse Bind the  createOption method callback  
bindComponents Bind components function => AnalystExtension.Components  
updateComponents Update the value of components object  
getAllDatas Get all data   array
initParam Initialize analysis parameters object  
updateParam Update analysis parameters object  
dataUpdateEvent Monitor data update event function  
getTurf Get turf object, use Turf analysis method   class
getAnalysisSetting Get analysis setting information   object

 

2.Static method

Call by iDataInsights.Plugins.AnalystExtension.XXXX.

Return the iDataInsights analysis mode type, as shown in the following table.

Type

Name
CLIENT Local offline analysis, spatial analysis based on Turf.js
SERVER Server online analysis
DISTRIBUTED Distributed analysis

Return the iDataInsights analysis type.

CLIENT

Type Name Description
BUFFER buffer Specify a distance to create a surrounding area
ISOLINE isoline Extract discrete values to generate curves
ISOREGION isosurface Extract discrete values to generate surface objects
OVERLAY overlay analysis Spatial geometric operations between layers
THIESSEN Thiessen polygon Discrete points generate continuous polygons
IDW Inverse Distance Weighted Calculate any point value based on known points

SERVER

Type Name Description
BUFFER buffer Specify a distance to create a surrounding area
ISOLINE isoline Extract discrete values to generate curves
ISOREGION isosurface Extract discrete values to generate surface objects
OVERLAY overlay analysis Spatial geometric operations between layers
THIESSEN Thiessen polygon Discrete points generate continuous polygons
IDW Inverse Distance Weighted Calculate any point value based on known points

DISTRIBUTED

Type Name Description
AGGREGATEPOINTS point aggregation Points are aggregated into continuous polygonal areas
SUMMARYATTRIBUTES summary attributes Summarize the attribute information of the
 Data Set
DENSITY density analysis Calculate the value per unit area within the specified neighborhood shape of the point
RECONSTRUCTTRACKS reconstruction tracks Generate the trajectory of points according to time.
OVERLAY overlay analysis

Spatial geometric operations between layers
BUFFER buffer Specify a distance to create a surrounding area
BUILDREGIONGRID build region grid Generate a grid surface that completely covers the area

Return the result type of iDataInsights analysis, and the returned value is "FEATURES" or "URL".

Return the enumeration of iDataInsights extension library components. Currently, DataInsights provides three components: selector, input box, and button.

3.Standardization of analysis results

 

FEATURES

// Standard geojson format

{

    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"

    }

]

Menu tab interface

1.Instance method

Call by new iDataInsights.Plugins.MenuTabsExtension().XXXX

Method Description Parameter

Return Value

 Note
initPane Initialize the panel Array[] void

 initPane The array elements passed in the parameters are:

{

id: the menu id when creating the instance (must be one of the id passed in when creating the instance),

catalogID: the ID of the left catalog panel corresponding to the menu id,

containerID: the ID of the middle panel corresponding to the menu id

}
createComponents Create customized components Function   The dom node used in this method is recommended to use the panel id passed in the initPane method
bindComponents Bind components tabID, Function void This method currently only supports adding components to the catalog panel
getAllDatas Get all information of the added data void Array  
addCustomToolBarBtn Add customized toolbar buttons tabID, Array void  
setDefaultAddDataWindowTabs Set which menu pages are displayed in the add data window. See: defaultAddDataWindowTabsId Array void  

2. Static method

Call by iDataInsights.Plugins.MenuTabsExtension.XXXX.

Return to iDataInsights default three menu mode id.

Type

 Name Illustration
di-tab-worktable workbench mode The corresponding panels from left to right are: data directory (left), card workbench (middle), tools/card properties panel (right)
di-tab-data data mode

The corresponding panels from left to right are: data name directory (left), data table (right)
di-tab-console console mode The corresponding panels from left to right are: data directory (left), python workbench (middle), output panel (right)

Return the default button id of the iDataInsights toolbar.

Type Name Illustration
"avatar" user avatar button  
"setting" setting button  
"viewSetting" view setting button di-tab-data and di-tab-console modes do not have this function
"fullScreen" full-screen display button  
"share" sharing button  
"output" output button di-tab-data and di-tab-console modes do not have this function
"save" save button  
"addChart" chart  adding button di-tab-data and di-tab-console modes do not have this function
"changeskin" skin changing button  

 

Return the menu page id corresponding to the default adding method of the iDataInsights add data window.

Type Name Illustration
"add-data-file-upload" The menu page ID of the uploaded file in the add data window  
"add-data-sample-data" The menu page ID of the sample data in the add data window  
"add-data-my-data" The menu page ID of my data in the add data window  
"add-data-my-server" The menu page ID of my server in the add data window  

DataManager and CommonComponents

1.DataManager instance method

Called by new iDataInsights.Plugins.DataManager().XXXX.

Method Description Parameter Return Value
afterDeleteData

Function triggered after deleting data

 void  
afterAddedDataToWorkSpace

Function triggered after adding data

 void  
afterGetWorkSpaceCompleted Function triggered after the workspace is acquired void  
getDataIndexInCatalog

Find the index of the current data in the list on the left through the data id in DataInsights

 number  
getAllData

Get all the data that has been added to the project through the adding data window

   Array
all the data added by adding data window
deleteWorkspaceData Delete the data with the specified id in the workspace    

2.CommonComponents instance method

Called by new iDataInsights.Plugins.CommonComponents().XXXX.

Method Description Parameter
showTopMessage Top message prompt void
openAddDataWindow Open the add data window void

3.CommonComponents static method

Called by iDataInsights.Plugins.CommonComponents.XXXX.

Return iDataInsights three message types: SUCCESS, FAILED, WARNING

Currently, DataInsights provides three components: selector, input box, and button.

Component interface

Currently, DataInsights provides three components: selector, input box, and button.

 

Button (BUTTON)

Parameter Description Type

Must

 Unique Note
type component id String true true It is recommended to use the current attribute value
value display text String true false  
onClick click event Function true false  

Input Box (INPUT)

Parameter Description Type

Must

 Unique Note
type component id String true true It is recommended to use the current attribute value
name component tag String, Number false false  
value display text String false false  
onBlur loss of focus event Function true false  
pattern Filter the regular expression of input values RegExp false false  
placeholder Specify a short message prompt that describes the expected value of the input field String false false  

 

Selector (SELECT)

Parameter Description Type

Must

 Unique

Note
type component id String true true It is recommended to use the current attribute value
name component tag String false false  
value selected item String, Number false false The type must be consistent with the value in values
values selected list Array true false List value is string or number type
onChange selected item change event Function true false (value, type) => {}