diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 35e00f6c6688..000000000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,115 +0,0 @@ -version: 2 -jobs: - build: - branches: - ignore: - - gh-pages - - docker: - # a packaged system that has the instructions for creating a running container. - - image: circleci/ruby:2.3.3 - - # actions that need to be taken to perform your job - steps: - - add_ssh_keys: - fingerprints: - - "dc:5f:39:48:00:b4:72:34:e1:d2:c4:e1:1f:d1:e2:ce" #plotlydocbot - - - restore_cache: - keys: - - source-v1- #one time, not every time! - - # checks out the source code for a job over SSH - - checkout - - - save_cache: - key: source-v1-1 # Sept 7, 2019 - paths: - - ".git" - - - restore_cache: - keys: - - gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }} - - gem-cache-v1-{{ arch }}-{{ .Branch }} - - gem-cache-v1 - - - run: - name: install dependencies - command: | - bundle install --path vendor/bundle - sudo apt-get update - sudo apt install python-pip - sudo pip install python-frontmatter - sudo pip install pathlib - - - save_cache: - key: gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }} - paths: - - vendor/bundle - - - run: - name: deployment - command: | - git config --global user.email "accounts@plot.ly" - git config --global user.name "plotlydocbot" - rm -rf _posts/python/html - rm -rf _posts/r/md - git clone -b built git@github.com:plotly/plotly.py-docs _posts/python/html - git clone -b built git@github.com:plotly/plotly.r-docs _posts/r/md - mv _posts/r/md/ggplot2 _posts/ggplot2/md - python front-matter-ci.py _posts - python check-or-enforce-order.py _posts/python - python check-or-enforce-order.py _posts/python-v3 - python check-or-enforce-order.py _posts/r/ - python check-or-enforce-order.py _posts/plotly_js - bundle exec jekyll build - mkdir snapshots - cd _site - cp -r 'all_static' '../snapshots' - cp 'api/index.html' '../snapshots' - cp --parents 'python/index.html' '../snapshots' - cp --parents 'python/getting-started/index.html' '../snapshots' - cp --parents 'python/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'python/line-and-scatter/index.html' '../snapshots' - cp --parents 'r/index.html' '../snapshots' - cp --parents 'r/getting-started/index.html' '../snapshots' - cp --parents 'r/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'r/line-and-scatter/index.html' '../snapshots' - cp --parents 'javascript/index.html' '../snapshots' - cp --parents 'javascript/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'javascript/getting-started/index.html' '../snapshots' - cp --parents 'javascript/line-and-scatter/index.html' '../snapshots' - cp --parents 'ggplot2/index.html' '../snapshots' - cp --parents 'ggplot2/getting-started/index.html' '../snapshots' - cp --parents 'ggplot2/geom_abline/index.html' '../snapshots' - cp --parents 'python/v3/index.html' '../snapshots' - cp --parents 'python/v3/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'python/v3/getting-started/index.html' '../snapshots' - cp --parents 'python/v3/line-and-scatter/index.html' '../snapshots' - cp --parents 'matlab/index.html' '../snapshots' - cp --parents 'matlab/getting-started/index.html' '../snapshots' - cp --parents 'matlab/graphing-multiple-chart-types/index.html' '../snapshots' - cp --parents 'matlab/scatter/index.html' '../snapshots' - cd .. - rm -f 'snapshots/all_static/javascripts/jquery-knob/index.html' - rm -f 'snapshots/all_static/images/Plotly-feed2.html' - rm -f 'snapshots/all_static/images/Plotly.html' - rm -f 'snapshots/all_static/images/Plotly-Feed.html' - sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*.html - sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*/*.html - sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*/*/*.html - rm -f snapshots/*.bkp - rm -f snapshots/*/*.bkp - rm -f snapshots/*/*/*.bkp - percy snapshot snapshots --enable_javascript - rm -rf 'snapshots/' - if [ "${CIRCLE_BRANCH}" == "source-design-merge" ]; then - git checkout gh-pages - git pull origin gh-pages - cp -r _site/* . - rm -rf _site/ - touch .nojekyll - git add . - git commit -m "deploying https://github.com/plotly/documentation/commit/${CIRCLE_SHA1}" - git push origin gh-pages - fi diff --git a/.gitignore b/.gitignore index 71fc1e2c4f92..f6b6e57e19d8 100755 --- a/.gitignore +++ b/.gitignore @@ -28,3 +28,5 @@ documentation.Rproj .vscode _posts/r/md _posts/ggplot2/md + +_data/mapbox_token.yml diff --git a/Contributing.md b/Contributing.md index 0d5ca9bf62b5..81d0197e30d0 100755 --- a/Contributing.md +++ b/Contributing.md @@ -1,10 +1,43 @@ -# Repo Organization +# Contributing to Plotly's Graphing Libraries Documentation -Edit or add files in the `_posts` folder in the [source-design-merge](http://github.com/plotly/documentation/tree/source-design-merge) branch. +## Repo Overview -## Clone the Repo and Install Dependencies +Plotly welcomes contributions to its [open-source graphing libraries documentation](https://plot.ly/graphing-libraries) from its community of users. -1. Clone the repo and then check out the source-design-merge branch: +This repository mainly serves: +- Plotly's graphing libraries documentation index page at https://plot.ly/graphing-libraries. + +- Plotly's JavaScript graphing library documentation at https://plot.ly/javascript + - Please be aware that **only the content of Plotly's JavaScript graphing library documentation** (hosted at https://plot.ly/javascript) is contained in this repository. You can find the content in the `_posts/plotly_js` directory. + - For information about editing **plotly.js** documentation [click here](https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md). + +- Plotly's Python graphing library documentation at https://plot.ly/python + - The content for Plotly's Python graphing library documentation (hosted at https://plot.ly/python) **IS NOT** contained in this repository. It is contained in the `plotly.py` repository at https://github.com/plotly/plotly.py/tree/master/doc and is cloned into this repository at build time. + - For information about editing **plotly.py** documentation [click here](https://github.com/plotly/plotly.py/blob/master/doc/README.md). + +- Plotly's R graphing library documentation at https://plot.ly/r + - The content for Plotly's R graphing library documentation (hosted at https://plot.ly/r) **IS NOT** contained in this repository. It is contained in the `plotly.r-docs` repository at https://github.com/plotly/plotly.r-docs/ and is cloned into this repository at build time. + - For information about editing Plotly's **R** documentation [click here](https://github.com/plotly/plotly.r-docs/blob/master/README.md). + +## Contribute Quickly to Plotly's JavaScript Graphing Library Documentation + +To quickly make a contribution to Plotly's JavaScript graphing libraries documentation, simply submit a pull request with the change you would like to suggest. + +The easiest way to do this is to follow the `Edit this page on GitHub` link at the top right of the page you are interested in contributing to: + +![Screen Shot 2020-01-07 at 12 45 39 PM](https://user-images.githubusercontent.com/1557650/71916356-bfe53800-314b-11ea-92b6-eb763037f6d5.png) + +**Note:** You don't have to worry about breaking the site when you submit a pull request!** This is because your change will not be merged to production immediately. A Plotly team member will first perform a code review on your pull request. + +## How To Get The Application Working Locally + +For more extensive changes to Ploty's JavaScript documentation, we suggest getting the Jekyll application which builds the site to run locally so that you can test your changes as you develop them. + +This involves cloning the repository and installing its dependencies: [Git](https://git-scm.com/), [Ruby]((https://www.ruby-lang.org/en/), [Jekyll](https://jekyllrb.com/), and the [Python `requests` package](https://pypi.org/project/requests/). + +1. Use [`git`](https://git-scm.com/) to [clone](https://git-scm.com/docs/git-clone) the public `plotly/documentation` repository. Then [check out] (https://git-scm.com/docs/git-checkout) the source-design-merge branch of the `git` repository. + +To do so, run the following commands in your terminal: ```sh git clone git@github.com:plotly/documentation.git @@ -12,80 +45,75 @@ git fetch origin git checkout source-design-merge ``` -2. Check Ruby version `$ ruby --version`. We recommend using `version 2.3.3` or the same ruby version as [gh-pages](https://pages.github.com/versions/). Note [RVM](https://rvm.io/rvm/install) is helpful for installing and managing ruby versions. +**Note:** For historical reasons, the `source-design-merge` branch is the `master` branch of this repository. -3. Install bundler and dependencies from the `Gemfile`: +Running `git status` in your terminal should then output the following: ```sh -gem install bundler -bundle install +On branch source-design-merge +Your branch is up to date with 'origin/source-design-merge'. + +nothing to commit, working tree clean ``` -Note these dependencies should be the same version that [gh-pages](https://pages.github.com/versions/) is using. +2. Download Ruby and check your `Ruby` version by running the `ruby --version` command in your terminal. -4. When we deploy, a function is run to update the plot schema. To do this successfully you have to make sure you have the `requests` python package: `pip install requests` +**Note:** We recommend using `version 2.3.3` or the same ruby version as [gh-pages](https://pages.github.com/versions/). Note [RVM](https://rvm.io/rvm/install) is helpful for installing and managing ruby versions. -## Making Changes +3. Download Jekyll and check your Jekyll version by running the `jekyll -v` command in your terminal. We recommend using the same ruby version as [gh-pages](https://pages.github.com/versions/). -- For information about editing **plotly.js** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/plotly_js/README.md -- For information about editing **python** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/python/README.md -- For information about editing **R** docs see: https://github.com/plotly/documentation/blob/source-design-merge/_posts/r/README.md -- For information about editing chart studio documentation found at [https://help.plot.ly/tutorials/](https://help.plot.ly/tutorials/) please see this repo: [https://github.com/plotly/plotly.github.io](https://github.com/plotly/plotly.github.io) +4. Install bundler and dependencies from the Jekyll applicaton's [`Gemfile`](https://github.com/plotly/documentation/blob/source-design-merge/Gemfile) by running the following commands in your terminal: + +```sh +gem install bundler +bundle install +``` -## Render Changes Locally +**Note:** These dependencies should be the same version that [gh-pages](https://pages.github.com/versions/) is using. -Please **ALWAYS** locally serve the docs and check your changes before committing updates. +5. Serve the Jekyll application: `bundle exec jekyll serve --config _config_dev.yml`. -1. To serve the docs locally, in the documentation repo run: `bundle exec jekyll serve --config _config_dev.yml` -2. Visit the pages at: [http://localhost:4000/python/](http://localhost:4000/python/) -3. When you make changes, jekyll should automatically regenerate for you. Read the messages in your terminal to check it out +6. Visit the pages at: [http://localhost:4000/](http://localhost:4000) -There are a TON of posts in here, so rendering can take up to -thirty minutes! You can *limit* the number of posts that render by -excluding folders in the `_config_dev.yml` file. +**Note** The default Jekyll configuration file only builds the JavaScript posts by [excluding folders](https://jekyllrb.com/docs/configuration/options/). If you want to override this behavior, serve the application with a custom Jekyll configuration file in the root of the repository. Do this by copying `_config_dev.yml`, renaming it `_config_personal.yml`, and modifying the `exclude` statement. -For example, change `_config_dev.yml` to this: +- If you name the Jekyll configuration file `_config_personal.yml`, it will be caught by the `.gitignore` file and not committed to version control. +- Run `bundle exec jekyll serve --config _config_personal.yml` to use the custom configuration file +- Example configuration: ```yml -staticurl: http://localhost:4000/all_static -exclude: [_posts/ggplot2, _posts/julia, _posts/matlab, _posts/matplotlib, _posts/nodejs, _posts/r] # [_posts/python,] +# --- +# Excludes every directory except JavaScript +# --- +exclude: ['_posts/reference_pages', _posts/ggplot2','_posts/julia','_posts/matlab','_posts/node_js','_posts/r','_posts/python','_posts/python-v3','_posts/misc','_posts/dashboards',_posts/scala', '_posts/nodejs', 'node_modules'] ``` -and you'll only load the files in `_posts/python`. +and you'll only load the files in `_posts/plotly_js` directory because that is the only directory that is not excluded. -Change it to this +Change it to this: ```yml +# --- +# Excludes no directory +# --- staticurl: http://localhost:4000/all_static exclude: [] ``` -and it'll load everything. - -## Make a PR -Ready for your changes to be reviewed? Make a pull request against the `source-design-merge` branch! -Create a feature branch and use `git status` to list changed files. +and you'll load every file because no directories are excluded. -(Make sure that the feature branch is a branch off from `source-design-merge` local branch in your machine and not from any other previously worked branch). -```sh -git checkout -b your_feature_branch -git status -``` -Add, commit, and push the files that you'd like to add to your pr: -```sh -git add file-a -git add file-b -git commit -m 'message about your changes' -git push origin your_feature_branch -``` -Visit the [documentation repo](https://github.com/plotly/documentation) and open a pull request against the `source-design-merge` branch. +## Continuous Integration -After your PR has been reviewed and approved, you can merge it into the `source-design-merge` branch! Your changes haven't been deployed yet so they won't be online. That said, be sure to check them after they have been deployed. +Whenever a pull request is made, a continuous integration workflow is initiated. This includes of: + - running the `check-or-enforce-order.py` and `front-matter-ci.py` scripts inside of a Docker container to validate YAML front-matter + - Percy screenshot testing -## Search +Making sure that a pull request passes every continuous integration test is a part of the code review process. -We now have search via algolia implemented on our index and reference documentation pages! Please refer to our [make README](https://github.com/plotly/documentation/blob/source-design-merge/make_instructions.txt) for more information on how search works and instructions on how to update or edit Plotly search indices. +**For more information about the build process, inspect the CircleCI configuration file in this repository at https://github.com/plotly/documentation/blob/source-design-merge/.circleci/config.yml.** -## Style Edits +## Other Documentation -Please refer to our [Styles README](https://github.com/plotly/documentation/blob/source-design-merge/style_README.md) +This repository also contains: + - Plotly's Node.js, Matlab, Scala, Julia, and Python V3 graphing libraries documentation + - the reference pages for Plotly's JavaScript, Python, R, and Matlab graphing libraries. diff --git a/Gemfile.lock b/Gemfile.lock index b5b05c59a96a..72163f3b7648 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -45,7 +45,7 @@ GEM eventmachine (1.2.7) eventmachine (1.2.7-x64-mingw32) eventmachine (1.2.7-x86-mingw32) - excon (0.67.0) + excon (0.71.0) execjs (2.7.0) faraday (0.15.3) multipart-post (>= 1.2, < 3) @@ -226,19 +226,19 @@ GEM ruby_dep (~> 1.2) mercenary (0.3.6) method_source (0.9.0) - mini_portile2 (2.3.0) + mini_portile2 (2.4.0) minima (2.5.0) jekyll (~> 3.5) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) minitest (5.11.3) multipart-post (2.0.0) - nokogiri (1.8.4) - mini_portile2 (~> 2.3.0) - nokogiri (1.8.4-x64-mingw32) - mini_portile2 (~> 2.3.0) - nokogiri (1.8.4-x86-mingw32) - mini_portile2 (~> 2.3.0) + nokogiri (1.10.5) + mini_portile2 (~> 2.4.0) + nokogiri (1.10.5-x64-mingw32) + mini_portile2 (~> 2.4.0) + nokogiri (1.10.5-x86-mingw32) + mini_portile2 (~> 2.4.0) octokit (4.12.0) sawyer (~> 0.8.0, >= 0.5.3) octopress (3.0.11) diff --git a/Rakefile b/Rakefile index 3ad04be7df8b..a1c0fc076005 100755 --- a/Rakefile +++ b/Rakefile @@ -31,6 +31,7 @@ task :serve => [] do puts "...getting latest python docs" system "rm -rf _posts/python/html" or exit!(1) system "rm -rf _posts/r/md" or exit!(1) + system "rm -rf _posts/ggplot2/md/ggplot2" or exit!(1) system "git clone -b built git@github.com:plotly/plotly.py-docs _posts/python/html" or exit!(1) system "git clone -b built git@github.com:plotly/plotly.r-docs _posts/r/md" or exit!(1) system "mv _posts/r/md/ggplot2 _posts/ggplot2/md" or exit!(1) diff --git a/_config_python_search.yml b/_config_python_search.yml index 6734902d7354..e6cc1089b5e2 100755 --- a/_config_python_search.yml +++ b/_config_python_search.yml @@ -18,7 +18,7 @@ exclude: [ '_posts/nodejs', '_posts/temp', 'vendor', 'node_modules', - 'plotly.py-docs' + 'plotly.py' ] # --- @@ -37,7 +37,7 @@ algolia: - '*.png' - '*.Rmd' - '*.R' - - 'plotly.py-docs' + - 'plotly.py' - '_posts/dashboards' - '_posts/ggplot2' - '_posts/julia' diff --git a/_data/orderings.json b/_data/orderings.json index 0b6ffc3a4dd1..a6ba9ec3360d 100644 --- a/_data/orderings.json +++ b/_data/orderings.json @@ -8,6 +8,7 @@ "width", "height", "font", + "uniformtext", "separators", "paper_bgcolor", "plot_bgcolor", @@ -184,6 +185,7 @@ "indicessrc", "intensity", "intensitysrc", + "intensitymode", "value", "valuesrc", @@ -201,6 +203,7 @@ "lat", "latsrc", "geojson", + "featureidkey", "locations", "locationssrc", "lon", @@ -294,6 +297,23 @@ "notched", "notchwidth", "whiskerwidth", + "q1", + "median", + "q3", + "lowerfence", + "upperfence", + "notchspan", + "mean", + "sd", + "quartilemethod", + "q1src", + "mediansrc", + "q3src", + "lowerfencesrc", + "upperfencesrc", + "notchspansrc", + "meansrc", + "sdsrc", "colormodel", "color", @@ -370,6 +390,7 @@ "hoverongaps", "insidetextanchor", "insidetextfont", + "insidetextorientation", "outsidetextfont", "isomax", "isomin", diff --git a/_data/plotschema.json b/_data/plotschema.json index cf3c5fd3010e..df947dfcabe4 100644 --- a/_data/plotschema.json +++ b/_data/plotschema.json @@ -4490,7 +4490,7 @@ "role": "info", "dflt": "", "editType": "plot", - "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ", + "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`.", "arrayOk": true }, "texttemplatesrc": { @@ -4544,7 +4544,7 @@ "role": "info", "dflt": "", "editType": "none", - "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.", + "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.", "arrayOk": true }, "hovertemplatesrc": { @@ -6738,6 +6738,19 @@ "editType": "none" } }, + "insidetextorientation": { + "valType": "enumerated", + "role": "info", + "values": [ + "horizontal", + "radial", + "tangential", + "auto" + ], + "dflt": "auto", + "editType": "plot", + "description": "Determines the orientation of text inside slices. With *auto* the texts may automatically be rotated to fit with the maximum size inside the slice. Using *horizontal* option forces text to be horizontal. Using *radial* option forces text to be radial. Using *tangential* option forces text to be tangential." + }, "outsidetextfont": { "family": { "valType": "string", @@ -6929,7 +6942,8 @@ "categories": [ "cartesian", "svg", - "2dMap" + "2dMap", + "showLegend" ], "animatable": false, "type": "heatmap", @@ -6959,6 +6973,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -11333,7 +11361,7 @@ }, "box": { "meta": { - "description": "In vertical (horizontal) box plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one box per distinct x (y) value is drawn If no `x` (`y`) {array} is provided, a single box is drawn. That box position is then positioned with with `name` or with `x0` (`y0`) if provided. Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2) is marked by a line inside the box. By default, the whiskers correspond to the box' edges +/- 1.5 times the interquartile range (IQR: Q3-Q1), see *boxpoints* for other options." + "description": "Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes' edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the `y` data array for vertical boxes (`x` for horizontal boxes). By supplying an `x` (`y`) array, one box per distinct `x` (`y`) value is drawn If no `x` (`y`) {array} is provided, a single box is drawn. In this case, the box is positioned with the trace `name` or with `x0` (`y0`) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the `q1`, `median` and `q3` data arrays respectively. Other box features relying on statistics namely `lowerfence`, `upperfence`, `notchspan` can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the `y` data array for vertical boxes (`x` for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size." }, "categories": [ "cartesian", @@ -11424,7 +11452,13 @@ "valType": "any", "role": "info", "editType": "calc+clearAxisTypes", - "description": "Sets the x coordinate of the box. See overview for more info." + "description": "Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info." + }, + "dx": { + "valType": "number", + "role": "info", + "editType": "calc", + "description": "Sets the x coordinate step for multi-box traces set using q1/median/q3." }, "y": { "valType": "data_array", @@ -11442,7 +11476,13 @@ "valType": "any", "role": "info", "editType": "calc+clearAxisTypes", - "description": "Sets the y coordinate of the box. See overview for more info." + "description": "Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info." + }, + "dy": { + "valType": "number", + "role": "info", + "editType": "calc", + "description": "Sets the y coordinate step for multi-box traces set using q1/median/q3." }, "width": { "valType": "number", @@ -11974,10 +12014,9 @@ "sd", false ], - "dflt": false, "role": "style", "editType": "calc", - "description": "If *true*, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If *sd* the standard deviation is also drawn." + "description": "If *true*, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If *sd* the standard deviation is also drawn. Defaults to *true* when `mean` is set. Defaults to *sd* when `sd` is set Otherwise defaults to *false*." }, "boxpoints": { "valType": "enumerated", @@ -11987,16 +12026,15 @@ "suspectedoutliers", false ], - "dflt": "outliers", "role": "style", "editType": "calc", - "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the box(es) are shown with no sample points" + "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the box(es) are shown with no sample points Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to *all* under the q1/median/q3 signature. Otherwise defaults to *outliers*." }, "notched": { "valType": "boolean", - "role": "style", + "role": "info", "editType": "calc", - "description": "Determines whether or not notches should be drawn." + "description": "Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to *false* unless `notchwidth` or `notchspan` is set." }, "notchwidth": { "valType": "number", @@ -12016,6 +12054,114 @@ "editType": "calc", "description": "Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es)." }, + "q1": { + "valType": "data_array", + "role": "data", + "editType": "calc+clearAxisTypes", + "description": "Sets the Quartile 1 values. There should be as many items as the number of boxes desired." + }, + "median": { + "valType": "data_array", + "role": "data", + "editType": "calc+clearAxisTypes", + "description": "Sets the median values. There should be as many items as the number of boxes desired." + }, + "q3": { + "valType": "data_array", + "role": "data", + "editType": "calc+clearAxisTypes", + "description": "Sets the Quartile 3 values. There should be as many items as the number of boxes desired." + }, + "lowerfence": { + "valType": "data_array", + "role": "data", + "editType": "calc", + "description": "Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR." + }, + "upperfence": { + "valType": "data_array", + "role": "data", + "editType": "calc", + "description": "Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point above 1.5 times the IQR." + }, + "notchspan": { + "valType": "data_array", + "role": "data", + "editType": "calc", + "description": "Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size." + }, + "mean": { + "valType": "data_array", + "role": "data", + "editType": "calc", + "description": "Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values." + }, + "sd": { + "valType": "data_array", + "role": "data", + "editType": "calc", + "description": "Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values." + }, + "quartilemethod": { + "valType": "enumerated", + "values": [ + "linear", + "exclusive", + "inclusive" + ], + "dflt": "linear", + "role": "info", + "editType": "calc", + "description": "Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publications/jse/v14n3/langford.html). The *exclusive* method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The *inclusive* method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half." + }, + "q1src": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for q1 .", + "editType": "none" + }, + "mediansrc": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for median .", + "editType": "none" + }, + "q3src": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for q3 .", + "editType": "none" + }, + "lowerfencesrc": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for lowerfence .", + "editType": "none" + }, + "upperfencesrc": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for upperfence .", + "editType": "none" + }, + "notchspansrc": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for notchspan .", + "editType": "none" + }, + "meansrc": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for mean .", + "editType": "none" + }, + "sdsrc": { + "valType": "string", + "role": "info", + "description": "Sets the source reference on plot.ly for sd .", + "editType": "none" + }, "selectedpoints": { "valType": "any", "role": "info", @@ -12435,7 +12581,7 @@ "valType": "any", "role": "info", "editType": "calc+clearAxisTypes", - "description": "Sets the x coordinate of the box. See overview for more info." + "description": "Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info." }, "y": { "valType": "data_array", @@ -12453,7 +12599,7 @@ "valType": "any", "role": "info", "editType": "calc+clearAxisTypes", - "description": "Sets the y coordinate of the box. See overview for more info." + "description": "Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info." }, "width": { "valType": "number", @@ -13270,10 +13416,9 @@ "suspectedoutliers", false ], - "dflt": "outliers", "role": "style", "editType": "calc", - "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the violins are shown with no sample points" + "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the violins are shown with no sample points. Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to *outliers*." }, "scalegroup": { "valType": "string", @@ -15042,7 +15187,8 @@ "cartesian", "svg", "2dMap", - "histogram" + "histogram", + "showLegend" ], "animatable": false, "type": "histogram2d", @@ -15072,6 +15218,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -24783,7 +24943,7 @@ "categories": [ "gl3d", "2dMap", - "noOpacity" + "showLegend" ], "animatable": false, "type": "surface", @@ -24813,6 +24973,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "calc", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -26194,7 +26368,8 @@ "description": "Draws sets of triangles with coordinates given by three 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-shape algorithm or (4) the Convex-hull algorithm" }, "categories": [ - "gl3d" + "gl3d", + "showLegend" ], "animatable": false, "type": "mesh3d", @@ -26224,6 +26399,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -26332,7 +26521,7 @@ "intensity": { "valType": "data_array", "editType": "calc", - "description": "Sets the vertex intensity values, used for plotting fields on meshes", + "description": "Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes.", "role": "data" }, "intensitysrc": { @@ -26341,6 +26530,17 @@ "description": "Sets the source reference on plot.ly for intensity .", "editType": "none" }, + "intensitymode": { + "valType": "enumerated", + "values": [ + "vertex", + "cell" + ], + "dflt": "vertex", + "editType": "calc", + "role": "info", + "description": "Determines the source of `intensity` values." + }, "vertexcolor": { "valType": "data_array", "role": "data", @@ -27398,7 +27598,8 @@ "description": "Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, `w`. The cones are drawn exactly at the positions given by `x`, `y` and `z`." }, "categories": [ - "gl3d" + "gl3d", + "showLegend" ], "animatable": false, "type": "cone", @@ -27428,6 +27629,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -28467,7 +28682,8 @@ "description": "Use a streamtube trace to visualize flow in a vector field. Specify a vector field using 6 1D arrays of equal length, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, and `w`. By default, the tubes' starting positions will be cut from the vector field's x-z plane at its minimum y value. To specify your own starting position, use attributes `starts.x`, `starts.y` and `starts.z`. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w)." }, "categories": [ - "gl3d" + "gl3d", + "showLegend" ], "animatable": false, "type": "streamtube", @@ -28497,6 +28713,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -29548,7 +29778,8 @@ "description": "Draws volume trace between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non-uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace." }, "categories": [ - "gl3d" + "gl3d", + "showLegend" ], "animatable": false, "type": "volume", @@ -29578,6 +29809,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "calc", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -30844,7 +31089,8 @@ "description": "Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non-uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace." }, "categories": [ - "gl3d" + "gl3d", + "showLegend" ], "animatable": false, "type": "isosurface", @@ -30874,6 +31120,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "calc", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -32230,6 +32490,19 @@ "description": "Sets the source reference on plot.ly for lat .", "editType": "none" }, + "geojson": { + "valType": "any", + "role": "info", + "editType": "calc", + "description": "Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*." + }, + "featureidkey": { + "valType": "string", + "role": "info", + "editType": "calc", + "dflt": "id", + "description": "Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*." + }, "locations": { "valType": "data_array", "description": "Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.", @@ -33773,11 +34046,12 @@ "values": [ "ISO-3", "USA-states", - "country names" + "country names", + "geojson-id" ], "role": "info", "dflt": "ISO-3", - "description": "Determines the set of locations used to match entries in `locations` to regions on the map.", + "description": "Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.", "editType": "calc" }, "transforms": { @@ -33825,7 +34099,8 @@ }, "categories": [ "geo", - "noOpacity" + "noOpacity", + "showLegend" ], "animatable": false, "type": "choropleth", @@ -33855,6 +34130,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "ids": { "valType": "data_array", "editType": "calc", @@ -33879,6 +34168,19 @@ "description": "Sets the source reference on plot.ly for z .", "editType": "none" }, + "geojson": { + "valType": "any", + "role": "info", + "editType": "calc", + "description": "Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*." + }, + "featureidkey": { + "valType": "string", + "role": "info", + "editType": "calc", + "dflt": "id", + "description": "Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*." + }, "locations": { "valType": "data_array", "editType": "calc", @@ -34765,11 +35067,12 @@ "values": [ "ISO-3", "USA-states", - "country names" + "country names", + "geojson-id" ], "role": "info", "dflt": "ISO-3", - "description": "Determines the set of locations used to match entries in `locations` to regions on the map.", + "description": "Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.", "editType": "calc" }, "transforms": { @@ -36007,7 +36310,8 @@ "categories": [ "mapbox", "gl", - "noOpacity" + "noOpacity", + "showLegend" ], "animatable": false, "type": "choroplethmapbox", @@ -36037,6 +36341,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "ids": { "valType": "data_array", "editType": "calc", @@ -36065,7 +36383,14 @@ "valType": "any", "role": "info", "editType": "calc", - "description": "Sets the GeoJSON data associated with this trace. Can be set as a valid GeoJSON object or as URL string Note that we only accept GeoJSON of type *FeatureCollection* and *Feature* with geometries of type *Polygon* and *MultiPolygon*." + "description": "Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*." + }, + "featureidkey": { + "valType": "string", + "role": "info", + "editType": "calc", + "dflt": "id", + "description": "Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example *properties.name*." }, "locations": { "valType": "data_array", @@ -37000,7 +37325,8 @@ }, "categories": [ "mapbox", - "gl" + "gl", + "showLegend" ], "animatable": false, "type": "densitymapbox", @@ -37030,6 +37356,20 @@ "editType": "calc", "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible)." }, + "showlegend": { + "valType": "boolean", + "role": "info", + "dflt": false, + "editType": "style", + "description": "Determines whether or not an item corresponding to this trace is shown in the legend." + }, + "legendgroup": { + "valType": "string", + "role": "info", + "dflt": "", + "editType": "style", + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items." + }, "opacity": { "valType": "number", "role": "style", @@ -45442,6 +45782,19 @@ "editType": "none" } }, + "insidetextorientation": { + "valType": "enumerated", + "role": "info", + "values": [ + "horizontal", + "radial", + "tangential", + "auto" + ], + "dflt": "auto", + "editType": "plot", + "description": "Determines the orientation of text inside slices. With *auto* the texts may automatically be rotated to fit with the maximum size inside the slice. Using *horizontal* option forces text to be horizontal. Using *radial* option forces text to be radial. Using *tangential* option forces text to be tangential." + }, "outsidetextfont": { "family": { "valType": "string", @@ -45466,7 +45819,7 @@ "arrayOk": true }, "editType": "plot", - "description": "Sets the font used for `textinfo` lying outside the sector.", + "description": "Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented at the center of a sunburst graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used.", "role": "object", "familysrc": { "valType": "string", @@ -46912,7 +47265,7 @@ "arrayOk": true }, "editType": "plot", - "description": "Sets the font used for `textinfo` lying outside the sector.", + "description": "Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used.", "role": "object", "familysrc": { "valType": "string", @@ -56216,7 +56569,7 @@ "valType": "color", "role": "style", "editType": "legend", - "description": "Sets the legend background color." + "description": "Sets the legend background color. Defaults to `layout.paper_bgcolor`." }, "bordercolor": { "valType": "color", @@ -56383,6 +56736,52 @@ "editType": "legend", "description": "Sets the vertical alignment of the symbols with respect to their associated text." }, + "title": { + "text": { + "valType": "string", + "dflt": "", + "role": "info", + "editType": "legend", + "description": "Sets the title of the legend." + }, + "font": { + "family": { + "valType": "string", + "role": "style", + "noBlank": true, + "strict": true, + "editType": "legend", + "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*." + }, + "size": { + "valType": "number", + "role": "style", + "min": 1, + "editType": "legend" + }, + "color": { + "valType": "color", + "role": "style", + "editType": "legend" + }, + "editType": "legend", + "description": "Sets this legend's title font.", + "role": "object" + }, + "side": { + "valType": "enumerated", + "values": [ + "top", + "left", + "top left" + ], + "role": "style", + "editType": "legend", + "description": "Determines the location of legend's title with respect to the legend items. Defaulted to *top* with `orientation` is *h*. Defaulted to *left* with `orientation` is *v*. The *top left* options could be used to expand legend area in both x and y sides." + }, + "editType": "legend", + "role": "object" + }, "editType": "legend", "role": "object" }, @@ -56487,6 +56886,30 @@ "description": "Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.", "role": "object" }, + "uniformtext": { + "mode": { + "valType": "enumerated", + "values": [ + false, + "hide", + "show" + ], + "dflt": false, + "role": "info", + "editType": "plot", + "description": "Determines how the font size for various text elements are uniformed between each trace type. If the computed text sizes were smaller than the minimum size defined by `uniformtext.minsize` using *hide* option hides the text; and using *show* option shows the text without further downscaling. Please note that if the size defined by `minsize` is greater than the font size defined by trace, then the `minsize` is used." + }, + "minsize": { + "valType": "number", + "min": 0, + "dflt": 0, + "role": "info", + "editType": "plot", + "description": "Sets the minimum text size between traces of the same type." + }, + "editType": "plot", + "role": "object" + }, "separators": { "valType": "string", "role": "style", @@ -63457,6 +63880,18 @@ "editType": "plot", "role": "object" }, + "fitbounds": { + "valType": "enumerated", + "values": [ + false, + "locations", + "geojson" + ], + "dflt": false, + "role": "info", + "editType": "plot", + "description": "Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting `fitbounds` leads to `center.lon` and `center.lat` getting auto-filled. On maps with a non-clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, and `projection.rotation.lon` getting auto-filled. On maps with a clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, `projection.rotation.lon`, `projection.rotation.lat`, `lonaxis.range` and `lonaxis.range` getting auto-filled. If *locations*, only the trace's visible locations are considered in the `fitbounds` computations. If *geojson*, the entire trace input `geojson` (if provided) is considered in the `fitbounds` computations, Defaults to *false*." + }, "resolution": { "valType": "enumerated", "values": [ @@ -63581,6 +64016,13 @@ "editType": "plot", "role": "object" }, + "visible": { + "valType": "boolean", + "role": "info", + "dflt": true, + "description": "Sets the default visibility of the base layers.", + "editType": "plot" + }, "showcoastlines": { "valType": "boolean", "role": "info", @@ -67772,10 +68214,19 @@ "description": "Mapbox access token (required to plot mapbox trace types) If using an Mapbox Atlas server, set this option to '' so that plotly.js won't attempt to authenticate to the public Mapbox server." }, "logging": { - "valType": "boolean", + "valType": "integer", + "min": 0, + "max": 2, "dflt": 1, "description": "Turn all console logging on or off (errors will be thrown) This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no logs 1: warnings and errors, but not informational messages 2: verbose logs" }, + "notifyOnLogging": { + "valType": "integer", + "min": 0, + "max": 2, + "dflt": 0, + "description": "Set on-graph logging (notifier) level This should ONLY be set via Plotly.setPlotConfig Available levels: 0: no on-graph logs 1: warnings and errors, but not informational messages 2: verbose logs" + }, "queueLength": { "valType": "integer", "min": 0, diff --git a/_includes/layouts/helpbox.html b/_includes/layouts/helpbox.html index 29a71c75db21..057a73901346 100644 --- a/_includes/layouts/helpbox.html +++ b/_includes/layouts/helpbox.html @@ -7,7 +7,7 @@ diff --git a/_includes/layouts/new-to-plotly.html b/_includes/layouts/new-to-plotly.html new file mode 100644 index 000000000000..cddac95fe624 --- /dev/null +++ b/_includes/layouts/new-to-plotly.html @@ -0,0 +1,13 @@ + +{% if page.language == "python" or page.language == "plotly_js" or page.language == "r" or page.language == "ggplot2" %} +
+ New to Plotly? + {% if page.language == "python" %} +

