akasha

Class Performance

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.Performance

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Performance")
public class Performance
extends EventTarget

The Performance interface provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API.

See Also:

Performance - MDN, # sec-performance, # extensions-to-the-performance-interface, # sec-extensions-performance-interface, # extensions-performance-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	onresourcetimingbufferfull The onresourcetimingbufferfull property is an event handler that will be called when the resourcetimingbufferfull event is fired.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Performance()

Method Summary

Modifier and Type	Method and Description
void	addResourcetimingbufferfullListener(EventListener callback)
void	addResourcetimingbufferfullListener(EventListener callback, AddEventListenerOptions options)
void	addResourcetimingbufferfullListener(EventListener callback, boolean useCapture)
void	clearMarks() The clearMarks() method removes the named mark from the browser's performance entry buffer.
void	clearMarks(java.lang.String markName) The clearMarks() method removes the named mark from the browser's performance entry buffer.
void	clearMeasures() The clearMeasures() method removes the named measure from the browser's performance entry buffer.
void	clearMeasures(java.lang.String measureName) The clearMeasures() method removes the named measure from the browser's performance entry buffer.
void	clearResourceTimings() The clearResourceTimings() method removes all performance entries with an entryType of "resource" from the browser's performance data buffer and sets the size of the performance data buffer to zero.
@JsNonNull JsArray<PerformanceEntry>	getEntries() The getEntries() method returns a list of all PerformanceEntry objects for the page.
@JsNonNull JsArray<PerformanceEntry>	getEntriesByName(java.lang.String name) The getEntriesByName() method returns a list of PerformanceEntry objects for the given name and type.
@JsNonNull JsArray<PerformanceEntry>	getEntriesByName(java.lang.String name, java.lang.String type) The getEntriesByName() method returns a list of PerformanceEntry objects for the given name and type.
@JsNonNull JsArray<PerformanceEntry>	getEntriesByType(java.lang.String type) The getEntriesByType() method returns a list of PerformanceEntry objects for a given type.
void	mark(java.lang.String markName) The mark() method creates a timestamp in the browser's performance entry buffer with the given name.
void	measure(java.lang.String measureName) The measure() method creates a named timestamp in the browser's performance entry buffer between marks, the navigation start time, or the current time.
void	measure(java.lang.String measureName, java.lang.String startMark) The measure() method creates a named timestamp in the browser's performance entry buffer between marks, the navigation start time, or the current time.
void	measure(java.lang.String measureName, java.lang.String startMark, java.lang.String endMark) The measure() method creates a named timestamp in the browser's performance entry buffer between marks, the navigation start time, or the current time.
PerformanceNavigation	navigation() The legacy Performance.navigation read-only property returns a PerformanceNavigation object representing the type of navigation that occurs in the given browsing context, such as the number of redirections needed to fetch the resource.
double	now() The performance.now() method returns a DOMHighResTimeStamp, measured in milliseconds.
void	removeResourcetimingbufferfullListener(EventListener callback)
void	removeResourcetimingbufferfullListener(EventListener callback, boolean useCapture)
void	removeResourcetimingbufferfullListener(EventListener callback, EventListenerOptions options)
void	setResourceTimingBufferSize(int maxSize) The setResourceTimingBufferSize() method sets the browser's resource timing buffer size to the specified number of "resource" performance entry type objects.
double	timeOrigin() The timeOrigin read-only property of the Performance interface returns the high resolution timestamp of the start time of the performance measurement.
PerformanceTiming	timing() The legacy Performance.timing read-only property returns a PerformanceTiming object containing latency-related performance information.
@JsNonNull JsObject	toJSON() The toJSON() method of the Performance interface is a standard serializer: it returns a JSON representation of the performance object's properties.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onresourcetimingbufferfull

public @JsNullable EventHandler onresourcetimingbufferfull

The onresourcetimingbufferfull property is an event handler that will be called when the resourcetimingbufferfull event is fired. This event is fired when the browser's resource timing performance buffer is full.

See Also:

Performance.onresourcetimingbufferfull - MDN, onresourcetimingbufferfull - Resource Timing Level 1

