11# Vizzu JS Library Reference
22
3- This is the API reference documentation of the Vizzu JS library.
4- The intention of this documentation is to provide information about
5- every details of the API for user with understanding of the basics of the
6- Vizzu Library.
3+ This is the API reference document of the Vizzu JS library. It provides information
4+ about every detail of the API. This works best for users who already have a basic
5+ understanding of the Vizzu Library and its logic.
76
8- For a getting started introduction to the library please visit our
9- [ Tutorial] ( https://lib.vizzuhq.com/0.3.0 ) .
7+ In case you're just getting started with Vizzu, we strongly recommend visiting our
8+ [ Tutorial] ( https://lib.vizzuhq.com/0.3.0 ) first .
109
1110## Library Overview
1211
1312The main entry point of the library is the [ Vizzu] ( classes/default.html ) class,
14- and it's most important method controlling the basic functionality of the
15- library is the [ animate()] ( classes/default.html#animate ) method:
13+ and its most important component is the [ animate()] ( classes/default.html#animate ) method:
1614
1715* [ Vizzu] ( classes/default.html ) class
1816 * [constructor()](classes/default.html#constructor)
1917 * [animate](classes/default.html#animate) ( [AnimTarget](interfaces/AnimTarget.html) , [Anim.Options](interfaces/Anim.Options.html) )
2018
2119The animate() method's main parameter is the [ AnimTarget] ( interfaces/AnimTarget.html )
22- interface which contains the definition of the chart, the underlying data and the chart's styling :
20+ interface, which contains the configuration of the chart, the underlying data, and the chart's style settings :
2321
2422* [ AnimTarget] ( interfaces/AnimTarget.html )
2523 * [Data.Set](modules/Data.html#Set)
@@ -30,18 +28,15 @@ interface which contains the definition of the chart, the underlying data and th
3028 * [Styles.Marker](interfaces/Styles.Marker.html)
3129 * [Styles.Axis](interfaces/Styles.Axis.html)
3230 * [Styles.Legend](interfaces/Styles.Legend.html)
33- * [Styles.Title](interfaces/Styles.Title.html)
3431 * [Styles.Tooltip](interfaces/Styles.Tooltip.html)
3532
3633
3734## Details:
3835
3936You can find all interface declarations and types under these namespaces.
4037
41- ### Namespaces:
42-
43- * [ Data] ( modules/Data.html )
44- * [ Config] ( modules/Config.html )
45- * [ Style] ( modules/Styles.html )
46- * [ Anim] ( modules/Anim.html )
47- * [ Events] ( modules/Event.html )
38+ * [ Data] ( modules/Data.html ) - Data structure and operations
39+ * [ Config] ( modules/Config.html ) - Configuration settings of your charts
40+ * [ Style] ( modules/Styles.html ) - Style settings
41+ * [ Anim] ( modules/Anim.html ) - Animation settings
42+ * [ Events] ( modules/Event.html ) - Event handling
0 commit comments