Skip to content

Commit 895bf51

Browse files
3838
committed
Update the documents
1 parent d6ee85b commit 895bf51

File tree

3 files changed

+132
-24
lines changed

3 files changed

+132
-24
lines changed

‎README.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -479,18 +479,54 @@ This behavior can also be turned off by setting `default_features = false`.
479479

480480
### List of Features
481481

482-
This is the full list of features that is defined by `Plotters` crate. Use `default_features = false` to disable those default enabled features, and then you should be able to cherry-pick what features you want to include into `Plotters` crate.
482+
This is the full list of features that is defined by `Plotters` crate.
483+
Use `default_features = false` to disable those default enabled features,
484+
and then you should be able to cherry-pick what features you want to include into `Plotters` crate.
485+
By doing so, you can minimize the number of dependencies down to only `itertools` and compile time is less than 6s.
486+
487+
The following list is a complete list of features that can be opt in and out.
488+
489+
- Drawing backends related features
483490

484491
| Name | Description | Additional Dependency |Default?|
485492
|---------|--------------|--------|------------|
486-
| image\_encoder | Allow `BitMapBackend` save the result to bitmap files | image | Yes |
487-
| svg | Enable `SVGBackend` Support | svg | Yes |
488-
| datetime| Enable Date and Time Coordinate Support| chrono | Yes |
493+
| image\_encoder | Allow `BitMapBackend` save the result to bitmap files | image, rusttype, font-kit | Yes |
494+
| svg | Enable `SVGBackend` Support | None | Yes |
489495
| gif\_backend| Opt-in GIF animation Rendering support for `BitMapBackend`, implies `bitmap` enabled | gif | Yes |
490-
| piston | Enable `PistonWindowBackend` | piston\_window | No |
491-
| cairo | Enable `CairoBackend` | cairo-rs | No |
492-
| palette\_ext | Use crate `palette` for color expression| palette | Yes |
493-
| evcxr | Enable Evcxr support, which allows use `Plotters` in Jupyter Note Book | None | No |
496+
| piston | Enable `PistonWindowBackend` | piston\_window, rusttype, font-kit | No |
497+
| cairo | Enable `CairoBackend` | cairo-rs, rusttype, font-kit | No |
498+
499+
- Font manipulation features
500+
501+
| Name | Description | Additional Dependency |Default?|
502+
|---------|--------------|--------|------------|
503+
| ttf | Allows TrueType font support | rusttype, font-kit | Yes |
504+
505+
- Coordinate features
506+
507+
| Name | Description | Additional Dependency |Default?|
508+
|---------|--------------|--------|------------|
509+
| datetime | Eanble the date and time coordinate support | chrono | Yes |
510+
511+
- Element, series and util functions
512+
513+
| Name | Description | Additional Dependency |Default?|
514+
|---------|--------------|--------|------------|
515+
| errorbar | The errorbar element support | None | Yes |
516+
| candlestick | The candlestick element support | None | Yes |
517+
| boxplot | The boxplot element support | None | Yes |
518+
| area\_series | The area series support | None | Yes |
519+
| line\_series | The line series support | None | Yes |
520+
| histogram | The histogram series support | None | Yes |
521+
| point\_series| The point series support | None | Yes |
522+
523+
- Misc
524+
525+
| Name | Description | Additional Dependency |Default?|
526+
|---------|--------------|--------|------------|
527+
| deprecated\_items | This feature allows use of deprecated items which is going to be removed in the future | None | Yes |
528+
| debug | Enable the code used for debugging | None | No |
529+
494530

495531
## FAQ List
496532

‎doc-template/readme.template.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -245,18 +245,54 @@ This behavior can also be turned off by setting `default_features = false`.
245245

246246
### List of Features
247247

248-
This is the full list of features that is defined by `Plotters` crate. Use `default_features = false` to disable those default enabled features, and then you should be able to cherry-pick what features you want to include into `Plotters` crate.
248+
This is the full list of features that is defined by `Plotters` crate.
249+
Use `default_features = false` to disable those default enabled features,
250+
and then you should be able to cherry-pick what features you want to include into `Plotters` crate.
251+
By doing so, you can minimize the number of dependencies down to only `itertools` and compile time is less than 6s.
252+
253+
The following list is a complete list of features that can be opt in and out.
254+
255+
- Drawing backends related features
249256

