Skip to content

Commit c831b73

Browse files
mvladicmvladic
committed
documentation updated
1 parent ac44cd3 commit c831b73

321 files changed

Lines changed: 446 additions & 204 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/components/html/en-US/AddToInstrumentHistory.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</script>
1414
</head>
1515
<body>
16-
<div class="EezStudio_DocumentationBrowser_Content_Help generateHTML"><div class="EezStudio_Component_Documentation"><div class="EezStudio_Component_Documentation_TitleEnclosure"><div class="EezStudio_Component_Documentation_Title" style="background-color: rgb(253, 208, 162); color: rgb(0, 0, 0);"><div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" fill="currentColor"><path d="M99 60H68V29h-8v39h39zM20 60h8v8h-8z"></path><path d="M64 127c34.8 0 63-28.2 63-63S98.8 1 64 1 1 29.2 1 64s28.2 63 63 63zM64 9c30.3 0 55 24.7 55 55s-24.7 55-55 55S9 94.3 9 64 33.7 9 64 9z"></path></svg></div><div>AddToInstrumentHistory</div></div><div class="EezStudio_Component_Documentation_Title_ProjectTypes"><svg viewBox="0 0 560 510" width="36" height="36"><g><path d="M509.09 0A50.91 50.91 0 0 1 560 50.91v305.454a50.91 50.91 0 0 1-50.91 50.909H330.91v50.909h50.908v50.909H178.182v-50.91h50.909v-50.908H50.909C22.655 407.273 0 384.363 0 356.363V50.91A50.733 50.733 0 0 1 50.91 0h458.18" stroke-width="25.4545" fill="#adb5bd" fill-opacity="1"></path><path d="M527.5 368.937h-495v-334h495z" fill="#fefefe" fill-opacity="1" stroke-width="1.23022"></path><path d="M54.633 102.161h70v70h-70zM54.592 192.49h70v70h-70zM54.93 281.458h70v70h-70z" fill="#502d16" fill-opacity="1" stroke-width="24.7486"></path><path d="M32.5 34.937h495v46h-495v-46" fill="#d4aa00" fill-opacity="1" stroke-width="22.4944"></path><circle cx="240.475" cy="182.325" r="68.5" fill="#502d16" fill-opacity="1" stroke="#000" stroke-width="0" stroke-linecap="square" stroke-opacity="1" paint-order="fill markers stroke"></circle><circle cx="414.7" cy="182.325" r="68.5" fill="#502d16" fill-opacity="1" stroke="#000" stroke-width="0" stroke-linecap="square" stroke-opacity="1" paint-order="fill markers stroke"></circle></g></svg></div></div><div class="EezStudio_Component_Documentation_Body"><div class="EezStudio_Component_Documentation_BodySection"><h2>Description</h2><div><div class="markdown"><p>It is used to add a new item to the <em>History</em> view of the instrument. Currently, only adding chart items or widgets (Tabulator, Plotly or LineChart) are supported.</p>
16+
<div class="EezStudio_DocumentationBrowser_Content_Help generateHTML"><div class="EezStudio_Component_Documentation"><div class="EezStudio_Component_Documentation_TitleEnclosure"><div class="EezStudio_Component_Documentation_Title" style="background-color: rgb(253, 208, 162); color: rgb(51, 51, 51);"><div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" fill="currentColor"><path d="M99 60H68V29h-8v39h39zM20 60h8v8h-8z"></path><path d="M64 127c34.8 0 63-28.2 63-63S98.8 1 64 1 1 29.2 1 64s28.2 63 63 63zM64 9c30.3 0 55 24.7 55 55s-24.7 55-55 55S9 94.3 9 64 33.7 9 64 9z"></path></svg></div><div>AddToInstrumentHistory</div></div><div class="EezStudio_Component_Documentation_Title_ProjectTypes"><svg viewBox="0 0 560 510" width="36" height="36"><g><path d="M509.09 0A50.91 50.91 0 0 1 560 50.91v305.454a50.91 50.91 0 0 1-50.91 50.909H330.91v50.909h50.908v50.909H178.182v-50.91h50.909v-50.908H50.909C22.655 407.273 0 384.363 0 356.363V50.91A50.733 50.733 0 0 1 50.91 0h458.18" stroke-width="25.4545" fill="#adb5bd" fill-opacity="1"></path><path d="M527.5 368.937h-495v-334h495z" fill="#fefefe" fill-opacity="1" stroke-width="1.23022"></path><path d="M54.633 102.161h70v70h-70zM54.592 192.49h70v70h-70zM54.93 281.458h70v70h-70z" fill="#502d16" fill-opacity="1" stroke-width="24.7486"></path><path d="M32.5 34.937h495v46h-495v-46" fill="#d4aa00" fill-opacity="1" stroke-width="22.4944"></path><circle cx="240.475" cy="182.325" r="68.5" fill="#502d16" fill-opacity="1" stroke="#000" stroke-width="0" stroke-linecap="square" stroke-opacity="1" paint-order="fill markers stroke"></circle><circle cx="414.7" cy="182.325" r="68.5" fill="#502d16" fill-opacity="1" stroke="#000" stroke-width="0" stroke-linecap="square" stroke-opacity="1" paint-order="fill markers stroke"></circle></g></svg></div></div><div class="EezStudio_Component_Documentation_Body"><div class="EezStudio_Component_Documentation_BodySection"><h2>Description</h2><div><div class="markdown"><p>It is used to add a new item to the <em>History</em> view of the instrument. Currently, only adding chart items or widgets (Tabulator, Plotly or LineChart) are supported.</p>
1717
<p>For example in the <em>Rigol Waveform Data</em> example we have this Action:</p>
1818
<p><img src="images/add_to_instrument_history_action.png" alt="Alt text"></p>
1919
<p>It is used to add a chart which, after successful addition, will be displayed as follows (example of test signal acquisition):</p>

