Commit 59b60317 authored by Leena Miettinen's avatar Leena Miettinen

Doc: update QML Profiler information

The JavaScript events are integrated into the Timeline and Events
views for apps that use the V4 engine and are built with Qt 5.3.
Updated the Events view screenshot and removed the JavaScript
view screenshot.

Change-Id: Id7e74d91343ff049df580d487e729fdb20c57b0e
Reviewed-by: default avatarUlf Hermann <ulf.hermann@digia.com>
parent ef4388d4
doc/images/qtcreator-qml-performance-monitor.png

80.9 KB | W: | H:

doc/images/qtcreator-qml-performance-monitor.png

80.5 KB | W: | H:

doc/images/qtcreator-qml-performance-monitor.png
doc/images/qtcreator-qml-performance-monitor.png
doc/images/qtcreator-qml-performance-monitor.png
doc/images/qtcreator-qml-performance-monitor.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -62,14 +62,13 @@
the QML Profiler immediately begins to collect data. This is indicated by
the time running in the \gui Elapsed field.
Data is collected until you select the
\inlineimage qtcreator-debug-button-stop.png
(\gui Stop) button. Data collection
Data is collected until you select the \gui {Enable Profiling} button. Data
collection
takes time, and therefore, there might be a delay
before the data is displayed.
Do not use application commands to exit the application, because data is
sent to the QML Profiler when you select the \gui Stop button.
sent to the QML Profiler when you select the \gui {Enable Profiling} button.
The application continues to run for some seconds, after which it is stopped
automatically. If you exit the application, the data is not sent.
......@@ -114,6 +113,8 @@
\li Signal handling
\li Executing JavaScript behind bindings and signal handlers
\li Summary of the recorded period
\endlist
......@@ -171,14 +172,36 @@
Click the binding to move the cursor in the code editor to the part of the
code where the binding is called.
\section2 Evaluating JavaScript Events
On the \gui JavaScript row, you can see the time spent executing the actual
JavaScript behind bindings and signal handlers. It lists all the JavaScript
functions you may be using to evaluate bindings or handle signals.
This information is displayed for applications that use the V4 engine and
are built with Qt 5.3, or later.
For applications that use the V8 engine and are built with Qt 5.0 or 5.1,
you can view information about JavaScript events in the \gui JavaScript
view.
\section1 Viewing Events
The \gui Events view displays the number of times each binding is called
and the time the calls take. This allows you to examine which events you
need to optimize. A high number of calls might indicate that a binding is
called unnecessarily. Click on a binding to move to it in the source code
The \gui Events view displays the number of times each binding, create,
compile, JavaScript, or signal event is triggered and the average time it
takes. This allows you to examine which events you need to optimize. A high
number of occurrences might indicate that an event is triggered
unnecessarily. To view the median, longest, and shortest time for the
occurrences, select \gui {Extended Event Statistics} in the context menu.
Click on an event to move to it in the source code
in the code editor.
JavaScript events often duplicate bindings or signals, so you can show and
hide them by selecting \gui {Show JavaScript Events} in the context menu.
To show and hide QML events (\gui Create, \gui Compile, and \gui Signal),
select \gui {Show QML Events}.
\image qtcreator-analyzer-bindings.png "Events view"
The \gui Callers and \gui Callees panes show dependencies between events.
......@@ -188,7 +211,7 @@
The \gui Callees pane summarizes the QML events that a binding triggers.
This tells you which QML events are affected if you change a binding.
Click on a binding to move to it in the source code in the code editor.
Click on an event to move to it in the source code in the code editor.
When you select an event in the \gui Timeline view, information about it is
displayed in the \gui Events view. To view an event range in the \gui Events
......@@ -198,11 +221,6 @@
To copy the contents of one view or row to the clipboard, select
\gui {Copy Table} or \gui {Copy Row} in the context menu.
You can view similar information about JavaScript events in the
\gui JavaScript view.
\image qml-profiler-javascript.png "JavaScript view"
\section2 Viewing More Data
The QML JavaScript engine optimizes trivial bindings. The QML Profiler
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment