or run

npx @tessl/cli init
Log in

Version

Tile

Overview

Evals

Files

docs

authorization.mdcharts.mdcompiler.mdconditional-formatting.mddashboards.mddbt.mdee-features.mdexplore-fields.mdfilters.mdformatting.mdindex.mdmetric-queries.mdparameters.mdpivot.mdprojects-spaces.mdsql-runner.mdtemplating.mdtypes.mdutilities.mdvisualizations.mdwarehouse.md
tile.json

visualizations.mddocs/

Visualization Data Models

Data transformation models for chart rendering with ECharts.

CartesianChartDataModel

class CartesianChartDataModel {
  constructor(args: {
    resultsRunner: IResultsRunner;
    fieldConfig?: PivotChartLayout;
    type?: CartesianChartKind;
  });

  getChartOptions(): VizCartesianChartOptions;
  getPivotedChartData(args: {...}): Promise<PivotChartData | undefined>;
  getTransformedData(query?: SqlRunnerQuery): Promise<PivotChartData | undefined>;
}

PieChartDataModel

class PieChartDataModel {
  constructor(args: {
    resultsRunner: IResultsRunner;
    fieldConfig?: PivotChartLayout;
  });
}

TableDataModel

class TableDataModel {
  constructor(args: {
    resultsRunner: IResultsRunner;
    columnsConfig?: VizTableConfig['columns'];
  });
}

Usage

import { CartesianChartDataModel, CartesianChartKind } from '@lightdash/common';

const dataModel = new CartesianChartDataModel({
  resultsRunner,
  fieldConfig: pivotLayout,
  type: CartesianChartKind.LINE,
});

const chartOptions = dataModel.getChartOptions();