Skip to content

Commit 37fcb31

Browse files
hcpchrishcpchris
committed
Updated docs.
1 parent 40d976e commit 37fcb31

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+4104
-375
lines changed

‎README.rst‎

Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -244,55 +244,52 @@ Hello World, and Basic Usage
244244

245245
.. code-block:: python
246246
247+
# from a primitive array, using keyword arguments
248+
my_chart = Chart(data = [[1, 23], [2, 34], [3, 45]],
249+
series_type = 'line')
250+
251+
# from a primitive array, using the .from_array() method
252+
my_chart = Chart.from_array([[1, 23], [2, 34], [3, 45]],
253+
series_type = 'line')
254+
255+
# from a Numpy ndarray, using keyword arguments
256+
my_chart = Chart(data = numpy_array, series_type = 'line')
257+
258+
# from a Numpy ndarray, using the .from_array() method
259+
my_chart = Chart.from_array(data = numpy_array, series_type = 'line')
260+
247261
# from a JavaScript file
248-
my_chart = highcharts.Chart.from_js_literal('my_js_literal.js')
262+
my_chart = Chart.from_js_literal('my_js_literal.js')
249263
250264
# from a JSON file
251-
my_chart = highcharts.Chart.from_json('my_json.json')
265+
my_chart = Chart.from_json('my_json.json')
252266
253267
# from a Python dict
254-
my_chart = highcharts.Chart.from_dict(my_dict_obj)
255-
256-
# from a GeoPandas GeoDataFrame
257-
my_chart = highcharts.Chart.from_geopandas(gdf,
258-
property_map = {
259-
'z': 'caseCount',
260-
'id': 'id',
261-
},
262-
series_type = 'mapbubble')
268+
my_chart = Chart.from_dict(my_dict_obj)
263269
264270
# from a Pandas dataframe
265-
my_chart = highcharts.Chart.from_pandas(df,
266-
property_map = {
267-
'x': 'transactionDate',
268-
'y': 'invoiceAmt',
269-
'id': 'id'
270-
},
271-
series_type = 'line')
271+
my_chart = Chart.from_pandas(df)
272272
273273
# from a PySpark dataframe
274-
my_chart = highcharts.Chart.from_pyspark(df,
275-
property_map = {
276-
'x': 'transactionDate',
277-
'y': 'invoiceAmt',
278-
'id': 'id'
279-
},
280-
series_type = 'line')
274+
my_chart = Chart.from_pyspark(df,
275+
property_map = {
276+
'x': 'transactionDate',
277+
'y': 'invoiceAmt',
278+
'id': 'id'
279+
},
280+
series_type = 'line')
281281
282282
# from a CSV
283-
my_chart = highcharts.Chart.from_csv('/some_file_location/filename.csv'
284-
column_property_map = {
285-
'x': 0,
286-
'y': 4,
287-
'id': 14
288-
},
289-
series_type = 'line')
283+
my_chart = Chart.from_csv('/some_file_location/filename.csv')
290284
291285
# from a HighchartsOptions configuration object
292-
my_chart = highcharts.Chart.from_options(my_options)
286+
my_chart = Chart.from_options(my_options)
293287
294-
# from a Series configuration
295-
my_chart = highcharts.Chart.from_series(my_series)
288+
# from a Series configuration, using keyword arguments
289+
my_chart = Chart(series = my_series)
290+
291+
# from a Series configuration, using .from_series()
292+
my_chart = Chart.from_series(my_series)
296293
297294
298295
3. Configure Global Settings (optional)
@@ -321,9 +318,10 @@ Hello World, and Basic Usage
321318

