This repository was archived by the owner on Jul 29, 2019. It is now read-only.
Timeline override items #2284
Merged
Timeline override items #2284
Conversation
This file contains hidden or 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
yotamberk
approved these changes
Nov 8, 2016
mojoaxel
approved these changes
Nov 8, 2016
docs/timeline/index.html
Outdated
| <td class="ident">editable.overrideItems</td> | ||
| <td>boolean</td> | ||
| <td><code>false</code></td> | ||
| <td>If true, item specific editable properties are overridden</td> |
There was a problem hiding this comment.
Maybe more precise: "If true, item specific editable properties are overridden by timeline settings" or something similar!?
docs/timeline/index.html
Outdated
| <td>If true, items can be dragged to another moment in time. See section <a href="#Editing_Items">Editing Items</a> for a detailed explanation.</td> | ||
| </tr> | ||
| <tr parent="editable" class="hidden"> | ||
| <td class="ident">editable.overrideItems</td> |
| updateGroup: true, // drag items from one group to another | ||
| remove: true // delete an item by tapping the delete button top right | ||
| } | ||
| };</pre> |
There was a problem hiding this comment.
Here in this code example the new option overrideItems is missing. Should be added.
There was a problem hiding this comment.
Another good catch.
docs/timeline/index.html
Outdated
|
|
||
| <p> | ||
| Editing can be enabled/disabled for specific items. Setting the property <code>editable</code> to <code>true</code> or <code>false</code> on a data item will override the timeline option. | ||
| Editing can be enabled/disabled for specific items. Setting the property <code>editable</code> to <code>true</code> or <code>false</code> on a data item will override the timeline option depending on the value of <code>timeline.editable.overrideItems</code>. |
There was a problem hiding this comment.
...will override the timeline option depending on the value of
timeline.editable.overrideItems.
I would propose:
...will override the timeline option except timeline.editable.overrideItems is set to true.
| <p>Specify individual items to be editable or readonly. Toggle edit options and override behavior from timeline.editable</p> | ||
|
|
||
| <div id="visualization"></div> | ||
| <form> |
There was a problem hiding this comment.
maybe wrap the form in a <p> to get some space between the form and the timeline!?
| {id: 6, content: 'Read-only', editable: false, start: '2010-08-29', group: 2}, | ||
| {id: 7, content: 'Editable', editable: true, start: '2010-08-31', end: '2010-09-03', group: 1}, | ||
| {id: 8, content: 'Read-only', editable: false, start: '2010-09-04T12:00:00', group: 2}, | ||
| {id: 9, content: 'Null', start: '2010-09-04', group: 1}, |
There was a problem hiding this comment.
For me, Null looks too much like undefined. What about something generic like foo and bar or default
|
|
||
| if ('editable' in options) { | ||
| if (typeof options.editable === 'boolean') { | ||
| this.options.editable.updateTime = options.editable; |
There was a problem hiding this comment.
😠 That's why I don't like these code-indent-formatting-thinks. (I hope we get rid of them in the future).
@simo9000 No problem here, just a comment...
|
Thanks for the feedback. I updated the branch as you suggested. |
|
@simo9000 Thanks again! Feel free to contribute more! We always need good developers that help keeping this project alive. |
simo9000
added a commit
to simo9000/vis
that referenced
this pull request
Nov 12, 2016
* Fixed bug introduced in visjs#2284 where overrideItems is set to true when boolean is provided * Added the option of supplying object to item.editable with updateTime, updateGroup, and remove functioning similarly to timeline.editable but only on a single item * Updated Documentation to reflect the new feature * Updated the individualEditableItems example page to show feature usage.
simo9000
added a commit
to simo9000/vis
that referenced
this pull request
Nov 13, 2016
* Fixed bug introduced in visjs#2284 where overrideItems is set to true when boolean is provided * Added the option of supplying object to item.editable with updateTime, updateGroup, and remove functioning similarly to timeline.editable but only on a single item * Updated Documentation to reflect the new feature * Updated the individualEditableItems example page to show feature usage.
simo9000
added a commit
to simo9000/vis
that referenced
this pull request
Nov 17, 2016
* Fixed bug introduced in visjs#2284 where overrideItems is set to true when boolean is provided * Added the option of supplying object to item.editable with updateTime, updateGroup, and remove functioning similarly to timeline.editable but only on a single item * Updated Documentation to reflect the new feature * Updated the individualEditableItems example page to show feature usage.
mojoaxel
pushed a commit
that referenced
this pull request
Nov 20, 2016
* Fixed bug introduced in #2284 where overrideItems is set to true when boolean is provided * Added the option of supplying object to item.editable with updateTime, updateGroup, and remove functioning similarly to timeline.editable but only on a single item * Updated Documentation to reflect the new feature * Updated the individualEditableItems example page to show feature usage.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
This is a continuation of #2256. I have implemented a sub-option to
timeline.editablecalledoverrrideItemswhich provides a means to switch between two precedence conventions, 1.item.editableand 2.timeline.editable.item.editable; (current behavior*) - this convention allows theitem.editableoption to override the values oftimeline.editable.timeline.editable- this convention allows the timeline options to override the item options when 'overrideItems' is set to true. This is useful when switching an entire timeline between "editing" and "read-only" modes while still enforcing individualitem.editableoptions during "editing" mode.To preserve backward capability
timeline.editable.overrideItemsdefaults to false which enables convention 1. This PR includes documentation updates and a new example page wheretimeline.editableoptions can be toggled to easily test different configurations. A test matrix was created and used to confirm the behavior. Bugs fixed in 8ae5d2a and d2899c1 were found as a result of this exhaustive testing.*currently the setting
item.editable = trueoverridestimeline.editable.removeandtimeline.editable.updateTimebut does not overridetimeline.editable.updateGroupwhich is inconsistent with the documentation. The bugs found in matrix testing were split into two commits to separate fixes that do not impact this behavior (8ae5d2a) and an update to makeitem.editable = trueoverride all behaviors (d2899c1). This makes it easy to revert d2899c1 if needed as this commit has the potential to impact backward compatibility.