@nestjsforge/echarts
Configuration (forRoot)
Configure EChartsModule with forRoot for synchronous setup.
Use EChartsModule.forRoot(options) for synchronous configuration at the root or feature level.
EChartsModule.forRoot({
poolSize: 2, // Number of concurrent Puppeteer browser instances
timeout: 15_000, // Render timeout in ms (default: 10000)
defaultTheme: 'dark', // Default ECharts theme name
defaultWidth: 800, // Default chart width in px
defaultHeight: 600, // Default chart height in px
puppeteerOptions: {
headless: true,
args: ['--no-sandbox', '--disable-setuid-sandbox'],
executablePath: process.env.CHROME_PATH,
},
themes: [
{ name: 'corporate', theme: require('./themes/corporate.json') },
],
})Configuration Options
| Option | Type | Default | Description |
|---|---|---|---|
| poolSize | number | 2 | Number of Puppeteer browser instances to maintain |
| timeout | number | 10000 | Render timeout in milliseconds |
| defaultTheme | string | undefined | Default ECharts theme name to apply to all renders |
| defaultWidth | number | 800 | Default chart width in pixels |
| defaultHeight | number | 600 | Default chart height in pixels |
| puppeteerOptions | PuppeteerLaunchOptions | {} | Options passed directly to puppeteer.launch() |
| themes | ThemeDefinition[] | [] | Array of named ECharts themes to pre-register |
| maxConcurrentRenders | number | poolSize | Max simultaneous render operations |
| gracefulShutdownTimeout | number | 5000 | Max ms to wait for in-flight renders on shutdown |