Jackson Labs PHASE STATION 53100A, User Manual

Page: 155 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 155
The
FileSave()
function returns a string containing the saved file’s fully-qualified
pathname. Any errors that occur will not be reported to the script. They will result in a
JavaScript exception which will terminate the script with an appropriate error message.
To save .TIM data from multiple plots in a multichannel measurement, you must use
ScriptBindToPlot()
to associate the script with channels other than the first one. See
53100A_performance_test.js
for an example.
FileSaveText(String path, [String subdir,] String filename, String contents)
The
FileSaveText()
function saves the ASCII
contents
string to
filename
. As with
FileSave()
above, the user’s Documents folder is treated as the destination folder if
path
is empty.
Any explicitly-specified
path
must already exist. The
subdir
parameter is optional; it
represents a subdirectory relative to
path
in which the destination file will be saved.
Unlike
path
, the
subdir
folder will be created automatically if it does not already exist.
This function returns a string containing the saved file’s fully-qualified pathname. Any
errors that occur will not be reported to the script. They will result in a JavaScript
exception which will terminate the script with an appropriate error message.
As an example, 53100A_performance_test.js uses
FileSaveText()
to save its HTML report.
LegendSelect([String field_name] [,] [Boolean status])
Controls and/or reports the visibility of a given parameter (
field_name
) in the legend table
beneath the graph.
This function’s arguments may consist of a single Boolean value, in which case it will
select or deselect
all
legend fields in a manner similar to the Legend→All or
Legend→None menu commands; a single String value, which will simply return the
visibility state of the specified
field_name
without changing it; or both String and Boolean
parameters, which will show (
status
==true) or hide (
status
==false) the specified
field_name
in the table and return its previous state.
MaskResultMargin([Number mask_num])
Returns a Number value representing the margin by which the measurement associated
with the script is passing (if positive) or failing (if negative) the mask test selected by
MaskSelect().
The returned value is based on the most recently rendered frame, so it is
dependent on both the current measurement view
and
the specified mask. Refer to the
Masks menu description on page 117 for more information about TimeLab’s mask-test
functionality.
Up to three masks may be selected at once. The optional
mask_num
parameter ranges
from 0 to 2, defaulting to 0 if not specified.