SmartBoard

2 min read

Class SmartBoard(inputCharts: InputChart[])

Initial Parameters

inputCharts * Data
- required parameter
- Parameter type: array of InputChart objects
InputChart * InputChart
InputChart Parameter configuration.

Properties	Type	Description	Default
id	`string`	Chart ID。	Auto-generated `Optional`
data	`any[]`	The source data.	None
dataUrl	`string`	The address of the data source.	None `Optional`
subspace	`Subspace[]`	The data subspace information.	None
dimensions	`string[]`	The dimension of the data.	None
measures	`string[]`	The indicator field.	None
fieldInfo	`any`	The data field information.	None `Optional`
insightTypes	`InsightType[]`	The insight type.	None `Optional`
score	`number`	The score of the insight.	None `Optional`
chartType	`ChartType`	The chart type.	None `Optional`
chartSchema	`any`	The specified visualization scheme, such as chart configuration, title, etc.	None `Optional`
description	`string \| string[]`	The chart description information.	None `Optional`

To get the chart that constructs the Dashboard.

SmartBoard.getCharts: InputChart[];

Return value: InputChart[]

To get the ChartGraph that holds the correlations between charts defined by G6:

SmartBoard.chartGraph;

Return value:

interface ChartGraph {
  nodes: Chart[];
  links: link[];
}

To get the ChartOrder that holds the order of the charts, the output order is determined by both the data insight score and the chart association.

SmartBoard.chartOrder(type: OrderType): ChartOrder;

Parameter:

type OrderType = 'byInsightScore' | 'byCluster';

Return value:

type ChartOrder = Record<string, number>;

To obtain ChartCluster, which holds the clustering relationships of the charts via using the Louvain algorithm.

SmartBoard.chartCluster(): ChartCluster;

Return value:

type ChartCluster = Record<string, number>;

Transfer the output insight of LiteInsight to the InputChart array employed when initial SmartBoard.

insights2Board(insights: InsightInfo): InputChart[];