Skip to content

Commit 7ab8630

Browse files
committed
comment on uirevision<->uid in trace.uirevision attribute description
1 parent c95ae07 commit 7ab8630

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/plots/attributes.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,12 @@ module.exports = {
174174
'interactions like `selectedpoints` and type-specific ones such as',
175175
'`constraintrange` in `parcoords` traces, as well as some',
176176
'`editable: true` modifications such as `name` and `colorbar.title`.',
177-
'Defaults to `layout.uirevision`.'
177+
'Defaults to `layout.uirevision`.',
178+
'Trace changes are tracked by `uid`, which only falls back on trace',
179+
'index if no `uid` is provided. So if your app can add/remove traces',
180+
'before the end of the `data` array, such that the same trace has a',
181+
'different index, you can still preserve user-driven changes if you',
182+
'give each trace a `uid` that stays with it as it moves.'
178183
].join(' ')
179184
}
180185
};

0 commit comments

Comments
 (0)