Skip to content

Commit b7e25fe

Browse files
committed
SF: Add documentation for table operation to rst and ifn
1 parent 4b523fd commit b7e25fe

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

Packages/MIES/SweepFormulaHelp.ifn

2.86 KB
Binary file not shown.

Packages/doc/SweepFormula.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2025,6 +2025,45 @@ 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+
X-waves specified by the `vs` keyword are not appended to the table.
2041+
2042+
The table(s) are displayed in a separate window.
2043+
2044+
If the input has dimension labels then these are also shown in the table.
2045+
2046+
When a table is active then through the context menu the formula of the results shown can be
2047+
copied to the clipboard. Multiple formulas are seperated by the `with` keyword.
2048+
2049+
.. code-block:: bash
2050+
2051+
table(data(select()))
2052+
2053+
Shows the last sweep data
2054+
2055+
.. code-block:: bash
2056+
2057+
table(1)
2058+
with
2059+
table(2)
2060+
with
2061+
3
2062+
and
2063+
table(4)
2064+
2065+
Shows 1 and 2 in the first table, 4 in the second table and 3 in the plot window.
2066+
20282067
Plotting
20292068
^^^^^^^^
20302069

0 commit comments

Comments
 (0)