@nestjsforge/echarts

Interfaces

TypeScript interfaces exported by @nestjsforge/echarts.

interface EChartsModuleOptions {
  poolSize?: number;                    // Default: 2
  timeout?: number;                     // Default: 10000 ms
  defaultTheme?: string;                // Default: undefined
  defaultWidth?: number;                // Default: 800
  defaultHeight?: number;               // Default: 600
  puppeteerOptions?: PuppeteerLaunchOptions;
  themes?: ThemeDefinition[];
  maxConcurrentRenders?: number;
  gracefulShutdownTimeout?: number;     // Default: 5000 ms
}

interface RenderOptions {
  width?: number;
  height?: number;
  theme?: string;
  outputPath?: string;        // Only for renderToFile
  timeout?: number;
  deviceScaleFactor?: number; // Default: 1
}

interface ThemeDefinition {
  name: string;
  theme: Record<string, unknown>;
}

interface EChartsAsyncOptions {
  imports?: any[];
  inject?: any[];
  useFactory?: (...args: any[]) => EChartsModuleOptions | Promise<EChartsModuleOptions>;
  useClass?: Type<EChartsOptionsFactory>;
  useExisting?: Type<EChartsOptionsFactory>;
}

interface EChartsOptionsFactory {
  createEChartsOptions(): EChartsModuleOptions | Promise<EChartsModuleOptions>;
}