Constructor Detail

Performance

protected Performance()

Method Detail

navigation

@JsProperty(name="navigation")
 @Nonnull
public PerformanceNavigation navigation()

The legacy Performance.navigation read-only property returns a PerformanceNavigation object representing the type of navigation that occurs in the given browsing context, such as the number of redirections needed to fetch the resource.

See Also:

Performance.navigation - MDN, Performance.navigation - Navigation Timing

timeOrigin

@JsProperty(name="timeOrigin")
public double timeOrigin()

The timeOrigin read-only property of the Performance interface returns the high resolution timestamp of the start time of the performance measurement.

See Also:

Performance.timeOrigin - MDN

timing

@JsProperty(name="timing")
 @Nonnull
public PerformanceTiming timing()

The legacy Performance.timing read-only property returns a PerformanceTiming object containing latency-related performance information.

See Also:

Performance.timing - MDN, Navigation Timing Level 2

now

public double now()

The performance.now() method returns a DOMHighResTimeStamp, measured in milliseconds.

See Also:

Performance.now - MDN, performance.now() - High Resolution Time Level 2, performance.now() - High Resolution Time

toJSON

public @JsNonNull JsObject toJSON()

The toJSON() method of the Performance interface is a standard serializer: it returns a JSON representation of the performance object's properties.

See Also:

Performance.toJSON - MDN, toJSON() serializer - High Resolution Time Level 2

getEntries

public @JsNonNull JsArray<PerformanceEntry> getEntries()

The getEntries() method returns a list of all PerformanceEntry objects for the page. The list's members (entries) can be created by making performance marks or measures (for example by calling the mark() method) at explicit points in time. If you are only interested in performance entries of certain types or that have certain names, see getEntriesByType() and getEntriesByName().

See Also:

Performance.getEntries - MDN, getEntries() - Performance Timeline Level 2, getEntries() - Performance Timeline

getEntriesByName

public @JsNonNull JsArray<PerformanceEntry> getEntriesByName(@Nonnull
                                                             java.lang.String name,
                                                             @Nonnull
                                                             java.lang.String type)

The getEntriesByName() method returns a list of PerformanceEntry objects for the given name and type. The list's members (entries) can be created by making performance marks or measures (for example by calling the mark() method) at explicit points in time.

See Also:

Performance.getEntriesByName - MDN, getEntriesByName() - Performance Timeline Level 2, getEntriesByName() - Performance Timeline

getEntriesByName

public @JsNonNull JsArray<PerformanceEntry> getEntriesByName(@Nonnull
                                                             java.lang.String name)

The getEntriesByName() method returns a list of PerformanceEntry objects for the given name and type. The list's members (entries) can be created by making performance marks or measures (for example by calling the mark() method) at explicit points in time.

See Also:

Performance.getEntriesByName - MDN, getEntriesByName() - Performance Timeline Level 2, getEntriesByName() - Performance Timeline

getEntriesByType

public @JsNonNull JsArray<PerformanceEntry> getEntriesByType(@Nonnull
                                                             java.lang.String type)

The getEntriesByType() method returns a list of PerformanceEntry objects for a given type. The list's members (entries) can be created by making performance marks or measures (for example by calling the mark() method) at explicit points in time.

See Also:

Performance.getEntriesByType - MDN, getEntriesByType() - Performance Timeline Level 2, getEntriesByType() - Performance Timeline

clearResourceTimings

public void clearResourceTimings()

The clearResourceTimings() method removes all performance entries with an entryType of "resource" from the browser's performance data buffer and sets the size of the performance data buffer to zero. To set the size of the browser's performance data buffer, use the Performance.setResourceTimingBufferSize() method.

See Also:

Performance.clearResourceTimings - MDN, clearResourceTimings() - Resource Timing Level 1

setResourceTimingBufferSize

public void setResourceTimingBufferSize(int maxSize)

The setResourceTimingBufferSize() method sets the browser's resource timing buffer size to the specified number of "resource" performance entry type objects.

See Also:

Performance.setResourceTimingBufferSize - MDN, setResourceTimingBufferSize() - Resource Timing Level 1