‎docs/components/html/en-US/Animate.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/components/html/en-US/AnimationImage.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<ul>
2020
<li>if "Group index" is 0 then group order is the same as in Widgets Structure</li>
2121
<li>if "Group index" is &gt; 0 then widget is added to the group before any widget with "Group index" 0 and before any widget with the greater "Group index" value. That is, "Group index"=4 is added before "Group index"=5 and "Group index"=0, but after "Group index"=3. If multiple widgets share the same "Group index" value, their order relative to each other follows their position in the Widgets Structure.</li>
22-
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Position and size</h3><dl><dt><h4>Left</h4><span style="font-weight: normal; font-style: italic;">Number</span></dt><dd><div class="markdown"><p>X position of the component in relation to the page or parent widget. It is set in pixels.</p>
22+
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Position and size</h3><dl><dt><h4>Geometry properties</h4><span style="font-weight: normal; font-style: italic;">Any</span></dt><dd><div class="markdown"></div></dd><dt><h4>Left</h4><span style="font-weight: normal; font-style: italic;">Number</span></dt><dd><div class="markdown"><p>X position of the component in relation to the page or parent widget. It is set in pixels.</p>
2323
<p>Hint: when setting the value of this property (as well as the <code>Top</code>, <code>Width</code> and <code>Height</code> properties), simple mathematical expressions can be used. When we enter an expression and press enter, the expression will be evaluated and the result set as the value of this property. It is allowed to use <code>+</code>, <code>-</code>, <code>*</code> and <code>/</code> operators in expressions. Brackets can also be used.</p>
2424
<p>Examples of such mathematical expressions: <code>18 + 36</code>, <code>50 + 32 * 6</code>, <code>(100 - 32) / 2</code>.</p></div></dd><dt><h4>Left unit</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>The following options are available:</p>
2525
<ul>
@@ -71,7 +71,7 @@
7171
<li>START: Align the children to the top side of a scrolled object</li>
7272
<li>END: Align the children to the bottom side of a scrolled object</li>
7373
<li>CENTER: Align the children to the center of a scrolled object</li>
74-
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>States</h3><dl><dt><h4>Checked</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Toggled or checked state.</p></div></dd><dt><h4>Checked state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Checked</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Disabled</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Disabled state</p></div></dd><dt><h4>Disabled state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Disabled</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Focused</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder or clicked via touchpad/mouse.</p></div></dd><dt><h4>Focus key</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder but not via touchpad/mouse</p></div></dd><dt><h4>Pressed</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Being pressed.</p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Events</h3><dl><dt><h4>Event handlers</h4><span style="font-weight: normal; font-style: italic;">Array</span></dt><dd><div class="markdown"><p>List of event handler definitions. During execution, the widget can generate certain events (e.g. the <code>CLICKED</code> event is generated when the touchscreen is pressed and released within the Widget) and through this list we can specify the method of event processing. We must define these properties for each event handler:</p>
74+
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>States</h3><dl><dt><h4>Checked</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Toggled or checked state.</p></div></dd><dt><h4>Checked state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Checked</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Disabled</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Disabled state</p></div></dd><dt><h4>Disabled state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Disabled</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Focused</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder or clicked via touchpad/mouse.</p></div></dd><dt><h4>Focus key</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder but not via touchpad/mouse</p></div></dd><dt><h4>Pressed</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Being pressed.</p></div></dd><dt><h4>Hovered</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Hover over Widget.</p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Events</h3><dl><dt><h4>Event handlers</h4><span style="font-weight: normal; font-style: italic;">Array</span></dt><dd><div class="markdown"><p>List of event handler definitions. During execution, the widget can generate certain events (e.g. the <code>CLICKED</code> event is generated when the touchscreen is pressed and released within the Widget) and through this list we can specify the method of event processing. We must define these properties for each event handler:</p>
7575
<ul>
7676
<li><code>Event</code> – Event that is processed, e.g. <code>CLICKED</code>.</li>
7777
<li><code>Handler type</code> – There are two options: <code>Flow</code> or <code>Action</code>. If <code>Flow</code> is selected, a flow output will be added through which the event is processed, and if <code>Action</code> is selected, then it is necessary to specify which User action will be performed during event processing.</li>