250257
| Name | Description | Additional Dependency |Default?|
251258
|---------|--------------|--------|------------|
252-
| image\_encoder | Allow `BitMapBackend` save the result to bitmap files | image | Yes |
253-
| svg | Enable `SVGBackend` Support | svg | Yes |
254-
| datetime| Enable Date and Time Coordinate Support| chrono | Yes |
259+
| image\_encoder | Allow `BitMapBackend` save the result to bitmap files | image, rusttype, font-kit | Yes |
260+
| svg | Enable `SVGBackend` Support | None | Yes |
255261
| gif\_backend| Opt-in GIF animation Rendering support for `BitMapBackend`, implies `bitmap` enabled | gif | Yes |
256-
| piston | Enable `PistonWindowBackend` | piston\_window | No |
257-
| cairo | Enable `CairoBackend` | cairo-rs | No |
258-
| palette\_ext | Use crate `palette` for color expression| palette | Yes |
259-
| evcxr | Enable Evcxr support, which allows use `Plotters` in Jupyter Note Book | None | No |
262+
| piston | Enable `PistonWindowBackend` | piston\_window, rusttype, font-kit | No |
263+
| cairo | Enable `CairoBackend` | cairo-rs, rusttype, font-kit | No |
264+
265+
- Font manipulation features
266+
267+
| Name | Description | Additional Dependency |Default?|
268+
|---------|--------------|--------|------------|
269+
| ttf | Allows TrueType font support | rusttype, font-kit | Yes |
270+
271+
- Coordinate features
272+
273+
| Name | Description | Additional Dependency |Default?|
274+
|---------|--------------|--------|------------|
275+
| datetime | Eanble the date and time coordinate support | chrono | Yes |
276+
277+
- Element, series and util functions
278+
279+
| Name | Description | Additional Dependency |Default?|
280+
|---------|--------------|--------|------------|
281+
| errorbar | The errorbar element support | None | Yes |
282+
| candlestick | The candlestick element support | None | Yes |
283+
| boxplot | The boxplot element support | None | Yes |
284+
| area\_series | The area series support | None | Yes |
285+
| line\_series | The line series support | None | Yes |
286+
| histogram | The histogram series support | None | Yes |
287+
| point\_series| The point series support | None | Yes |
288+
289+
- Misc
290+
291+
| Name | Description | Additional Dependency |Default?|
292+
|---------|--------------|--------|------------|
293+
| deprecated\_items | This feature allows use of deprecated items which is going to be removed in the future | None | Yes |
294+
| debug | Enable the code used for debugging | None | No |
295+
260296

261297
## FAQ List
262298

‎src/lib.rs

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -600,18 +600,54 @@ This behavior can also be turned off by setting `default_features = false`.
600600
601601
### List of Features
602602
603-
This is the full list of features that is defined by `Plotters` crate. Use `default_features = false` to disable those default enabled features, and then you should be able to cherry-pick what features you want to include into `Plotters` crate.
603+
This is the full list of features that is defined by `Plotters` crate.
604+
Use `default_features = false` to disable those default enabled features,
605+
and then you should be able to cherry-pick what features you want to include into `Plotters` crate.
606+
By doing so, you can minimize the number of dependencies down to only `itertools` and compile time is less than 6s.
607+
608+
The following list is a complete list of features that can be opt in and out.
609+
610+
- Drawing backends related features
604611
605612
| Name | Description | Additional Dependency |Default?|
606613
|---------|--------------|--------|------------|
607-
| image\_encoder | Allow `BitMapBackend` save the result to bitmap files | image | Yes |
608-
| svg | Enable `SVGBackend` Support | svg | Yes |
609-
| datetime| Enable Date and Time Coordinate Support| chrono | Yes |
614+
| image\_encoder | Allow `BitMapBackend` save the result to bitmap files | image, rusttype, font-kit | Yes |
615+
| svg | Enable `SVGBackend` Support | None | Yes |
610616
| gif\_backend| Opt-in GIF animation Rendering support for `BitMapBackend`, implies `bitmap` enabled | gif | Yes |
611-
| piston | Enable `PistonWindowBackend` | piston\_window | No |
612-
| cairo | Enable `CairoBackend` | cairo-rs | No |
613-
| palette\_ext | Use crate `palette` for color expression| palette | Yes |
614-
| evcxr | Enable Evcxr support, which allows use `Plotters` in Jupyter Note Book | None | No |
617+
| piston | Enable `PistonWindowBackend` | piston\_window, rusttype, font-kit | No |
618+
| cairo | Enable `CairoBackend` | cairo-rs, rusttype, font-kit | No |
619+
620+
- Font manipulation features
621+
622+
| Name | Description | Additional Dependency |Default?|
623+
|---------|--------------|--------|------------|
624+
| ttf | Allows TrueType font support | rusttype, font-kit | Yes |
625+
626+
- Coordinate features
627+
628+
| Name | Description | Additional Dependency |Default?|
629+
|---------|--------------|--------|------------|
630+
| datetime | Eanble the date and time coordinate support | chrono | Yes |
631+
632+
- Element, series and util functions
633+
634+
| Name | Description | Additional Dependency |Default?|
635+
|---------|--------------|--------|------------|
636+
| errorbar | The errorbar element support | None | Yes |
637+
| candlestick | The candlestick element support | None | Yes |
638+
| boxplot | The boxplot element support | None | Yes |
639+
| area\_series | The area series support | None | Yes |
640+
| line\_series | The line series support | None | Yes |
641+
| histogram | The histogram series support | None | Yes |
642+
| point\_series| The point series support | None | Yes |
643+
644+
- Misc
645+
646+
| Name | Description | Additional Dependency |Default?|
647+
|---------|--------------|--------|------------|
648+
| deprecated\_items | This feature allows use of deprecated items which is going to be removed in the future | None | Yes |
649+
| debug | Enable the code used for debugging | None | No |
650+
615651
616652
## FAQ List
617653

0 commit comments

Comments
 (0)