VisActor VBI
  • English

      • Register

      Theme

      registerCustomTheme

      Description

      Register a custom theme.

      function registerCustomTheme(key: string, themeConfig:
    | CustomThemeConfig
    | ((props: { lightTheme: CustomThemeConfig; darkTheme: CustomThemeConfig }) => CustomThemeConfig)): void

      Parameters:

      • Unique identifier for the theme
      • Theme configuration object, or a function that returns a configuration object. If a function, it receives an object containing lightTheme and darkTheme as parameters, making it easy to extend existing themes.

      Example:

      registerCustomTheme('myTheme', { ... }); // Or modify based on the light theme registerCustomTheme('myTheme', ({ lightTheme }) => ({ ...lightTheme, ... }));

      registerDarkTheme

      Description

      Register the dark theme (Dark Theme). After registration, retrieve it via Builder.getTheme('dark').

      function registerDarkTheme(): void

      registerLightTheme

      Description

      Register the light theme (Light Theme). After registration, retrieve it via Builder.getTheme('light').

      function registerLightTheme(): void

      ChartType

      registerArea

      Description

      Register the Area Chart build pipeline. Once registered, Builder supports building Area Chart Spec and Advanced Config.

      function registerArea(): void

      registerAreaPercent

      Description

      Register the Area Percent Chart build pipeline. Once registered, Builder supports building Area Percent Chart Spec and Advanced Config.

      function registerAreaPercent(): void

      registerBar

      Description

      Register the Bar Chart build pipeline. Once registered, Builder supports building Bar Chart Spec and Advanced Config.

      function registerBar(): void

      registerBarParallel

      Description

      Register the Bar Parallel Chart build pipeline. Once registered, Builder supports building Bar Parallel Chart Spec and Advanced Config.

      function registerBarParallel(): void

      registerBarPercent

      Description

      Register the Bar Percent Chart build pipeline. Once registered, Builder supports building Bar Percent Chart Spec and Advanced Config.

      function registerBarPercent(): void

      registerBoxPlot

      Description

      Register the Box Plot Chart build pipeline. Once registered, Builder supports building Box Plot Chart Spec and Advanced Config.

      function registerBoxPlot(): void

      registerCirclePacking

      Description

      Register the CirclePacking Chart build pipeline. Once registered, Builder supports building CirclePacking Chart Spec and Advanced Config.

      function registerCirclePacking(): void

      registerColumn

      Description

      Register the Column Chart build pipeline. Once registered, Builder supports building Column Chart Spec and Advanced Config.

      function registerColumn(): void

      registerColumnParallel

      Description

      Register the Column Parallel Chart build pipeline. Once registered, Builder supports building Column Parallel Chart Spec and Advanced Config.

      function registerColumnParallel(): void

      registerColumnPercent

      Description

      Register the Column Percent Chart build pipeline. Once registered, Builder supports building Column Percent Chart Spec and Advanced Config.

      function registerColumnPercent(): void

      registerDonut

      Description

      Register the Donut Chart build pipeline. Once registered, Builder supports building Donut Chart Spec and Advanced Config.

      function registerDonut(): void

      registerDualAxis

      Description

      Register the Dual Axis Chart build pipeline. Once registered, Builder supports building Dual Axis Chart Spec and Advanced Config.

      function registerDualAxis(): void

      registerFunnel

      Description

      Register the Funnel Chart build pipeline. Once registered, Builder supports building Funnel Chart Spec and Advanced Config.

      function registerFunnel(): void

      registerHeatmap

      Description

      Register the Heatmap Chart build pipeline. Once registered, Builder supports building Heatmap Chart Spec and Advanced Config.

      function registerHeatmap(): void

      registerHierarchySankey

      Description

      Register the HierarchySankey Chart build pipeline.

      function registerHierarchySankey(): void

      registerHistogram

      Description

      Register the Histogram Chart build pipeline. Once registered, Builder supports building Histogram Chart Spec and Advanced Config.

      function registerHistogram(): void

      registerLine

      Description

      Register the Line Chart build pipeline. Once registered, Builder supports building Line Chart Spec and Advanced Config.

      function registerLine(): void

      registerPie

      Description

      Register the Pie Chart build pipeline. Once registered, Builder supports building Pie Chart Spec and Advanced Config.

      function registerPie(): void

      registerPivotTable

      Description

      Register the Pivot Table Chart build pipeline. Once registered, Builder supports building Pivot Table Chart Spec and Advanced Config.

      function registerPivotTable(): void

      registerRaceBar

      Description

      Register the RaceBar Chart build pipeline. Once registered, Builder supports building RaceBar Chart Spec.

      function registerRaceBar(): void

      registerRaceColumn

      Description

      Register the RaceColumn Chart build pipeline. Once registered, Builder supports building RaceColumn Chart Spec.

      function registerRaceColumn(): void

      registerRaceDonut

      Description

      Register the RaceDonut Chart build pipeline. Once registered, Builder supports building RaceDonut Chart Spec.

      function registerRaceDonut(): void

      registerRaceLine

      Description

      Register the RaceLine Chart build pipeline. Once registered, Builder supports building RaceLine Chart Spec.

      function registerRaceLine(): void

      registerRacePie

      Description

      Register the RacePie Chart build pipeline. Once registered, Builder supports building RacePie Chart Spec.

      function registerRacePie(): void

      registerRaceScatter

      Description

      Register the RaceScatter Chart build pipeline. Once registered, Builder supports building RaceScatter Chart Spec.

      function registerRaceScatter(): void

      registerRadar

      Description

      Register the Radar Chart build pipeline. Once registered, Builder supports building Radar Chart Spec and Advanced Config.

      function registerRadar(): void

      registerRose

      Description

      Register the Rose Chart build pipeline. Once registered, Builder supports building Rose Chart Spec and Advanced Config.

      function registerRose(): void

      registerRoseParallel

      Description

      Register the Rose Parallel Chart build pipeline. Once registered, Builder supports building Rose Parallel Chart Spec and Advanced Config.

      function registerRoseParallel(): void

      registerSankey

      function registerSankey(): void

      registerScatter

      Description

      Register the Scatter Chart build pipeline. Once registered, Builder supports building Scatter Chart Spec and Advanced Config.

      function registerScatter(): void

      registerSunburst

      Description

      Register the Sunburst Chart build pipeline. Once registered, Builder supports building Sunburst Chart Spec and Advanced Config.

      function registerSunburst(): void

      registerTable

      Description

      Register the Table Chart build pipeline. Once registered, Builder supports building Table Chart Spec and Advanced Config.

      function registerTable(): void

      registerTreeMap

      Description

      Register the TreeMap Chart build pipeline. Once registered, Builder supports building TreeMap Chart Spec and Advanced Config.

      function registerTreeMap(): void