This repository has been archived by the owner on Jul 29, 2019. It is now read-only.
Documented isActive() #3704
Merged
Documented isActive() #3704
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
Documented the help method to provide support for the edge case of detecting the currently active Timeline from a collection of Timelines.
mojoaxel
pushed a commit
to visjs/vis_original
that referenced
this pull request
Jun 9, 2019
Documented the help method to provide support for the edge case of detecting the currently active Timeline from a collection of Timelines.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Why?
I hit an edge case using Timelines in which a page contained a collection of them all using the clickToUse feature. This meant that only one Timeline was going to be active at a given time. I wanted to perform a specific operation using the currently active Timeline. After poking around I found isActive().
I realise this is likely meant to be a helper method, but given its usefulness in my case I felt I should just document it instead.