Improve performance when transmission lines are not drawn #1153
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
This skips the creation of `transmissionData` and `transmissionIndices` when we are not displaying transmission lines, and the corresponding DOM elements are never created.
jameshadfield
changed the title
eharkins
approved these changes
Jun 3, 2020
| @@ -37,6 +37,7 @@ For instance, if you set `display_defaults.color_by` to `country`, but load the | |||
| | `layout` | Tree layout | "rect", "radial", "clock" or "unrooted | | |||
| | `branch_label` | Which set of branch labels are to be displayed | "aa", "lineage" | | |||
| | `panels` | List of panels which (if available) are to be displayed | ["tree", "map"] | | |||
| | `transmission_lines`| Should transmission lines (if available) be rendered on the map? | Boolean | | |||
There was a problem hiding this comment.
Might be good (later on) to link to a doc (e.g. this one - although that doc itself looks like a stub/TODO and not included in the auspice docs sidebar) so that folks can find out more about what transmission lines are when reading this doc.
There was a problem hiding this comment.
👍 Those tutorials (how-to's, really) are desperately needed, but as you note that one's a stub which isn't actually part of the docs.
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.
#1147 implemented a toggle for transmission lines. This works by setting the stroke-width for the lines to 0, so they are still calculated and placed in the DOM. There is significant overhead to both the calculation and the DOM manipulation for these lines, especially noticeable during animation.
This PR skips the creation of
transmissionDataandtransmissionIndiceswhen we are not displaying transmission lines, and the corresponding DOM elements are never created.Performance testing (locally using Firefox dev-tools, displaying only the map panel, using a nCoV dataset with 4.3k tips) shows a ~50% increase in framerate (8.8 -> 12.7fps).
This PR is a single commit (a9ef44b) on top of PR #1152