Use correct parent document when necessary: fixes 702 #2

nielsenb-jf · 2016-07-20T15:58:55Z

This pull request fixes the issues noted in issue 702. Essentially, if Plotly was provided an element in a different window or tab, the plot would not be styled correctly and interactivity (hovers, drag zoom, etc.) would not work.

The following are the big changes to fix this issue:

Graph divs now keep a reference to their 'parent' document in the `_document' property.
Styles are now injected to the parent document on the first call to Plotly.plot.
Anything that draws over a document for interactivity purposes (eg. dragcovers), now uses the _document reference to ensure it is drawn in the correct document.
Notifiers now require a graph div as the first argument so that notifications are rendered in the correct place

- to determine if an attribute val is valid

- now only coerce numbers, dates and boolean to string

- to determine whether user 'data' and 'layout' are valid in plotly.js

- only value that have same correct length and all item valid are consisdered valid.

This fixes the issue with the dragcover not being appended to the correct child when the plot is rendered on a window other than the parent.

- make Plotly.validate return a 1-level deep array of error objects - add 'container' and 'trace' key in each error object to locate the error in data trace or layout. - add 'astr' to error object (for easy plug into restyle and relayout)

This fixes the issue with range slider events being tied to the parent window, as opposed to the child, when rendering to a div in a child window.

Introducing Plotly.validate(data, layout)

This fixes the assumption that the plot should be sized based on the window Plotly was instantiated in, instead of the window Plotly is drawing the plot in.

…lotly#513)

The previous behavior was to inject CSS into the document the Plotly JS is loaded in. This causes plots rendered in a different document to not be styled correctly. Now, the CSS is injected into the correct document during Plotly.plot.

files. Also change the built plotcss file to export the rules, not inject them.

Add a z-index to js-plotly-tester as a workaround for a chrome bug

Fix repeated val case in scattermapbox convert step

This fixes the issue with notifications not appearing in the correct window when plotting to a child window. The notification is now appended to the body of the document the graph div is a child of.

This fixes issue where styles are not properly applied to a child window if the first plot is in the parent, or vice versa.

The _plotCSSLoaded property is set to true after injecting the CSS.

…ed in. This reference is used where necessary to ensure functionality when plotting to a window other than the one Plotly was instantiated in.

'inserts styles on initial plot' - Deletes all plotly CSS in the document (in case other tests have run previously), does a plot, and verifies the CSS has been injected. 'inserts styles in a child window document' - Creates a plot in a child window, and makes sure the CSS has been injected. The child window is then closed, no cleanup required. 'does not insert duplicate styles' - Deletes all plotly CSS in the document, plots to the graph div twice, and ensures the required Plotly CSS only occurs once.

This fixes the issue with notifications not appearing in the correct window when plotting to a child window. The notification is now appended to the body of the document the graph div is a child of.

… into child_window_fixes

Horizontal legend in columns

etpinard and others added 30 commits June 27, 2016 17:54

add Lib.validate function:

e94eec3

- to determine if an attribute val is valid

make is-valid colorscale array more strict

9814edf

make string val type more strict:

0b3040b

- now only coerce numbers, dates and boolean to string

add a few test cases for coerce + 'info_array'

a5bc7fe

add validateFunction for info_array

6c1938c

make 'dflt' a required opts for 'subplotid' val types

d304864

add validate function for 'subplotid' val types

877077b

add Plotly.validate:

1958dc6

- to determine whether user 'data' and 'layout' are valid in plotly.js

validate: add support for is isSubplotObj attributes

f620a22

validate: add 'container' error code

a2c52fe

on 2nd thought, only coerce numbers to strings

ad8db59

clean up is-valid-colorscale logic

09ed024

make info_array validate func more strict:

a2f2160

- only value that have same correct length and all item valid are consisdered valid.

Ensure the dragcover is rendered on the proper element.

5d7904e

This fixes the issue with the dragcover not being appended to the correct child when the plot is rendered on a window other than the parent.

Be consistent with use of ownerDocument.

d69b72d

Merge branch 'master' into coverslip_fix

02ac18f

validate: flatten Plotly.validate output

54a6ed0

- make Plotly.validate return a 1-level deep array of error objects - add 'container' and 'trace' key in each error object to locate the error in data trace or layout. - add 'astr' to error object (for easy plug into restyle and relayout)

Ensure range sliders use the correct child document / window.

f10706d

This fixes the issue with range slider events being tied to the parent window, as opposed to the child, when rendering to a div in a child window.

Merge pull request plotly#697 from plotly/validate

926bfd5

Introducing Plotly.validate(data, layout)

Properly resize plot based on plot parent window.

0bec933

This fixes the assumption that the plot should be sized based on the window Plotly was instantiated in, instead of the window Plotly is drawing the plot in.

Merge branch 'master' into child_window_fixes

bac79fe

Add a z-index to js-plotly-tester as a workaround for a chrome bug (p…

4dacf4d

…lotly#513)

Don't hardcode CSS in plotcss_injector, instead use the generated style

5f57f08

files. Also change the built plotcss file to export the rules, not inject them.

Merge pull request plotly#745 from benjeffery/zindex

2d8a0da

Add a z-index to js-plotly-tester as a workaround for a chrome bug

Merge branch 'master' into child_window_fixes

a1204ec

Fix formatting.

e19f8d8

scattermapbox: override hash item if undefined (in case === 0)

f94accc

Merge pull request plotly#747 from plotly/mapbox-repeated-vals

7ae437b

Fix repeated val case in scattermapbox convert step

Add issue and pr template from CONTRIBUTING.md

064c888

nielsenb-jf and others added 27 commits July 20, 2016 10:48

Notifier now requires a graph div as the first argument.

0da000e

This fixes the issue with notifications not appearing in the correct window when plotting to a child window. The notification is now appended to the body of the document the graph div is a child of.

Add issue and pr template from CONTRIBUTING.md

d3fc39d

Fix naming of PR template

21a250a

Actually include the PR template

9c8b402

Guideline cleanup

febed0e

Punctuation detail

b9d936a

When injecting styles, don't inject a duplicate selector.

d526dd3

Don't keep a reference to the stylesheet in lib.

b8c5e10

This fixes issue where styles are not properly applied to a child window if the first plot is in the parent, or vice versa.

Merge branch 'child_window_fixes' into child_css

457a49c

Fix formatting.

96e6815

Merge branch 'child_window_fixes' into child_css

43d42f8

Make injectStyles take the graph div (gd) as the argument.

f97305f

Move addStyleRule code to injectStyles, delete lib.addStyleRule.

ae9b2ba

Only injectStyles if they haven't already been injected.

eb536d4

The _plotCSSLoaded property is set to true after injecting the CSS.

Graph div now keeps a _document reference to the document it's render…

f03b7b3

…ed in. This reference is used where necessary to ensure functionality when plotting to a window other than the one Plotly was instantiated in.

Merge branch 'master' into child_window_fixes

bc07d60

Make sure graph div _document property is set for drag element tests.

2f25141

Move some common code to a helpers file so they can be used in tests.

b0e9c0c

Use CSS helper functions.

1efd493

Move CSS injection tests to plt_css_test.js.

000104e

Use @src and @build macros.

413b731

Notifier now requires a graph div as the first argument.

d668340

This fixes the issue with notifications not appearing in the correct window when plotting to a child window. The notification is now appended to the body of the document the graph div is a child of.

Cleanup _document and _plotCSSLoaded in plots.purge.

2e8a1ec

Merge branch 'notifier_fixes' into child_window_fixes

f8794bc

Merge branch 'master' into child_window_fixes

5c0fa8d

Merge branch 'child_window_fixes' of github.com:nielsenb-jf/plotly.js…

114c13d

… into child_window_fixes

nielsenb-jf force-pushed the child_window_fixes branch from cc036a5 to 114c13d Compare July 20, 2016 18:28

nielsenb-jf mentioned this pull request Jul 20, 2016

Interactive portions of plot do not render correctly in a child window plotly/plotly.js#702

Closed

nielsenb-jf pushed a commit that referenced this pull request Aug 8, 2016

Merge pull request #2 from psalmody/h-legend-cols

7ef2dff

Horizontal legend in columns

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use correct parent document when necessary: fixes 702 #2

Use correct parent document when necessary: fixes 702 #2

nielsenb-jf commented Jul 20, 2016

Use correct parent document when necessary: fixes 702 #2

Are you sure you want to change the base?

Use correct parent document when necessary: fixes 702 #2

Conversation

nielsenb-jf commented Jul 20, 2016