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.
PropertiesTypeDescriptionDefault
idstringChart ID。Auto-generated Optional
dataany[]The source data.None
dataUrlstringThe address of the data source.None Optional
subspaceSubspace[]The data subspace information.None
dimensionsstring[]The dimension of the data.None
measuresstring[]The indicator field.None
fieldInfoanyThe data field information.None Optional
insightTypesInsightType[]The insight type.None Optional
scorenumberThe score of the insight.None Optional
chartTypeChartTypeThe chart type.None Optional
chartSchemaanyThe specified visualization scheme, such as chart configuration, title, etc.None Optional
descriptionstring | string[]The chart description information.None Optional

Functions

SmartBoard.getCharts

To get the chart that constructs the Dashboard.

SmartBoard.getCharts: InputChart[];

Return value: InputChart[]

SmartBoard.chartGraph

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

SmartBoard.chartGraph;

Return value:

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

SmartBoard.chartOrder

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>;

SmartBoard.chartCluster

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>;

insights2Board

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

insights2Board(insights: InsightInfo): InputChart[];

Parameter: InsightInfo