API Reference
This page provides the complete API reference for Veltix.
Core API
Dashboard API
import { Dashboard } from '@veltix/core'
interface DashboardConfig {
id: string
title: string
layout: LayoutConfig
components: ComponentConfig[]
theme: ThemeConfig
}
// Create dashboard
const dashboard = new Dashboard(config)Component API
import { Component } from '@veltix/core'
interface ComponentConfig {
id: string
type: 'chart' | 'table' | 'kpi'
position: { x: number; y: number }
size: { width: number; height: number }
data: any
config: any
}
// Create component
const component = new Component(config)Chart API
Bar Chart
import { BarChart } from '@veltix/charts'
const barChartConfig = {
data: [
{ name: 'Product A', value: 100 },
{ name: 'Product B', value: 200 }
],
options: {
xAxis: { type: 'category' },
yAxis: { type: 'value' }
}
}Line Chart
import { LineChart } from '@veltix/charts'
const lineChartConfig = {
data: [
{ date: '2024-01', value: 100 },
{ date: '2024-02', value: 150 }
],
options: {
xAxis: { type: 'time' },
yAxis: { type: 'value' }
}
}Data API
Data Source
import { DataSource } from '@veltix/data'
interface DataSourceConfig {
type: 'api' | 'database' | 'file'
url?: string
query?: string
headers?: Record<string, string>
}
// Create data source
const dataSource = new DataSource(config)Next Steps
For examples, see the Examples page.
Last updated on