Add grouping property to traces#1028

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

Closed
rreusser wants to merge 3 commits into from
Closed

Add grouping property to traces #1028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b092367
Add grouping property to scatter traces
rreusser Oct 11, 2016
56432c1
Fix lint error
rreusser Oct 11, 2016
b5f6833
Start reorganizing grouping -> groups
rreusser Oct 18, 2016
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
8 changes: 8 additions & 0 deletions src/plots/attributes.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
'(provided that the legend itself is visible).'
].join(' ')
},
groups: {
valType: 'data_array',
description: [
'An array of strings corresponding to each respective datum. These strings are not' +
'inherently used by plotly for any purpose but may be used, for example, with transforms' +
'in order to filter or group points by an auxilliary property.'

@etpinardetpinardOct 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lovely description. Thanks!

].join(' ')
},
showlegend: {
valType: 'boolean',
role: 'info',
Expand Down
1 change: 1 addition & 0 deletions src/plots/plots.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
coerce('type');
coerce('uid');
coerce('name', 'trace ' + traceIndex);
coerce('groups');

// coerce subplot attributes of all registered subplot types
var subplotTypes = Object.keys(subplotsRegistry);
Expand Down
6 changes: 5 additions & 1 deletion src/traces/scatter/attributes.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
},
ids: {
valType: 'data_array',
description: 'A list of keys for object constancy of data points during animation'
description: [

@rreusserrreusserOct 18, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?

@rreusserrreusserOct 18, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.

@etpinardetpinardOct 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings

Not at the moment. Casting within data_array fields is done during the calc step at the moment.

As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.

Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.

I have no preference. Your call.

@rreusserrreusserOct 18, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.

@rreusserrreusserOct 18, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.

@etpinardetpinardOct 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…

very good point.

'A list of unique string ids for object constancy of data points during animation.' +
'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
].join(' ')
},
text: {
valType: 'string',
Expand Down
4 changes: 3 additions & 1 deletion src/traces/scatter/calc.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
{x: x[i], y: y[i]} : {x: false, y: false};

if(trace.ids) {
cd[i].id = String(trace.ids[i]);
if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
cd[i].id = String(trace.ids[i]);
}
}
}

Expand Down
8 changes: 6 additions & 2 deletions src/transforms/filter.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
// -> use setConvert method
if(ax) return ax.d2c;

// special case for 'ids'
// special case for 'ids' or 'groups'
// -> cast to String
if(filtersrc === 'ids') return function(v) { return String(v); };
if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
return function(v) {
return v === undefined ? undefined : String(v);
};
}

// otherwise
// -> cast to Number
Expand Down
11 changes: 11 additions & 0 deletions test/jasmine/tests/calcdata_test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
});
});

describe('ids', function() {
it('should assign ids to points and cast them to strings in the process', function() {
Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
});
});

describe('category ordering', function() {

describe('default category ordering reified', function() {
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add grouping property to traces#1028

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

 Closed

rreusser
wants to merge
3
commits into

from

 Closed


Add grouping property to traces
#1028
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b092367

Add grouping property to scatter traces


rreusser Oct 11, 2016
56432c1

Fix lint error


rreusser Oct 11, 2016
b5f6833

Start reorganizing grouping -> groups


rreusser Oct 18, 2016

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


8 changes: 8 additions & 0 deletions
src/plots/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,14 @@ module.exports = {
 '(provided that the legend itself is visible).'
 ].join(' ')
 },
 groups: {
 valType: 'data_array',
 description: [
 'An array of strings corresponding to each respective datum. These strings are not' +
 'inherently used by plotly for any purpose but may be used, for example, with transforms' +
 'in order to filter or group points by an auxilliary property.'
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Lovely description. Thanks!
 ].join(' ')
 },
 showlegend: {
 valType: 'boolean',
 role: 'info',
Expand Down

1 change: 1 addition & 0 deletions
src/plots/plots.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -742,6 +742,7 @@ plots.supplyTraceDefaults = function(traceIn, traceIndex, layout) {
 coerce('type');
 coerce('uid');
 coerce('name', 'trace ' + traceIndex);
 coerce('groups');

 // coerce subplot attributes of all registered subplot types
 var subplotTypes = Object.keys(subplotsRegistry);
Expand Down

6 changes: 5 additions & 1 deletion
src/traces/scatter/attributes.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,11 @@ module.exports = {
 },
 ids: {
 valType: 'data_array',
 description: 'A list of keys for object constancy of data points during animation'
 description: [
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

@etpinard is there a way to automatically cast these to strings, or do I have to manually loop through the array, if provided, and cast them?
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Oops. Meant to ask for groups, but same question applies to both.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

is there a way to automatically cast these to strings
Not at the moment. Casting within data_array fields is done during the calc step at the moment.
As groups will only be used in filter transforms at first, we could simplify cast groups items in the filter calcTransform handler.
Alternatively, we could add a block to Plots.doCalcdata, casting groups items once and for all. In order to behave correctly during restyle and extendTraces, this would (unfortunately) require adding groups to the recalc-attribute list here.
I have no preference. Your call.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified… It could be country and you could filter by inclusion in a list, or it could be a value and you could filter numerically.
@rreusserrreusserOct 18, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

As opposed to ids, which must be strings.
@etpinardetpinardOct 18, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Actually, I think it's best to leave unspecified…
very good point.
 'A list of unique string ids for object constancy of data points during animation.' +
 'For efficiency, the uniqueness of ids is not validated, but unexpected results may' +
 'occur if ids are not unique. *ids* is equivalent to a *key* in d3.'
 ].join(' ')
 },
 text: {
 valType: 'string',
Expand Down

4 changes: 3 additions & 1 deletion
src/traces/scatter/calc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,7 +117,9 @@ module.exports = function calc(gd, trace) {
 {x: x[i], y: y[i]} : {x: false, y: false};

 if(trace.ids) {
 cd[i].id = String(trace.ids[i]);
 if(trace.ids[i] !== undefined && trace.ids[i] !== null) {
 cd[i].id = String(trace.ids[i]);
 }
 }
 }

Expand Down

8 changes: 6 additions & 2 deletions
src/transforms/filter.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -164,9 +164,13 @@ function getDataToCoordFunc(gd, trace, filtersrc) {
 // -> use setConvert method
 if(ax) return ax.d2c;

 // special case for 'ids'
 // special case for 'ids' or 'groups'
 // -> cast to String
 if(filtersrc === 'ids') return function(v) { return String(v); };
 if(['ids', 'groups'].indexOf(filtersrc) !== -1) {
 return function(v) {
 return v === undefined ? undefined : String(v);
 };
 }

 // otherwise
 // -> cast to Number
Expand Down

11 changes: 11 additions & 0 deletions
test/jasmine/tests/calcdata_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,17 @@ describe('calculated data and points', function() {
 });
 });

 describe('ids', function() {
 it('should assign ids to points and cast them to strings in the process', function() {
 Plotly.plot(gd, [{ x: [1, 2, 3, 5], y: [1, null, 3, 5], ids: [1, 'a', 'b', undefined]}], {});

 expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({ x: 1, y: 1, id: '1'}));
 expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({ x: false, y: false, id: 'a'}));
 expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({ x: 3, y: 3, id: 'b'}));
 expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({ x: 5, y: 5}));
 });
 });

 describe('category ordering', function() {

 describe('default category ordering reified', function() {
Expand Down