Namespace for the jQuery performance measurement plug-in provided by SAP SE.
Node | Description |
---|
Method | Description |
---|---|
jQuery.sap.measure.add |
Adds a performance measurement with all data This is useful to add external measurements (e.g. from a backend) to the common measurement UI
since: 1.58 use {@link module:sap/ui/performance/Measurement.add} instead
|
jQuery.sap.measure.average |
Starts an average performance measure. The duration of this measure is an avarage of durations measured for each call. Optionally a category or list of categories can be passed to allow filtering of measurements.
since: 1.58 use {@link module:sap/ui/performance/Measurement.average} instead
|
jQuery.sap.measure.clear |
Clears all performance measurements
since: 1.58 use {@link module:sap/ui/performance/Measurement.clear} instead
|
jQuery.sap.measure.clearInteractionMeasurements |
Clears all interaction measurements
since: 1.58 use {@link module:sap/ui/performance/trace/Interaction.clear} instead
|
jQuery.sap.measure.clearRequestTimings |
Clears all request timings safely.
since: 1.58 use native function <code>performance.clearResourceTimings()</code> where available
|
jQuery.sap.measure.end |
Ends a performance measure
since: 1.58 use {@link module:sap/ui/performance/Measurement.end} instead
|
jQuery.sap.measure.endInteraction |
End an interaction measurements
since: 1.58 use {@link module:sap/ui/performance/trace/Interaction.end} instead
|
jQuery.sap.measure.filterInteractionMeasurements |
Gets all interaction measurements for which a provided filter function returns a truthy value. To filter for certain categories of measurements a fnFilter can be implemented like this
since: 1.58 use {@link module:sap/ui/performance/trace/Interaction.filter} instead
|
jQuery.sap.measure.filterMeasurements |
Gets all performance measurements where a provided filter function returns a truthy value. If neither a filter function nor a category is provided an empty array is returned. To filter for certain properties of measurements a fnFilter can be implemented like this
since: 1.58 use {@link module:sap/ui/performance/Measurement.filterMeasurements} instead
|
jQuery.sap.measure.getActive |
Gets the current state of the performance measurement functionality
since: 1.58 use {@link module:sap/ui/performance/Measurement.getActive} instead
|
jQuery.sap.measure.getAllInteractionMeasurements |
Gets all interaction measurements
since: 1.58 use {@link module:sap/ui/performance/trace/Interaction.getAll} instead
|
jQuery.sap.measure.getAllMeasurements |
Gets all performance measurements
since: 1.58 use {@link module:sap/ui/performance/Measurement.getAllMeasurements} instead
|
jQuery.sap.measure.getMeasurement |
Gets a performance measure
since: 1.58 use {@link module:sap/ui/performance/Measurement.getMeasurement} instead
|
jQuery.sap.measure.getRequestTimings |
Gets the current request timings array for type 'resource' safely
since: 1.58 use native function <code>performance.getEntriesByType("resource")</code> instead
|
jQuery.sap.measure.pause |
Pauses a performance measure
since: 1.58 use {@link module:sap/ui/performance/Measurement.pause} instead
|
jQuery.sap.measure.registerMethod |
Registers an average measurement for a given objects method
since: 1.58 use {@link module:sap/ui/performance/Measurement.registerMethod} instead
|
jQuery.sap.measure.remove |
Removes a performance measure
since: 1.58 use {@link module:sap/ui/performance/Measurement.remove} instead
|
jQuery.sap.measure.resume |
Resumes a performance measure
since: 1.58 use {@link module:sap/ui/performance/Measurement.resume} instead
|
setActive |
Activates or deactivates the performance measure functionality Optionally a category or list of categories can be passed to restrict measurements to certain categories like "javascript", "require", "xmlhttprequest", "render"
since: 1.58 use {@link module:sap/ui/performance/Measurement.setActive} instead
|
jQuery.sap.measure.setRequestBufferSize |
Sets the request buffer size for the measurement safely.
since: 1.58 use native function <code>performance.setResourceTimingBufferSize(iSize)</code> where available
|
jQuery.sap.measure.start |
Starts a performance measure. Optionally a category or list of categories can be passed to allow filtering of measurements.
since: 1.58 use {@link module:sap/ui/performance/Measurement.start} instead
|
jQuery.sap.measure.startInteraction |
Start an interaction measurements
since: 1.58 use {@link module:sap/ui/performance/trace/Interaction.start} instead
|
jQuery.sap.measure.unregisterAllMethods |
Unregisters all average measurements
since: 1.58 use {@link module:sap/ui/performance/Measurement.unregisterAllMethods} instead
|
jQuery.sap.measure.unregisterMethod |
Unregisters an average measurement for a given objects method
since: 1.58 use {@link module:sap/ui/performance/Measurement.unregisterMethod} instead
|
Adds a performance measurement with all data This is useful to add external measurements (e.g. from a backend) to the common measurement UI
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
|
sInfo | string |
Info for the measurement |
|
iStart | int |
start timestamp |
|
iEnd | int |
end timestamp |
|
iTime | int |
time in milliseconds |
|
iDuration | int |
effective time in milliseconds |
|
aCategories | string string[] | "javascript" |
An optional list of categories for the measure |
Starts an average performance measure. The duration of this measure is an avarage of durations measured for each call. Optionally a category or list of categories can be passed to allow filtering of measurements.
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
|
sInfo | string |
Info for the measurement |
|
aCategories | string string[] | "javascript" |
An optional list of categories for the measure |
Clears all performance measurements
Param | Type | DefaultValue | Description |
---|
Clears all interaction measurements
Param | Type | DefaultValue | Description |
---|
Clears all request timings safely.
Param | Type | DefaultValue | Description |
---|
Ends a performance measure
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
End an interaction measurements
Param | Type | DefaultValue | Description |
---|---|---|---|
bForce | boolean |
forces end of interaction now and ignores further re-renderings |
Gets all interaction measurements for which a provided filter function returns a truthy value. To filter for certain categories of measurements a fnFilter can be implemented like this function(InteractionMeasurement) { return InteractionMeasurement.duration > 0 }
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFilter | function |
a filter function that returns true if the passed measurement should be added to the result |
Gets all performance measurements where a provided filter function returns a truthy value. If neither a filter function nor a category is provided an empty array is returned. To filter for certain properties of measurements a fnFilter can be implemented like this function(oMeasurement) { return oMeasurement.duration > 50; }
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFilter | function |
a filter function that returns true if the passed measurement should be added to the result |
|
bCompleted | boolean undefined |
Optional parameter to determine if either completed or incomplete measurements should be returned (both if not set or undefined) |
|
aCategories | string[] |
The function returns only measurements which match these specified categories |
Gets the current state of the performance measurement functionality
Param | Type | DefaultValue | Description |
---|
Gets all interaction measurements
Param | Type | DefaultValue | Description |
---|---|---|---|
bFinalize | boolean |
finalize the current pending interaction so that it is contained in the returned array |
Gets all performance measurements
Param | Type | DefaultValue | Description |
---|---|---|---|
bCompleted | boolean |
Whether only completed measurements should be returned, if explicitly set to false only incomplete measurements are returned |
Gets a performance measure
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
Gets the current request timings array for type 'resource' safely
Param | Type | DefaultValue | Description |
---|
Pauses a performance measure
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
Registers an average measurement for a given objects method
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
the id of the measurement |
|
oObject | object |
the object of the method |
|
sMethod | string |
the name of the method |
|
aCategories | string[] | ["javascript"] |
An optional categories list for the measurement |
Removes a performance measure
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
Resumes a performance measure
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
Activates or deactivates the performance measure functionality Optionally a category or list of categories can be passed to restrict measurements to certain categories like "javascript", "require", "xmlhttprequest", "render"
Param | Type | DefaultValue | Description |
---|---|---|---|
bOn | boolean |
state of the performance measurement functionality to set |
|
aCategories | string string[] |
An optional list of categories that should be measured |
Sets the request buffer size for the measurement safely.
Param | Type | DefaultValue | Description |
---|---|---|---|
iSize | int |
size of the buffer |
Starts a performance measure. Optionally a category or list of categories can be passed to allow filtering of measurements.
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
ID of the measurement |
|
sInfo | string |
Info for the measurement |
|
aCategories | string string[] | "javascript" |
An optional list of categories for the measure |
Start an interaction measurements
Param | Type | DefaultValue | Description |
---|---|---|---|
sType | string |
type of the event which triggered the interaction |
|
oSrcElement | object |
the control on which the interaction was triggered |
Unregisters all average measurements
Param | Type | DefaultValue | Description |
---|
Unregisters an average measurement for a given objects method
Param | Type | DefaultValue | Description |
---|---|---|---|
sId | string |
the id of the measurement |
|
oObject | object |
the object of the method |
|
sMethod | string |
the name of the method |