Skip to content

@sqlrooms/mosaic / createChartTools

Function: createChartTools()

createChartTools(chartTypes, params, toolNamePrefix): Record<string, Tool>

Dynamically generate chart configuration tools from chart type definitions.

Parameters

ParameterTypeDescription
chartTypesChartTypeDefinition<any>[]Array of chart type definitions
paramsChartToolParamsChart tool parameters containing addChart function, maxDataPoints limit, and databaseAdapter for table/column resolution
toolNamePrefixstringRequired prefix for generated tool names (e.g., 'create_dashboard_' or 'create_worksheet_block_')

Returns

Record<string, Tool>

Record mapping tool names to tool instances

Example

ts
const chartTypes = resolveChartTypes();
const params: ChartToolParams = {
  addChart: (chartParams) => dashboardAdapter.addPanel(chartParams),
  maxDataPoints: 10000,
  databaseAdapter: myDatabaseAdapter
};
const tools = createChartTools(chartTypes, params, 'create_dashboard_');
// Returns: { create_dashboard_histogram: Tool, create_dashboard_line_chart: Tool, ... }