fix(timeline.setoptions): make editability hierachy & settings behave correctly #700
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'm afraid I don' agree with this Pr. This will break the behavior intended as explained in the comments of the issue #662 (comment). If you still think this should be addressed, let's continue the thread in the issue itself. EDIT: I will look in to this PR more in depth |
|
Hi @yotamberk , this PR has matured significantly & I believe addresses the root cause of the behaviour complained of in #662 . It's ready for review |
strazto
force-pushed
the
editable_retroactive
branch
from
a0db322 to
693d164
Compare
strazto
changed the title
strazto
changed the title
strazto
commented
Oct 14, 2020
Comment on lines
-549
to
-551
| // TODO: in timeline.js 5.0, we should change this to not reset options from the timeline configuration. | ||
| // Basically just remove the next line... | ||
| this.editable = {}; |
There was a problem hiding this comment.
This is the only change I'm uncertain about - Though this change is overdue, fixing this bug technically constitutes a breaking change, & possibly should be deferred until a major release?
strazto
commented
Oct 14, 2020
Comment on lines
186
to
193
| pointItem.setParent(parent); | ||
| pointItem.redraw(); | ||
| assert.equal(pointItem.editable.updateTime, true); | ||
| assert.equal(pointItem.editable.updateGroup, undefined); | ||
| assert.equal(pointItem.editable.remove, undefined); | ||
| assert.equal(pointItem.editable.updateGroup, true); | ||
| assert.equal(pointItem.editable.remove, true); | ||
| }); | ||
|
|
||
| it('an editable: {updateTime} override item (with boolean option false)', () => { |
There was a problem hiding this comment.
These test cases were modified to match changes made at https://github.com/visjs/vis-timeline/pull/700/files#r504386157
|
@yotamberk can you please review this again when you get the chance? |
strazto
force-pushed
the
editable_retroactive
branch
2 times, most recently
from
cecb52d to
527a56a
Compare
strazto
force-pushed
the
editable_retroactive
branch
from
527a56a to
0bd846d
Compare
Squash of:
* fix(options.editable): propagate {editable: true} to overrideItems
* fix(options): don't propagate editable=bool to editable.overrideItems
When items are selected, _updateEditStatus() is called. This forces them to refresh their editabiltiy based on a combination of `item.data` and `item.options` (`item.options is ~= to itemset.options`)
strazto
force-pushed
the
editable_retroactive
branch
from
0bd846d to
f047750
Compare
strazto
force-pushed
the
editable_retroactive
branch
from
f047750 to
50db9d1
Compare
…t clear previously set props
…or v5
The behaviour in question is that if an individual item editability
option is set, and different global options are set-
For example:
```
timeline.ItemSet.items[0].data.editable.remove = true
timeline.setOptions({editable: {updateTime: true}})
//updateTime setting is ignored here, time isn't updatable.
```
The previous behaviour meant that if any item.data.editable properties
were set, then any editable properties given by
timeline.options.editable,
but not set explicitly by item.data.editable would be unset.
strazto
force-pushed
the
editable_retroactive
branch
2 times, most recently
from
4ad1c49 to
2fe516a
Compare
|
I will review it in the next few days |
|
Thank you very much |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #662
the following fiddle demonstrates the previous behaviour
Previously, when calling
timeline.setOptions({editable: true}), per-item overriding would implicitly be disabled, meaning thattimeline.setOptions({editable: true})appeared to do nothing.We saw apparently inconsistent behaviour between the following:
The commit that introduced this behaviour: b2560d0
I discuss this in further detail at #662 (comment)
I'm open to comment by maintainers - if you don't believe this is a bug that needs fixing, then I understand, but I believe that this behaviour is more intuitive.