JS API Reference

Main:

drawDistanceMatrixHeatmap(data, action)

Draw distance matrix heatmap

Arguments
  • data – distance heatmap matrices.

  • action – action.

Returns

none.

clearSelected(id)

Unselect the menu selections

Arguments
  • id – id for menu selection.

Returns

none.

Distance Matrix Heatmap:

updateDistanceHeatmapContainer(dataAll)

Update distance heatmap container

Arguments
  • dataAll – distance heatmap dictionary.

Returns

none.

clickHeatmapMatrixCell(none)

Click heatmap matrix cell event

Arguments
  • none.

Returns

none.

updateDetailView(none)

Update detail view

Arguments
  • none.

Returns

none.

distanceMatrixHeatmap(options)

Draw distance heatmap

Arguments
  • options – Data containing matrix information.

Returns

none.

DrawHeatmapLegend(overviewLegendTypes)

Draw heatmap legend

Arguments
  • overviewLegendTypes – Legend types for overview distance matrices. It is generated by extracting the unique trend types from all distance matrix heatmaps. Overview legend type can be binary or continuous or both.

Returns

none.

Table:

tabulate(data, action)

Generate reuslt table

Arguments
  • data – result table from server side.

  • action – User action.

Returns

result table.

updateLabel(value, id)

Update label for slide

Arguments
  • value – label value.

  • id – label id.

Returns

none.

updateTabulate(vars)

Change highlight row when table is interacted

Arguments
  • vars – variables’ values.

Returns

none.

interactDistanceMatrix(vars)

interact distance matrix with result talbe

Arguments
  • vars – variables’ values using for matrix cell’s id.

Returns

none.

roleTable(data, var_types, samples, possibleRoles, isCounts, roles, weighting_vars, checked_vars, intersection_vars)

Setting role table for data augmentation and data annotation

Arguments
  • data – variable name.

  • var_types – variable type.

  • samples – samples.

  • possibleRoles – possible roles.

  • isCounts – counts for weighting.

  • roles – variable role.

  • weighting_vars – weighting variable.

  • checked_vars – variable for quantiles.

  • intersection_vars – intersections of categorical variables.

Returns

none.

getMetaList(none)

Get metadata

Arguments
  • none.

Returns

meta data list.

Scatterplot:

updateScatterplot(data, vars)

Update Scatterplot

Arguments
  • data – data for drawing dots.

  • vars – variables containing scatterplot elements information.

Returns

none.

createScatterplot(data)

Create Scatterplot

Arguments
  • data – the data for drawing the dots.

Returns

none.

calcLinear(data, x, y, minX, maxX, minY, maxY)

Calculate linear regression line

Arguments
  • data – data for drawing dots.

  • x – the variable for x axis.

  • y – the variable for y axis.

  • minX – minimal value for X.

  • maxX – maximal value for X.

  • minY – minimal value for Y.

  • maxY – maximal value for Y.

Returns

object – an object of two points, each point is an object with an x and y coordinate.

UpdateMatrixFormat(matrix, vars, category, trend_type)

Update matrix format

Arguments
  • matrix – matrix used for formatting.

  • vars – containing independent, dependent info.

  • category – groupby info.

  • trend_type – trend type.

Returns

none.

updateScatter(none)

Update scatterplot

Arguments
  • none.

Returns

none.

highlightSubgroup(subgroup)

highlight the regression line in scatterplot

Arguments
  • subgroup – the group needed for highlight.

Returns

none.

Parallel Coordinates:

updateParallelCoordinates(data, vars)

Draw Rank Chart

Arguments
  • data – rank trend’s detail data.

  • vars – clicked cell’s information.

Returns

none.

DrawParallelCoordinates(data, vars)

Draw Parallel Coordinates

Arguments
  • data – rank trend’s detail data.

  • vars – clicked cell’s information.

Returns

none.

Grouped Bar Chart:

DrawGroupedBarChart(data, vars)

Draw Bar Chart

Arguments
  • data – counts’ data.

  • vars – clicked cell’s information.

Returns

none.