Skip to content

Commit

Permalink
Merge pull request #4941 from Polymer/4897-kschaaf-docs
Browse files Browse the repository at this point in the history
Clarify docs on target-framerate. Fixes #4897
  • Loading branch information
Steve Orvell authored Nov 21, 2017
2 parents 3a0c396 + 80a7f1e commit 1796c74
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions lib/elements/dom-repeat.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@

/**
* When using a `filter` or `sort` function, the `delay` property
* determines a debounce time after a change to observed item
* determines a debounce time in ms after a change to observed item
* properties that must pass before the filter or sort is re-run.
* This is useful in rate-limiting shuffling of the view when
* item changes may be frequent.
Expand Down Expand Up @@ -250,12 +250,16 @@
},

/**
* When `initialCount` is used, this property defines a frame rate to
* target by throttling the number of instances rendered each frame to
* not exceed the budget for the target frame rate. Setting this to a
* higher number will allow lower latency and higher throughput for
* things like event handlers, but will result in a longer time for the
* remaining items to complete rendering.
* When `initialCount` is used, this property defines a frame rate (in
* fps) to target by throttling the number of instances rendered each
* frame to not exceed the budget for the target frame rate. The
* framerate is effectively the number of `requestAnimationFrame`s that
* it tries to allow to actually fire in a given second. It does this
* by measuring the time between `rAF`s and continuously adjusting the
* number of items created each `rAF` to maintain the target framerate.
* Setting this to a higher number allows lower latency and higher
* throughput for event handlers and other tasks, but results in a
* longer time for the remaining items to complete rendering.
*/
targetFramerate: {
type: Number,
Expand Down

0 comments on commit 1796c74

Please sign in to comment.