Skip to content

Commit 8349c28

Browse files
committed
Updated docs.
1 parent 215e998 commit 8349c28

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

docs/using.rst

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -783,12 +783,26 @@ will display the chart in full.
783783

784784
.. warning::
785785

786-
The current version of **Highcharts for Python** assumes that your web content already
787-
has all the ``<script/>`` tags which include the
788-
`Highcharts (JS) <https://www.highcharts.com>`__ modules your chart relies on.
786+
The :meth:`.to_js_literal() <highcharts_core.chart.Chart.to_js_literal>` method
787+
assumes that your web content already has all the ``<script/>`` tags which include
788+
the `Highcharts (JS) <https://www.highcharts.com>`__ modules your chart relies on.
789789

790-
This is likely to change in a future version of **Highcharts for Python**, where the
791-
library will support the production of ``<script/>`` tags (see roadmap issue :issue:`12`).
790+
If you need to generate the required ``<script/>`` tags for your chart, you can do
791+
so by calling:
792+
793+
.. code-block:: python
794+
795+
# EXAMPLE 1.
796+
# Get a list of <script/> tags.
797+
list_of_script_tags = my_chart.get_script_tags()
798+
799+
# EXAMPLE 2.
800+
# Get a string of <script/> tags.
801+
script_tags_as_str = my_chart.get_script_tags(as_str = True)
802+
803+
# EXAMPLE 3.
804+
# Get a list of the required Highcharts modules.
805+
required_modules = my_chart.get_required_modules()
792806
793807
For example:
794808

0 commit comments

Comments
 (0)