‎docs/components/html/en-US/Arc.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<ul>
2424
<li>if "Group index" is 0 then group order is the same as in Widgets Structure</li>
2525
<li>if "Group index" is &gt; 0 then widget is added to the group before any widget with "Group index" 0 and before any widget with the greater "Group index" value. That is, "Group index"=4 is added before "Group index"=5 and "Group index"=0, but after "Group index"=3. If multiple widgets share the same "Group index" value, their order relative to each other follows their position in the Widgets Structure.</li>
26-
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Position and size</h3><dl><dt><h4>Left</h4><span style="font-weight: normal; font-style: italic;">Number</span></dt><dd><div class="markdown"><p>X position of the component in relation to the page or parent widget. It is set in pixels.</p>
26+
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Position and size</h3><dl><dt><h4>Geometry properties</h4><span style="font-weight: normal; font-style: italic;">Any</span></dt><dd><div class="markdown"></div></dd><dt><h4>Left</h4><span style="font-weight: normal; font-style: italic;">Number</span></dt><dd><div class="markdown"><p>X position of the component in relation to the page or parent widget. It is set in pixels.</p>
2727
<p>Hint: when setting the value of this property (as well as the <code>Top</code>, <code>Width</code> and <code>Height</code> properties), simple mathematical expressions can be used. When we enter an expression and press enter, the expression will be evaluated and the result set as the value of this property. It is allowed to use <code>+</code>, <code>-</code>, <code>*</code> and <code>/</code> operators in expressions. Brackets can also be used.</p>
2828
<p>Examples of such mathematical expressions: <code>18 + 36</code>, <code>50 + 32 * 6</code>, <code>(100 - 32) / 2</code>.</p></div></dd><dt><h4>Left unit</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>The following options are available:</p>
2929
<ul>
@@ -75,7 +75,7 @@
7575
<li>START: Align the children to the top side of a scrolled object</li>
7676
<li>END: Align the children to the bottom side of a scrolled object</li>
7777
<li>CENTER: Align the children to the center of a scrolled object</li>
78-
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>States</h3><dl><dt><h4>Checked</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Toggled or checked state.</p></div></dd><dt><h4>Checked state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Checked</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Disabled</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Disabled state</p></div></dd><dt><h4>Disabled state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Disabled</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Focused</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder or clicked via touchpad/mouse.</p></div></dd><dt><h4>Focus key</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder but not via touchpad/mouse</p></div></dd><dt><h4>Pressed</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Being pressed.</p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Events</h3><dl><dt><h4>Event handlers</h4><span style="font-weight: normal; font-style: italic;">Array</span></dt><dd><div class="markdown"><p>List of event handler definitions. During execution, the widget can generate certain events (e.g. the <code>CLICKED</code> event is generated when the touchscreen is pressed and released within the Widget) and through this list we can specify the method of event processing. We must define these properties for each event handler:</p>
78+
</ul></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>States</h3><dl><dt><h4>Checked</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Toggled or checked state.</p></div></dd><dt><h4>Checked state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Checked</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Disabled</h4><span style="font-weight: normal; font-style: italic;">EXPRESSION (boolean)</span></dt><dd><div class="markdown"><p>Disabled state</p></div></dd><dt><h4>Disabled state type</h4><span style="font-weight: normal; font-style: italic;">Enum</span></dt><dd><div class="markdown"><p>Here we can choose whether the <code>Disabled</code> state will be calculated from the Expression or not.</p></div></dd><dt><h4>Focused</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder or clicked via touchpad/mouse.</p></div></dd><dt><h4>Focus key</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Focused via keypad or encoder but not via touchpad/mouse</p></div></dd><dt><h4>Pressed</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Being pressed.</p></div></dd><dt><h4>Hovered</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>Hover over Widget.</p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Events</h3><dl><dt><h4>Event handlers</h4><span style="font-weight: normal; font-style: italic;">Array</span></dt><dd><div class="markdown"><p>List of event handler definitions. During execution, the widget can generate certain events (e.g. the <code>CLICKED</code> event is generated when the touchscreen is pressed and released within the Widget) and through this list we can specify the method of event processing. We must define these properties for each event handler:</p>
7979
<ul>
8080
<li><code>Event</code> – Event that is processed, e.g. <code>CLICKED</code>.</li>
8181
<li><code>Handler type</code> – There are two options: <code>Flow</code> or <code>Action</code>. If <code>Flow</code> is selected, a flow output will be added through which the event is processed, and if <code>Action</code> is selected, then it is necessary to specify which User action will be performed during event processing.</li>

0 commit comments

Comments
 (0)