Skip to content

Commit 14a8bcf

Browse files
committed
SF: Add documentation for table operation to rst and ifn
1 parent 3abdde2 commit 14a8bcf

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

Packages/MIES/SweepFormulaHelp.ifn

3.03 KB
Binary file not shown.

Packages/doc/SweepFormula.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2025,6 +2025,46 @@ Useful for testing SweepFormula itself mainly.
20252025
20262026
dataset(1, [2, 3], "abcd") == [1], [2, 3], ["abcd]
20272027
2028+
table
2029+
"""""
2030+
2031+
The `table` operation allows to display data in a table instead of a plot.
2032+
The operation accepts one argument. The effective result of the operation is
2033+
identical to the input argument. The change in display mode is only effective if
2034+
table is applied as outermost operation.
2035+
2036+
If the input is a dataset then each dataset is appended to the table.
2037+
When multiple formulas are specified with the `with` keyword for plotting in the same window
2038+
then the results are also appended to the table.
2039+
2040+
If `table` is applied for the y-wave expression and the `vs` keyword follows with an expression for the x-wave
2041+
then the expression for the x-wave is evaluated by SweepFormula but **not displayed** in the table.
2042+
2043+
The table(s) are displayed in a separate window.
2044+
2045+
If the input has dimension labels then these are also shown in the table.
2046+
2047+
When a table is active then through the context menu the formula of the results shown can be
2048+
copied to the clipboard. Multiple formulas are seperated by the `with` keyword.
2049+
2050+
.. code-block:: bash
2051+
2052+
table(data(select()))
2053+
2054+
Shows the last sweep data in a table
2055+
2056+
.. code-block:: bash
2057+
2058+
table(1)
2059+
with
2060+
table(2)
2061+
with
2062+
3
2063+
and
2064+
table(4)
2065+
2066+
Shows 1 and 2 in the first table, 4 in the second table and 3 in the plot window.
2067+
20282068
Plotting
20292069
^^^^^^^^
20302070

0 commit comments

Comments
 (0)