Vizzu / Modules

Vizzu JS Library Reference

This is the API reference document of the Vizzu JS library. It provides information about every detail of the API. This works best for users who already have a basic understanding of the Vizzu library and its logic.

In case you're just getting started with Vizzu, we strongly recommend visiting our Tutorial first.

Library Overview

The main entry point of the library is the Vizzu class, and its most important component is the animate method:

• Vizzu class
  • constructor()
  • animate ( Anim.Target , Anim.Options ) : Anim.Completing

The animate method's main parameter is the Anim.Target interface, which contains the configuration of the chart, the underlying data, and the chart's style settings:

• Anim.Target
  • Data.Set
  • Config.Chart
    • Config.Channels
  • Styles.Chart
    • Styles.Plot
      • Styles.Marker
      • Styles.Axis
    • Styles.Legend
    • Styles.Tooltip

Details

You can find all interface declarations and types under these namespaces.

• Data - Data structure and operations
• Config - Configuration settings of your charts
• Style - Style settings
• Anim - Animation settings
• Events - Event handling
• Presets - Preset chart configurations