322319
.. code-block:: python
323320
324-
from highcharts_maps.options.title import Title
325-
from highcharts_maps.options.credits import Credits
321+
from highcharts_core.options.title import Title
322+
from highcharts_core.options.credits import Credits
326323
324+
# EXAMPLE 1.
327325
# Using dicts
328326
my_chart.title = {
329327
'align': 'center'
@@ -334,7 +332,7 @@ Hello World, and Basic Usage
334332
335333
my_chart.credits = {
336334
'enabled': True,
337-
'href': 'https://www.highcharts.com/',
335+
'href': 'https://www.highchartspython.com/',
338336
'position': {
339337
'align': 'center',
340338
'vertical_align': 'bottom',
@@ -349,14 +347,19 @@ Hello World, and Basic Usage
349347
'text': 'Chris Modzelewski'
350348
}
351349
350+
# EXAMPLE 2.
352351
# Using direct objects
353-
from highcharts_maps.options.title import Title
354-
from highcharts_maps.options.credits import Credits
352+
from highcharts_core.options.title import Title
353+
from highcharts_core.options.credits import Credits
355354
356-
my_title = Title(text = 'The Title for My Chart', floating = True, align = 'center')
355+
my_title = Title(text = 'The Title for My Chart',
356+
floating = True,
357+
align = 'center')
357358
my_chart.options.title = my_title
358359
359-
my_credits = Credits(text = 'Chris Modzelewski', enabled = True, href = 'https://www.highcharts.com')
360+
my_credits = Credits(text = 'Chris Modzelewski',
361+
enabled = True,
362+
href = 'https://www.highchartspython.com')
360363
my_chart.options.credits = my_credits
361364
362365
@@ -399,6 +402,13 @@ that will render the chart wherever it is you want it to go:
399402
my_image_bytes = my_chart.download_chart(filename = 'my_target_file.png',
400403
format = 'png')
401404
405+
8. Render Your Chart in a Jupyter Notebook
406+
===============================================
407+
408+
.. code-block:: python
409+
410+
my_chart.display()
411+
402412
--------------
403413

404414
***********************

‎docs/api.rst‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,27 +473,40 @@ Core Components
473473
- :class:`DataPointAccessibility <highcharts_maps.options.series.data.accessibility.DataPointAccessibility>`
474474
* - :mod:`.options.series.data.arcdiagram <highcharts_maps.options.series.data.arcdiagram>`
475475
- :class:`ArcDiagramData <highcharts_maps.options.series.data.arcdiagram.ArcDiagramData>`
476+
:class:`ArcDiagramDataCollection <highcharts_maps.options.series.data.arcidagram.ArcDiagramDataCollection>`
476477
* - :mod:`.options.series.data.bar <highcharts_maps.options.series.data.bar>`
477478
- :class:`BarData <highcharts_maps.options.series.data.bar.BarData>`
479+
:class:`BarDataCollection <highcharts_maps.options.series.data.bar.BarDataCollection>`
478480
:class:`WaterfallData <highcharts_maps.options.series.data.bar.WaterfallData>`
481+
:class:`WaterfallDataCollection <highcharts_maps.options.series.data.bar.WaterfallDataCollection>`
479482
:class:`WindBarbData <highcharts_maps.options.series.data.bar.WindBarbData>`
483+
:class:`WindBarbDataCollection <highcharts_maps.options.series.data.bar.WindBarbDataCollection>`
480484
:class:`XRangeData <highcharts_maps.options.series.data.bar.XRangeData>`
485+
:class:`XRangeDataCollection <highcharts_maps.options.series.data.bar.XRangeDataCollection>`
481486
* - :mod:`.options.series.data.base <highcharts_maps.options.series.data.base>`
482487
- :class:`DataBase <highcharts_maps.options.series.data.base.DataBase>`
483-
:class:`DataCore <highcharts_maps.options.series.data.base.DataCore>`
484488
* - :mod:`.options.series.data.boxplot <highcharts_maps.options.series.data.boxplot>`
485489
- :class:`BoxPlotData <highcharts_maps.options.series.data.boxplot.BoxPlotData>`
490+
:class:`BoxPlotDataCollection <highcharts_maps.options.series.data.boxplot.BoxPlotDataCollection>`
486491
* - :mod:`.options.series.data.bullet <highcharts_maps.options.series.data.bullet>`
487492
- :class:`BulletData <highcharts_maps.options.series.data.bullet.BulletData>`
493+
:class:`BulletDataCollection <highcharts_maps.options.series.data.bullet.BulletDataCollection>`
488494
* - :mod:`.options.series.data.cartesian <highcharts_maps.options.series.data.cartesian>`
489495
- :class:`CartesianData <highcharts_maps.options.series.data.cartesian.CartesianData>`
496+
:class:`CartesianDataCollection <highcharts_maps.options.series.data.cartesian.CartesianDataCollection>`
490497
:class:`Cartesian3DData <highcharts_maps.options.series.data.cartesian.Cartesian3DData>`
498+
:class:`Cartesian3DDataCollection <highcharts_maps.options.series.data.cartesian.Cartesian3DDataCollection>`
491499
:class:`CartesianValueData <highcharts_maps.options.series.data.cartesian.CartesianValueData>`
500+
:class:`CartesianValueDataCollection <highcharts_maps.options.series.data.cartesian.CartesianValueDataCollection>`
501+
* - :mod:`.options.series.data.collections <highcharts_maps.options.series.data.collections>`
502+
- :class:`DataPointCollection <highcharts_maps.options.series.data.collections.DataPointCollection>`
492503
* - :mod:`.options.series.data.connections <highcharts_maps.options.series.data.connections>`
493504
- :class:`ConnectionData <highcharts_maps.options.series.data.connections.ConnectionData>`
494-
:class:`FlowmapData <highcharts_maps.options.series.data.connections.FlowmapData>`
505+
:class:`ConnectionDataCollection <highcharts_maps.options.series.data.connections.ConnectionDataCollection>`
495506
:class:`WeightedConnectionData <highcharts_maps.options.series.data.connections.WeightedConnectionData>`
507+
:class:`WeightedConnectionDataCollection <highcharts_maps.options.series.data.connections.WeightedConnectionDataCollection>`
496508
:class:`OutgoingWeightedConnectionData <highcharts_maps.options.series.data.connections.OutgoingWeightedConnectionData>`
509+
:class:`OutgoingWeightedConnectionDataCollection <highcharts_maps.options.series.data.connections.OutgoingWeightedConnectionDataCollection>`
497510
:class:`ConnectionBase <highcharts_maps.options.series.data.connections.ConnectionBase>`
498511
* - :mod:`.options.series.data.geometric <highcharts_maps.options.series.data.geometric>`
499512
- :class:`GeometricData <highcharts_maps.options.series.data.GeometricData`
@@ -505,29 +518,44 @@ Core Components
505518
:class:`AsyncMapData <highcharts_maps.options.series.data.map_data.AsyncMapData>`
506519
* - :mod:`.options.series.data.pie <highcharts_maps.options.series.data.pie>`
507520
- :class:`PieData <highcharts_maps.options.series.data.pie.PieData>`
521+
:class:`PieDataCollection <highcharts_maps.options.series.data.pie.PieDataCollection>`
508522
:class:`VariablePieData <highcharts_maps.options.series.data.pie.VariablePieData>`
523+
:class:`VariablePieDataCollection <highcharts_maps.options.series.data.pie.VariablePieDataCollection>`
509524
* - :mod:`.options.series.data.range <highcharts_maps.options.series.data.range>`
510525
- :class:`RangeData <highcharts_maps.options.series.data.range.RangeData>`
526+
:class:`RangeDataCollection <highcharts_maps.options.series.data.range.RangeDataCollection>`
511527
:class:`ConnectedRangeData <highcharts_maps.options.series.data.range.ConnectedRangeData>`
528+
:class:`ConnectedRangeDataCollection <highcharts_maps.options.series.data.range.ConnectedRangeDataCollection>`
512529
* - :mod:`.options.series.data.single_point <highcharts_maps.options.series.data.single_point>`
513530
- :class:`SinglePointData <highcharts_maps.options.series.data.single_point.SinglePointData>`
531+
:class:`SinglePointDataCollection <highcharts_maps.options.series.data.single_point.SinglePointDataCollection>`
514532
:class:`SingleValueData <highcharts_maps.options.series.data.single_point.SingleValueData>`
533+
:class:`SingleValueDataCollection <highcharts_maps.options.series.data.single_point.SingleValueDataCollection>`
515534
:class:`SingleXData <highcharts_maps.options.series.data.single_point.SingleXData>`
535+
:class:`SingleXDataCollection <highcharts_maps.options.series.data.single_point.SingleXDataCollection>`
516536
:class:`LabeledSingleXData <highcharts_maps.options.series.data.single_point.LabeledSingleXData>`
537+
:class:`LabeledSingleXDataCollection <highcharts_maps.options.series.data.single_point.LabeledSingleXDataCollection>`
517538
:class:`ConnectedSingleXData <highcharts_maps.options.series.data.single_point.ConnectedSingleXData>`
539+
:class:`ConnectedSingleXDataCollection <highcharts_maps.options.series.data.single_point.ConnectedSingleXDataCollection>`
518540
:class:`SinglePointBase <highcharts_maps.options.series.data.single_point.SinglePointBase>`
519541
* - :mod:`.options.series.data.sunburst <highcharts_maps.options.series.data.sunburst>`
520542
- :class:`SunburstData <highcharts_maps.options.series.data.sunburst.SunburstData>`
543+
:class:`SunburstDataCollection <highcharts_maps.options.series.data.sunburst.SunburstDataCollection>`
521544
* - :mod:`.options.series.data.treegraph <highcharts_maps.options.series.data.treegraph>`
522545
- :class:`TreegraphData <highcharts_maps.options.series.data.treegraph.TreegraphData>`
546+
:class:`TreegraphDataCollection <highcharts_maps.options.series.data.treegraph.TreegraphDataCollection>`
523547
* - :mod:`.options.series.data.treemap <highcharts_maps.options.series.data.treemap>`
524548
- :class:`TreemapData <highcharts_maps.options.series.data.treemap.TreemapData>`
549+
:class:`TreemapDataCollection <highcharts_maps.options.series.data.treemap.TreemapDataCollection>`
525550
* - :mod:`.options.series.data.vector <highcharts_maps.options.series.data.vector>`
526551
- :class:`VectorData <highcharts_maps.options.series.data.vector.VectorData>`
552+
:class:`VectorDataCollection <highcharts_maps.options.series.data.vector.VectorDataCollection>`
527553
* - :mod:`.options.series.data.venn <highcharts_maps.options.series.data.venn>`
528554
- :class:`VennData <highcharts_maps.options.series.data.venn.VennData>`
555+
:class:`VennDataCollection <highcharts_maps.options.series.data.venn.VennDataCollection>`
529556
* - :mod:`.options.series.data.wordcloud <highcharts_maps.options.series.data.wordcloud>`
530557
- :class:`WordcloudData <highcharts_maps.options.series.data.wordcloud.WordcloudData>`
558+
:class:`WordcloudDataCollection <highcharts_maps.options.series.data.wordcloud.WordcloudDataCollection>`
531559
* - :mod:`.options.series.dependencywheel <highcharts_maps.options.series.dependencywheel>`
532560
- :class:`DependencyWheelSeries <highcharts_maps.options.series.dependencywheel.DependencyWheelSeries>`
533561
* - :mod:`.options.series.dumbbell <highcharts_maps.options.series.dumbbell>`
@@ -769,6 +797,12 @@ need to familiarize yourself with these internals.
769797
:func:`validate_color() <highcharts_maps.utility_functions.validate_color>`
770798
:func:`to_camelCase() <highcharts_maps.utility_functions.to_camelCase>`
771799
:func:`parse_csv() <highcharts_maps.utility_functions.parse_csv>`
800+
* - :mod:`.ai <highcharts_maps.ai>`
801+
- :func:`convert_to_js() <highcharts_maps.ai.convert_to_js>`
802+
:func:`openai_moderate() <highcharts_maps.ai.openai_moderate>`
803+
:func:`openai_conversion() <highcharts_maps.ai.openai_conversion>`
804+
:func:`anthropic_conversion() <highcharts_maps.ai.anthropic_conversion>`
805+
:func:`get_source() <highcharts_maps.ai.get_source>`
772806

773807
.. target-notes::
774808

‎docs/api/options/series/data/arcdiagram.rst‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
--------------
1111

12-
.. module:: highcharts_maps.options.series.data.arcdiagram
12+
.. module:: highcharts_core.options.series.data.arcdiagram
1313

1414
********************************************************************************************************************
1515
class: :class:`ArcDiagramData <highcharts_maps.options.series.data.arcdiagram.ArcDiagramData>`
@@ -22,7 +22,27 @@ class: :class:`ArcDiagramData <highcharts_maps.options.series.data.arcdiagram.Ar
2222
.. collapse:: Class Inheritance
2323

2424
.. inheritance-diagram:: ArcDiagramData
25-
:top-classes: highcharts_maps.metaclasses.HighchartsMeta, highcharts_core.metaclasses.HighchartsMeta
25+
:top-classes: highcharts_core.metaclasses.HighchartsMeta
26+
:parts: -1
27+
28+
|
29+
30+
--------------
31+
32+
.. module:: highcharts_core.options.series.data.arcdiagram
33+
34+
********************************************************************************************************************
35+
class: :class:`ArcDiagramDataCollection <highcharts_maps.options.series.data.arcdiagram.ArcDiagramDataCollection>`
36+
********************************************************************************************************************
37+
38+
.. autoclass:: ArcDiagramDataCollection
39+
:members:
40+
:inherited-members:
41+
42+
.. collapse:: Class Inheritance
43+
44+
.. inheritance-diagram:: ArcDiagramDataCollection
45+
:top-classes: highcharts_core.metaclasses.HighchartsMeta
2646
:parts: -1
2747

2848
|

0 commit comments

Comments
 (0)