Skip to content

Commit f056e4f

Browse files
committed
Update the docs for ChartMaker
1 parent 28b08ee commit f056e4f

File tree

2 files changed

+56
-26
lines changed

2 files changed

+56
-26
lines changed

examples/chart_maker/ReadMe.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -150,13 +150,16 @@ self.create_pie_chart(
150150
use this to select which one.
151151
title - The title displayed for the chart.
152152
subtitle - The subtitle displayed for the chart.
153-
data_name - Set the series name. Useful for multi-series charts.
153+
data_name - The series name. Useful for multi-series charts.
154+
If no data_name, will default to using "Series 1".
154155
unit - The description label given to the chart's y-axis values.
155156
libs - The option to include Chart libraries (JS and CSS files).
156157
Should be set to True (default) for the first time creating
157-
a chart on a web page. If creating multiple charts on
158-
a web page, you no longer need to re-import the libraries
158+
a chart on a web page. If creating multiple charts on the
159+
same web page, you won't need to re-import the libraries
159160
when creating additional charts.
161+
labels - If True, displays labels on the chart for data points.
162+
legend - If True, displays the data point legend on the chart.
160163
"""
161164
```
162165

@@ -170,13 +173,16 @@ self.create_bar_chart(
170173
use this to select which one.
171174
title - The title displayed for the chart.
172175
subtitle - The subtitle displayed for the chart.
173-
data_name - Set the series name. Useful for multi-series charts.
176+
data_name - The series name. Useful for multi-series charts.
177+
If no data_name, will default to using "Series 1".
174178
unit - The description label given to the chart's y-axis values.
175179
libs - The option to include Chart libraries (JS and CSS files).
176180
Should be set to True (default) for the first time creating
177-
a chart on a web page. If creating multiple charts on
178-
a web page, you no longer need to re-import the libraries
181+
a chart on a web page. If creating multiple charts on the
182+
same web page, you won't need to re-import the libraries
179183
when creating additional charts.
184+
labels - If True, displays labels on the chart for data points.
185+
legend - If True, displays the data point legend on the chart.
180186
"""
181187
```
182188

@@ -190,13 +196,16 @@ self.create_column_chart(
190196
use this to select which one.
191197
title - The title displayed for the chart.
192198
subtitle - The subtitle displayed for the chart.
193-
data_name - Set the series name. Useful for multi-series charts.
199+
data_name - The series name. Useful for multi-series charts.
200+
If no data_name, will default to using "Series 1".
194201
unit - The description label given to the chart's y-axis values.
195202
libs - The option to include Chart libraries (JS and CSS files).
196203
Should be set to True (default) for the first time creating
197-
a chart on a web page. If creating multiple charts on
198-
a web page, you no longer need to re-import the libraries
204+
a chart on a web page. If creating multiple charts on the
205+
same web page, you won't need to re-import the libraries
199206
when creating additional charts.
207+
labels - If True, displays labels on the chart for data points.
208+
legend - If True, displays the data point legend on the chart.
200209
"""
201210
```
202211

@@ -210,14 +219,17 @@ self.create_line_chart(
210219
use this to select which one.
211220
title - The title displayed for the chart.
212221
subtitle - The subtitle displayed for the chart.
213-
data_name - Set the series name. Useful for multi-series charts.
222+
data_name - The series name. Useful for multi-series charts.
223+
If no data_name, will default to using "Series 1".
214224
unit - The description label given to the chart's y-axis values.
215225
zero - If True, the y-axis always starts at 0. (Default: False).
216226
libs - The option to include Chart libraries (JS and CSS files).
217227
Should be set to True (default) for the first time creating
218-
a chart on a web page. If creating multiple charts on
219-
a web page, you no longer need to re-import the libraries
228+
a chart on a web page. If creating multiple charts on the
229+
same web page, you won't need to re-import the libraries
220230
when creating additional charts.
231+
labels - If True, displays labels on the chart for data points.
232+
legend - If True, displays the data point legend on the chart.
221233
"""
222234
```
223235

@@ -231,14 +243,17 @@ self.create_area_chart(
231243
use this to select which one.
232244
title - The title displayed for the chart.
233245
subtitle - The subtitle displayed for the chart.
234-
data_name - Set the series name. Useful for multi-series charts.
246+
data_name - The series name. Useful for multi-series charts.
247+
If no data_name, will default to using "Series 1".
235248
unit - The description label given to the chart's y-axis values.
236249
zero - If True, the y-axis always starts at 0. (Default: False).
237250
libs - The option to include Chart libraries (JS and CSS files).
238251
Should be set to True (default) for the first time creating
239252
a chart on a web page. If creating multiple charts on the
240253
same web page, you won't need to re-import the libraries
241254
when creating additional charts.
255+
labels - If True, displays labels on the chart for data points.
256+
legend - If True, displays the data point legend on the chart.
242257
"""
243258
```
244259

help_docs/chart_maker.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -150,13 +150,16 @@ self.create_pie_chart(
150150
use this to select which one.
151151
title - The title displayed for the chart.
152152
subtitle - The subtitle displayed for the chart.
153-
data_name - Set the series name. Useful for multi-series charts.
153+
data_name - The series name. Useful for multi-series charts.
154+
If no data_name, will default to using "Series 1".
154155
unit - The description label given to the chart's y-axis values.
155156
libs - The option to include Chart libraries (JS and CSS files).
156157
Should be set to True (default) for the first time creating
157-
a chart on a web page. If creating multiple charts on
158-
a web page, you no longer need to re-import the libraries
158+
a chart on a web page. If creating multiple charts on the
159+
same web page, you won't need to re-import the libraries
159160
when creating additional charts.
161+
labels - If True, displays labels on the chart for data points.
162+
legend - If True, displays the data point legend on the chart.
160163
"""
161164
```
162165

@@ -170,13 +173,16 @@ self.create_bar_chart(
170173
use this to select which one.
171174
title - The title displayed for the chart.
172175
subtitle - The subtitle displayed for the chart.
173-
data_name - Set the series name. Useful for multi-series charts.
176+
data_name - The series name. Useful for multi-series charts.
177+
If no data_name, will default to using "Series 1".
174178
unit - The description label given to the chart's y-axis values.
175179
libs - The option to include Chart libraries (JS and CSS files).
176180
Should be set to True (default) for the first time creating
177-
a chart on a web page. If creating multiple charts on
178-
a web page, you no longer need to re-import the libraries
181+
a chart on a web page. If creating multiple charts on the
182+
same web page, you won't need to re-import the libraries
179183
when creating additional charts.
184+
labels - If True, displays labels on the chart for data points.
185+
legend - If True, displays the data point legend on the chart.
180186
"""
181187
```
182188

@@ -190,13 +196,16 @@ self.create_column_chart(
190196
use this to select which one.
191197
title - The title displayed for the chart.
192198
subtitle - The subtitle displayed for the chart.
193-
data_name - Set the series name. Useful for multi-series charts.
199+
data_name - The series name. Useful for multi-series charts.
200+
If no data_name, will default to using "Series 1".
194201
unit - The description label given to the chart's y-axis values.
195202
libs - The option to include Chart libraries (JS and CSS files).
196203
Should be set to True (default) for the first time creating
197-
a chart on a web page. If creating multiple charts on
198-
a web page, you no longer need to re-import the libraries
204+
a chart on a web page. If creating multiple charts on the
205+
same web page, you won't need to re-import the libraries
199206
when creating additional charts.
207+
labels - If True, displays labels on the chart for data points.
208+
legend - If True, displays the data point legend on the chart.
200209
"""
201210
```
202211

@@ -210,14 +219,17 @@ self.create_line_chart(
210219
use this to select which one.
211220
title - The title displayed for the chart.
212221
subtitle - The subtitle displayed for the chart.
213-
data_name - Set the series name. Useful for multi-series charts.
222+
data_name - The series name. Useful for multi-series charts.
223+
If no data_name, will default to using "Series 1".
214224
unit - The description label given to the chart's y-axis values.
215225
zero - If True, the y-axis always starts at 0. (Default: False).
216226
libs - The option to include Chart libraries (JS and CSS files).
217227
Should be set to True (default) for the first time creating
218-
a chart on a web page. If creating multiple charts on
219-
a web page, you no longer need to re-import the libraries
228+
a chart on a web page. If creating multiple charts on the
229+
same web page, you won't need to re-import the libraries
220230
when creating additional charts.
231+
labels - If True, displays labels on the chart for data points.
232+
legend - If True, displays the data point legend on the chart.
221233
"""
222234
```
223235

@@ -231,14 +243,17 @@ self.create_area_chart(
231243
use this to select which one.
232244
title - The title displayed for the chart.
233245
subtitle - The subtitle displayed for the chart.
234-
data_name - Set the series name. Useful for multi-series charts.
246+
data_name - The series name. Useful for multi-series charts.
247+
If no data_name, will default to using "Series 1".
235248
unit - The description label given to the chart's y-axis values.
236249
zero - If True, the y-axis always starts at 0. (Default: False).
237250
libs - The option to include Chart libraries (JS and CSS files).
238251
Should be set to True (default) for the first time creating
239252
a chart on a web page. If creating multiple charts on the
240253
same web page, you won't need to re-import the libraries
241254
when creating additional charts.
255+
labels - If True, displays labels on the chart for data points.
256+
legend - If True, displays the data point legend on the chart.
242257
"""
243258
```
244259

0 commit comments

Comments
 (0)