Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Documentation for Parallel Categories trace type #1096

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.

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

Merged
merged 8 commits into from
Nov 7, 2018

Conversation

jonmmease
Copy link
Contributor

@jonmmease jonmmease commented Sep 19, 2018

Overview

This PR contains WIP documentation for the still-under-development Parallel Categories trace type (plotly/plotly.js#2963). This trace is currently slated for plotly.js 1.42, and I'd like to have JavaScript and Python docs ready to go soon after release.

  • JavaScript
  • Python example notebook

TODO:

  • Move CodePen examples to plotly account
  • Remap plotly.js src URLs to official CDN after 1.42 is released

Highlights

screen shot 2018-09-19 at 9 17 12 am

CodePen Examples

https://codepen.io/plotly/pen/KrpmQO
https://codepen.io/plotly/pen/yQNbxy
https://codepen.io/plotly/pen/BGNRqM
https://codepen.io/plotly/pen/jQPmXN
https://codepen.io/plotly/pen/EOjmrW

@jonmmease
Copy link
Contributor Author

Documentation GIFs

parcats-titanic

cars-brushing

cars-multicolor-brushing

@jonmmease jonmmease changed the title [WIP] Documentation for Parallel Categories trace type Documentation for Parallel Categories trace type Nov 6, 2018
@jonmmease jonmmease added the ReviewReady This PR is ready for review label Nov 6, 2018
@jonmmease
Copy link
Contributor Author

Ready for review 🎉
cc @cldougl

@@ -0,0 +1,14 @@
---
title: Javascript Graphing Library Parallel Categories Diagram | Examples | Plotly
name: Parallel Categories
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably call this the full: Parallel Categories Diagram

---
title: Javascript Graphing Library Parallel Categories Diagram | Examples | Plotly
name: Parallel Categories
permalink: javascript/parcats/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/parallel-categories-diagram
is more similar to: https://plot.ly/javascript/parallel-coordinates-plot/

<span class="n">fig</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">on_click</span><span class="p">(</span><span class="n">update_color</span><span class="p">)</span>

<span class="c1"># Display figure</span>
<span class="n">widgets</span><span class="o">.</span><span class="n">VBox</span><span class="p">([</span><span class="n">color_toggle</span><span class="p">,</span> <span class="n">fig</span><span class="p">])</span>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

such an awesome example!

</div>
</div>
</div>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add reference section to point to reference page -- similar to https://plot.ly/python/parallel-coordinates-plot/#reference

@@ -0,0 +1,596 @@
---
permalink: python/parcats/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same url comment as js

---
permalink: python/parcats/
description: How to make parallel categories visualizations in Python with Plotly.
name: Parallel Categories
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parallel Categories Diagram

@@ -0,0 +1,596 @@
---
permalink: python/parcats/
description: How to make parallel categories visualizations in Python with Plotly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd call this diagrams as well to keep it consistent w/ the js doc

@cldougl cldougl removed the ReviewReady This PR is ready for review label Nov 7, 2018
Copy link
Member

@cldougl cldougl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be good to merge 💃 after adding the python reference section and considering the url/name consistency comments

 1) Call it parallel categories diagram consistently
 2) Use parallel-categories-diagram as URL
 3) Add References section to Python documentation
 4) Uploaded notebook and updated "Download this notebook" info
@jonmmease
Copy link
Contributor Author

Thanks for the review @cldougl! I implemented all of your suggestions in 43aa838. Merging!

@jonmmease jonmmease merged commit fdae51f into source-design-merge Nov 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants