OSS Boomerang

BOOMR.plugins. PaintTiming

The PaintTiming plugin collects paint metrics exposed by the W3C Paint Timing and Largest Contentful Paint specifications.

For information on how to include this plugin, see the Building tutorial.

Beacon Parameters

All beacon parameters are prefixed with pt..

This plugin adds the following parameters to the beacon:

  • pt.fp: first-paint in DOMHighResTimestamp
  • pt.fcp: first-contentful-paint in DOMHighResTimestamp
  • pt.lcp: largest-contentful-paint in DOMHighResTimestamp
  • pt.hid: The document was loaded hidden (at some point), so FP and FCP are user-driven events, and thus won't be added to the beacon.

See:

Methods

getTimingFor(timingName)

Gets the PaintTiming timestamp for the specified name

Parameters:

Name Type Description
timingName string

PaintTiming name

Returns:

Type: DOMHighResTimestamp

Timestamp

init()

Initializes the plugin.

This plugin does not have any configuration.

Returns:

BOOMR.plugins.PaintTiming The PaintTiming plugin for chaining

is_complete()

Whether or not this plugin is complete

Returns:

Type: boolean

true if the plugin is complete

is_enabled()

Whether or not this plugin is enabled and PaintTiming is supported.

Returns:

Type: boolean

true if PaintTiming plugin is enabled and supported.

is_supported()

Whether or not PaintTiming is supported in this browser.

Returns:

Type: boolean

true if PaintTiming is supported.