clearMarks

public void clearMarks(@Nonnull
                       java.lang.String markName)

The clearMarks() method removes the named mark from the browser's performance entry buffer. If the method is called with no arguments, all performance entries with an entry type of "mark" will be removed from the performance entry buffer.

See Also:

Performance.clearMarks - MDN, clearMarks() - User Timing Level 2, clearMarks() - User Timing

clearMarks

public void clearMarks()

The clearMarks() method removes the named mark from the browser's performance entry buffer. If the method is called with no arguments, all performance entries with an entry type of "mark" will be removed from the performance entry buffer.

See Also:

Performance.clearMarks - MDN, clearMarks() - User Timing Level 2, clearMarks() - User Timing

clearMeasures

public void clearMeasures(@Nonnull
                          java.lang.String measureName)

The clearMeasures() method removes the named measure from the browser's performance entry buffer. If the method is called with no arguments, all performance entries with an entry type of "measure" will be removed from the performance entry buffer.

See Also:

Performance.clearMeasures - MDN, clearMeasures() - User Timing Level 2, clearMeasures() - User Timing

clearMeasures

public void clearMeasures()

The clearMeasures() method removes the named measure from the browser's performance entry buffer. If the method is called with no arguments, all performance entries with an entry type of "measure" will be removed from the performance entry buffer.

See Also:

Performance.clearMeasures - MDN, clearMeasures() - User Timing Level 2, clearMeasures() - User Timing

mark

public void mark(@Nonnull
                 java.lang.String markName)

The mark() method creates a timestamp in the browser's performance entry buffer with the given name.

See Also:

Performance.mark - MDN, mark() - User Timing Level 2, mark() - User Timing

measure

public void measure(@Nonnull
                    java.lang.String measureName,
                    @Nonnull
                    java.lang.String startMark,
                    @Nonnull
                    java.lang.String endMark)

The measure() method creates a named timestamp in the browser's performance entry buffer between marks, the navigation start time, or the current time. When measuring between two marks, there is a start mark and end mark, respectively. The named timestamp is referred to as a measure.

See Also:

Performance.measure - MDN, measure() - User Timing Level 2, measure() - User Timing

measure

public void measure(@Nonnull
                    java.lang.String measureName,
                    @Nonnull
                    java.lang.String startMark)

The measure() method creates a named timestamp in the browser's performance entry buffer between marks, the navigation start time, or the current time. When measuring between two marks, there is a start mark and end mark, respectively. The named timestamp is referred to as a measure.

See Also:

Performance.measure - MDN, measure() - User Timing Level 2, measure() - User Timing

measure

public void measure(@Nonnull
                    java.lang.String measureName)

The measure() method creates a named timestamp in the browser's performance entry buffer between marks, the navigation start time, or the current time. When measuring between two marks, there is a start mark and end mark, respectively. The named timestamp is referred to as a measure.

See Also:

Performance.measure - MDN, measure() - User Timing Level 2, measure() - User Timing

addResourcetimingbufferfullListener

@JsOverlay
public final void addResourcetimingbufferfullListener(@Nonnull
                                                                 EventListener callback,
                                                                 @Nonnull
                                                                 AddEventListenerOptions options)

addResourcetimingbufferfullListener

@JsOverlay
public final void addResourcetimingbufferfullListener(@Nonnull
                                                                 EventListener callback,
                                                                 boolean useCapture)

addResourcetimingbufferfullListener

@JsOverlay
public final void addResourcetimingbufferfullListener(@Nonnull
                                                                 EventListener callback)

removeResourcetimingbufferfullListener

@JsOverlay
public final void removeResourcetimingbufferfullListener(@Nonnull
                                                                    EventListener callback,
                                                                    @Nonnull
                                                                    EventListenerOptions options)

removeResourcetimingbufferfullListener

@JsOverlay
public final void removeResourcetimingbufferfullListener(@Nonnull
                                                                    EventListener callback,
                                                                    boolean useCapture)

removeResourcetimingbufferfullListener

@JsOverlay
public final void removeResourcetimingbufferfullListener(@Nonnull
                                                                    EventListener callback)