Plotly is a free and open-source graphing library for Python. We recommend you read our Getting Started guide for the latest installation or upgrade instructions, then move on to our Plotly Fundamentals tutorials or dive straight in to some Basic Charts tutorials.

+ {% elsif page.language == "plotly_js" %} +

Plotly is a free and open-source graphing library for JavaScript. We recommend you read our Getting Started guide for the latest installation or upgrade instructions, then move on to our Plotly Fundamentals tutorials or dive straight in to some Basic Charts tutorials.

+ {% elsif page.language == "r" or page.language == "ggplot2" %} +

Plotly is a free and open-source graphing library for R. We recommend you read our Getting Started guide for the latest installation or upgrade instructions, then move on to our Plotly Fundamentals tutorials or dive straight in to some Basic Charts tutorials.

+ {% endif %} +
+{% endif %} diff --git a/_includes/layouts/side-bar.html b/_includes/layouts/side-bar.html index a4c35330fba4..c3c821685b10 100644 --- a/_includes/layouts/side-bar.html +++ b/_includes/layouts/side-bar.html @@ -24,7 +24,7 @@ {% assign pages_list = site.posts | where:"language", language %} -{% for page in pages_list %} +{%- for page in pages_list -%} {% if page.display_as == "chart_type" or page.display_as == "basic" %} {% assign basic = true %} {% elsif page.display_as == "file_settings" %} @@ -83,7 +83,7 @@ {% assign theme = true %} {% endif %} -{% endfor %} +{%- endfor -%}