Skip to content

Commit 5eba946

Browse files
simzersimzer
committed
Docs: Reference index page revised.
1 parent a7ae60b commit 5eba946

File tree

2 files changed

+36
-39
lines changed

2 files changed

+36
-39
lines changed

‎docs/content/reference/reference.md‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
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.
4+
It provides information about every detail of the API.
5+
This works best for users who already have at least a basic
6+
understanding of the Vizzu Library and its logic.
77

8-
For a getting started introduction to the library please visit our
9-
[Tutorial](https://lib.vizzuhq.com/0.3.0).
8+
In case you're just getting started with Vizzu, we strongly recommend visiting our
9+
[Tutorial](https://lib.vizzuhq.com/0.3.0) first.
1010

1111
## Library Overview
1212

1313
The 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:
14+
and its most important component is the [animate()](classes/default.html#animate) method:
1615

1716
* [Vizzu](classes/default.html) class
1817
* [constructor()](classes/default.html#constructor)
1918
* [animate](classes/default.html#animate) ( [AnimTarget](interfaces/AnimTarget.html) , [Anim.Options](interfaces/Anim.Options.html) )
2019

2120
The 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:
21+
interface, which contains the configuration of the chart, the underlying data, and the chart's style settings:
2322

2423
* [AnimTarget](interfaces/AnimTarget.html)
2524
* [Data.Set](modules/Data.html#Set)
@@ -38,10 +37,8 @@ interface which contains the definition of the chart, the underlying data and th
3837

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

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)
40+
* [Data](modules/Data.html) - Data structure and operations
41+
* [Config](modules/Config.html) - Configuration settings of your charts
42+
* [Style](modules/Styles.html) - Style settings
43+
* [Anim](modules/Anim.html) - Animation settings
44+
* [Events](modules/Event.html) - Event handling

‎test/integration/test_cases.json‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -871,47 +871,47 @@
871871
},
872872
"web_content/templates/composition_percentage_column_3dis_1con": {
873873
"refs": {
874-
"ubuntu_focal_chrome_headless": "9dc09b7"
874+
"ubuntu_focal_chrome_headless": "e8a3327"
875875
}
876876
},
877877
"web_content/templates/composition_percentage_column_stream_3dis_1con": {
878878
"refs": {
879-
"ubuntu_focal_chrome_headless": "461983d"
879+
"ubuntu_focal_chrome_headless": "22a8afb"
880880
}
881881
},
882882
"web_content/templates/distribution_relationship_dotplot_dotplot": {
883883
"refs": {
884-
"ubuntu_focal_chrome_headless": "b2194e7"
884+
"ubuntu_focal_chrome_headless": "9a0fcf2"
885885
}
886886
},
887887
"web_content/templates/drilldown_aggregate_line": {
888888
"refs": {
889-
"ubuntu_focal_chrome_headless": "e5a3519"
889+
"ubuntu_focal_chrome_headless": "7a87026"
890890
}
891891
},
892892
"web_content/templates/merge_split_area_stream_3dis_1con": {
893893
"refs": {
894-
"ubuntu_focal_chrome_headless": "5a16898"
894+
"ubuntu_focal_chrome_headless": "618c049"
895895
}
896896
},
897897
"web_content/templates/merge_split_bar": {
898898
"refs": {
899-
"ubuntu_focal_chrome_headless": "bafc380"
899+
"ubuntu_focal_chrome_headless": "de4d7c8"
900900
}
901901
},
902902
"web_content/templates/merge_split_radial_stacked_rectangle_2dis_1con": {
903903
"refs": {
904-
"ubuntu_focal_chrome_headless": "3eaf6a0"
904+
"ubuntu_focal_chrome_headless": "e7c7d48"
905905
}
906906
},
907907
"web_content/templates/orientation_circle": {
908908
"refs": {
909-
"ubuntu_focal_chrome_headless": "d236853"
909+
"ubuntu_focal_chrome_headless": "c67e672"
910910
}
911911
},
912912
"web_content/templates/orientation_dot_circle": {
913913
"refs": {
914-
"ubuntu_focal_chrome_headless": "9be6229"
914+
"ubuntu_focal_chrome_headless": "8d529c7"
915915
}
916916
},
917917
"web_content/templates/orientation_marimekko_rectangle_2dis_2con": {
@@ -921,7 +921,7 @@
921921
},
922922
"web_content/templates/orientation_rectangle": {
923923
"refs": {
924-
"ubuntu_focal_chrome_headless": "011d64b"
924+
"ubuntu_focal_chrome_headless": "f0c767f"
925925
}
926926
},
927927
"web_content/templates/pie_donut2_rectangle_1dis_1con": {
@@ -931,57 +931,57 @@
931931
},
932932
"web_content/templates/relationship_comparison_circle_2_bubble_plot": {
933933
"refs": {
934-
"ubuntu_focal_chrome_headless": "a4ce32c"
934+
"ubuntu_focal_chrome_headless": "a05fd0e"
935935
}
936936
},
937937
"web_content/templates/relationship_total_bubble_plot_column": {
938938
"refs": {
939-
"ubuntu_focal_chrome_headless": "c9a4a35"
939+
"ubuntu_focal_chrome_headless": "f2e17ed"
940940
}
941941
},
942942
"web_content/templates/stack_group_area_line": {
943943
"refs": {
944-
"ubuntu_focal_chrome_headless": "216ed82"
944+
"ubuntu_focal_chrome_headless": "50079f1"
945945
}
946946
},
947947
"web_content/templates/stack_group_circle": {
948948
"refs": {
949-
"ubuntu_focal_chrome_headless": "e8ae87d"
949+
"ubuntu_focal_chrome_headless": "1cdadd2"
950950
}
951951
},
952952
"web_content/templates/stack_group_treemap": {
953953
"refs": {
954-
"ubuntu_focal_chrome_headless": "ac68318"
954+
"ubuntu_focal_chrome_headless": "c2f4df5"
955955
}
956956
},
957957
"web_content/templates/total_element_bubble_2_bar": {
958958
"refs": {
959-
"ubuntu_focal_chrome_headless": "997c7a8"
959+
"ubuntu_focal_chrome_headless": "0632611"
960960
}
961961
},
962962
"web_content/templates/total_element_bubble_column": {
963963
"refs": {
964-
"ubuntu_focal_chrome_headless": "106e4a0"
964+
"ubuntu_focal_chrome_headless": "6eda945"
965965
}
966966
},
967967
"web_content/templates/total_time_area_bar": {
968968
"refs": {
969-
"ubuntu_focal_chrome_headless": "07fad88"
969+
"ubuntu_focal_chrome_headless": "19e6038"
970970
}
971971
},
972972
"web_content/templates/total_time_area_column": {
973973
"refs": {
974-
"ubuntu_focal_chrome_headless": "d7c9567"
974+
"ubuntu_focal_chrome_headless": "a4bc218"
975975
}
976976
},
977977
"web_content/templates/total_time_bar_line": {
978978
"refs": {
979-
"ubuntu_focal_chrome_headless": "e4bb944"
979+
"ubuntu_focal_chrome_headless": "80359f9"
980980
}
981981
},
982982
"web_content/templates/total_time_column_line": {
983983
"refs": {
984-
"ubuntu_focal_chrome_headless": "44c0c9f"
984+
"ubuntu_focal_chrome_headless": "456aa5d"
985985
}
986986
},
987987
"web_content/templates/treemap_radial": {
@@ -991,12 +991,12 @@
991991
},
992992
"web_content/templates/zoom_area": {
993993
"refs": {
994-
"ubuntu_focal_chrome_headless": "0c56164"
994+
"ubuntu_focal_chrome_headless": "601b206"
995995
}
996996
},
997997
"web_content/templates/zoom_line": {
998998
"refs": {
999-
"ubuntu_focal_chrome_headless": "70d084e"
999+
"ubuntu_focal_chrome_headless": "a56f4f9"
10001000
}
10011001
}
10021002
}

0 commit comments

Comments
 (0)