Skip to content

Commit 5a27c00

Browse files
committed
update trace.uirevision description with what it does/doesn't control
1 parent 090231b commit 5a27c00

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/plots/attributes.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -170,11 +170,16 @@ module.exports = {
170170
role: 'info',
171171
editType: 'none',
172172
description: [
173-
'Controls persistence of user-driven changes to the trace:',
174-
'interactions like `selectedpoints` and type-specific ones such as',
173+
'Controls persistence of some user-driven changes to the trace:',
175174
'`constraintrange` in `parcoords` traces, as well as some',
176175
'`editable: true` modifications such as `name` and `colorbar.title`.',
177176
'Defaults to `layout.uirevision`.',
177+
'Note that other user-driven trace attribute changes are controlled',
178+
'by `layout` attributes:',
179+
'`trace.visible` is controlled by `layout.legend.uirevision`,',
180+
'`selectedpoints` is controlled by `layout.selectionrevision`,',
181+
'and `colorbar.(x|y)` (accessible with `config: {editable: true}`)',
182+
'is controlled by `layout.editrevision`.',
178183
'Trace changes are tracked by `uid`, which only falls back on trace',
179184
'index if no `uid` is provided. So if your app can add/remove traces',
180185
'before the end of the `data` array, such that the same trace has a',

0 commit comments

Comments
 (0)