Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating readme #252

Merged
merged 4 commits into from
Dec 24, 2023
Merged

Updating readme #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3fa55cf
Updating readme
Dec 24, 2023
b81df3a
Updating .circleci/config.yml
Dec 24, 2023
c8ce3ee
Updating .circleci/config.yml
Dec 24, 2023
ed9d7ae
Fixing yml syntax
Dec 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ jobs:
working_directory: ~/repo

steps:
- browser-tools/install-chrome
- browser-tools/install-chromedriver
- run: sudo apt-get update
- browser-tools/install-chrome:
chrome-version: "114.0.5735.90"
- browser-tools/install-browser-tools
- run:
command: |
google-chrome --version
Expand Down
20 changes: 1 addition & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ The `plotly.js` is bundled within the angular code. To avoid this, please read [
| -------------------------- | ---------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `[data]` | `Array` | `[]` | list of trace objects (see https://plot.ly/javascript/reference/) |
| `[layout]` | `Object` | `undefined` | layout object (see https://plot.ly/javascript/reference/#layout) |
| `[theme]` | `string` | `'none'` | name of pre-defined theme (see [Using themes](#Using%20themes))
| `[frames]` | `Array` | `undefined` | list of frame objects (see https://plot.ly/javascript/reference/) |
| `[config]` | `Object` | `undefined` | config object (see https://plot.ly/javascript/configuration-options/) |
| `[revision]` | `Number` | `undefined` | When provided, causes the plot to update when the revision is incremented. |
Expand Down Expand Up @@ -181,23 +180,6 @@ will put the user template into the root *\<div\>* of the resulting *plotly.js*
in front of any plotly-generated elements. This could be useful for implementing plot overlays.


## Using themes

There are few pre-defined themes you can use:
* ggplot2
* seaborn
* simple_white
* plotly
* plotly_white
* plotly_dark
* presentation
* xgridoff
* ygridoff
* gridon

These themes were based on [plotly.py](https://github.com/plotly/plotly.py/tree/6f519c8fc459651e1b03704fa83bd66c804f8a67/packages/python/plotly/plotly/package_data/templates)


## Customizing the `plotly.js` bundle

By default, this library bundles `plotly.js` from the peer dependency together within the output. This results on huge outputs, for `plotly.js` itself is ~3MB when bundled. It also makes the build (with `ng serve --prod`) really slow, for it minifies everything together.
Expand Down Expand Up @@ -260,7 +242,7 @@ PlotlyViaCDNModule.loadViaCDN('custom', 'https://custom.cdn/url'); // can be use
...
"options": {
"scripts": [
"node_modules/plotly.js/dist/plotly.min.js" // add this
"node_modules/plotly.js-dist-min/plotly.min.js" // add this
]
}
}
Expand Down