Skip to content

Commit

Permalink
Update src/plugins/charts/public/services/palettes/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
  • Loading branch information
flash1293 and wylieconlon authored Dec 2, 2020
1 parent fc4c54f commit 432e22b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/plugins/charts/public/services/palettes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Palettes are integrated with the expression as well using the `system_palette` a

## Using the palette service

To consume the palette service, use `charts.palettes.getPalettes` to lazily load the async bundle implementing existing palettes. This should not happen as part of the `setup` or `start` phases of a consuming plugin, but only if it's certain palettes will actually be required.
To consume the palette service, use `charts.palettes.getPalettes` to lazily load the async bundle implementing existing palettes. This is recommended to be called in the renderer, not as part of the `setup` or `start` phases of a plugin.

All palette definitions can be loaded using `paletteService.getAll()`. If the id of the palette is known, it can be fetched using `paleteService.get(id)`.

Expand Down

0 comments on commit 432e22b

Please sign in to comment.