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

prune global-level trace attributes that are already defined in a trace #3158

Merged
merged 11 commits into from
Oct 30, 2018
Merged

prune global-level trace attributes that are already defined in a trace #3158

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fbfe638
prune global-level trace attributes that are already defined in a trace
antoinerg Oct 25, 2018
f168ddc
fix lint
antoinerg Oct 25, 2018
7999517
properly delete nested attributes, update doc `crawl`
antoinerg Oct 25, 2018
7f60f6e
test pruning of global-level trace attributes on sankey
antoinerg Oct 26, 2018
930e4c8
do not coerce hoverlabel if it's undefined at trace level
antoinerg Oct 29, 2018
b7679a6
make sure the hoverlabel key exists but has an undefined value
antoinerg Oct 29, 2018
d501bb0
prune 'customdata' and 'ids' if undefined at trace-level attribute
antoinerg Oct 29, 2018
cd0230e
fix lint
antoinerg Oct 29, 2018
da03ceb
test that hoverlabel doesn't get coerced for parcoords
antoinerg Oct 30, 2018
397870b
prune 'transforms' attribute from traces that don't support it
antoinerg Oct 30, 2018
55881c6
do not prune `customdata` and `ids`
antoinerg Oct 30, 2018
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
15 changes: 13 additions & 2 deletions src/plot_api/plot_schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,11 +460,22 @@ function getTraceAttributes(type) {
// make 'type' the first attribute in the object
attributes.type = null;


var copyBaseAttributes = extendDeepAll({}, baseAttributes),
copyModuleAttributes = extendDeepAll({}, _module.attributes);
Copy link
Contributor

Choose a reason for hiding this comment

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

var a = {},
    b = [];

have gone out of style in our codebase. It might be worth adding an eslint rule for this. From

https://eslint.org/docs/rules/one-var#initialized-and-uninitialized

looks like "one-var": { "initialized": "never", "uninitialized": "consecutive" } is exactly what most of the codebase does already.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed this in f168ddc and opened an issue (#3162) so I don't forget about adding an eslint rule for this.


// prune global-level trace attributes that are already defined in a trace
exports.crawl(copyModuleAttributes, function(attr, attrName, attrs, level, fullAttrString) {
delete copyBaseAttributes[fullAttrString];
Copy link
Contributor

@etpinard etpinard Oct 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

fullAttrString might look like 'marker.line.width' in general, so we'll need to use Lib.nestedProperty here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @etpinard! Commit 7999517 fixes this :)

// Prune undefined attributes
if(attr === undefined) delete copyModuleAttributes[fullAttrString];
Copy link
Contributor

@etpinard etpinard Oct 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Nice touch here, that way we won't have to rely on JSON.stringify to remove keys with undefined values.

});

// base attributes (same for all trace types)
extendDeepAll(attributes, baseAttributes);
extendDeepAll(attributes, copyBaseAttributes);

// module attributes
extendDeepAll(attributes, _module.attributes);
extendDeepAll(attributes, copyModuleAttributes);

// subplot attributes
if(basePlotModule.attributes) {
Expand Down