6. Overview Automation

See Overview Automation for a full description.

	Functions
auto_AddToUI	auto_AddToUI adds a UniScript function to UniPlot’s user interface. The function will be added to the Report Menu to the specified category.
auto_CloseDocument	auto_CloseDocument closes the active document. If the document was not saved with the auto_SaveDocumentAs function, it will close without being saved.
auto_AddPage	auto_AddPage adds a new page to the document.
auto_GetFileNameDialog	auto_GetFileNameDialog displays a dialog box which can be used to select up to 16 file names. The function can be used within an automation script.
auto_ImportData	auto_ImportData opens a data file and converts it to a UniPlot data file (.nc2). The netCDF file is saved in the directory of the source data file or in the directory specified in Tools=>More Options dialog. The function can be used to import data from all supported file formats (Text-, Excel-, netCDF-Files etc.). For Excel files, the table name can be specified as the second parameter.
auto_LoadDataset	auto_LoadDataset loads a 1D, 2D, or 3D dataset from a data file opened with the function auto_ImportData.
auto_LoadStyleFile	auto_LoadStyleFile loads a style file. The style file contains descriptions which specify the style of a dataset. Some example files can be found in the the UniPlot Sample directory. They have the file name extension .sty .icb.
auto_LoadTemplate	auto_LoadTemplate opens a template.
auto_PrintDocument	The auto_PrintDocument function prints the entire document to the active printer.
auto_PrintPage	auto_PrintPage prints the page created with the auto_LoadTemplate function to the active printer.
auto_ReadNCText	auto_ReadNCText reads an attribute from the most recently imported data file.
auto_ReplaceText	auto_ReplaceText executes a find and replace command. The function searches in text objects and axis titles for the find text and replaces it with the specified text.
auto_ReplaceTextDialog	auto_ReplaceTextDialog can be used within an automation script to show a text dialog box.
auto_ReplaceTextFromNCFile	auto_ReplaceTextFromNCFile searches the given page for bookmarks (strings enclosed in dollar signs, Example $Origin$) and replaces the text with attribute values from the given netCDF (.NC) file.
auto_SaveDocumentAs	auto_SaveDocumentAs saves the document created with the auto_LoadTemplate function under a new name.
auto_ScaleAxes	auto_ScaleAxes re-scales all diagrams on the page created with the auto_LoadTemplate function, so that all datasets on the diagrams are completely visible.
auto_SetDatasetStyle	auto_SetDatasetStyle sets the dataset style for the next dataset to be created with the auto_LoadDataset function.
auto_SetLegendText	auto_SetLegendText creates a legend entry for 1D and 2D datasets. If the function is called without parameters, the file name from the loaded data will be used as text.
auto_UpdatePage	auto_UpdatePage should be the last function called to finish the template page. The function copies the created legend text in the text object with the $LEGEND$ place-holder, updates legend size, and updates the page on the monitor.
auto_UpdateLegendSize	auto_UpdateLegendSize updates the size of the legend, already set in the template with the $LEGEND$ bookmark, to the size of the legend text.
XLSREPORT_CreateFromTemplate	XLSREPORT_CreateFromTemplate inserts data into an MS-Excel template.

	Functions for x/y Datasets (1D and 2D Dataset)
auto_xy_Add	auto_xy_Add creates a new dataset from the sum of the y-coordinates of 2D datasets.
auto_xy_Correlate	auto_xy_Correlate creates a new dataset by using the interpolated y-coordinates of the first dataset as x-values and the y-coordinates of the second datset as y-values.
auto_xy_CorrelationCoefficient	auto_xy_CorrelationCoefficient calculates the correlation coefficient.
auto_xy_CreateDataset	auto_xy_CreateDataset creates a new 2D dataset.
auto_xy_CreateErrorDataset	auto_xy_CreateErrorDataset creates a new 2D dataset with error data.
auto_xy_CreateRegion	auto_xy_CreateRegion creates a new dataset by concatenating two datasets. The second dataset will be added to the first dataset in reverse order.
auto_xy_Derivative	Diese Funktion ist veraltet. Neue Scripte sollten die Funktion XYSetFilterFunctions verwenden.
auto_xy_Div	Creates a new dataset by adding the y-coordinates of the given 2D datasets.
auto_xy_Envelope	auto_xy_Envelope creates an upper or lower envelope (hull, boundary).
auto_xy_ExtractRange	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_GetParentHandle	auto_xy_GetParentHandle returns the handle of the diagram hLayer, page hPage and document hDoc in which the dataset is located.
auto_xy_Integral	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_IntegralValue	auto_xy_IntegralValue returns the integral value of the given dataset as a string.
auto_xy_Interpolate	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_LabelDataPoints	auto_xy_LabelDataPoints labels the data points of a 1D or 2D dataset with its y value. If the dataset contains more than 50 data points, 50 labels will be distributed evenly over the data points.
auto_xy_LabelDataPoints_SetOptions	auto_xy_LabelDataPoints_SetOptions
auto_xy_LabelDataset	auto_xy_LabelDataset labels the first or last point of a 2D dataset with its name.
auto_xy_LinearInterpolation	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_Max	auto_xy_Max creates a new dataset from the maximum values of the y coordinates of the given 2D datasets.
auto_xy_Mean	Creates a new dataset from the mean values of the y coordinates of the given 2D datasets.
auto_xy_MinMaxValue	auto_xy_MinMaxValue returns a string with the minimum and maximum value (y-coordinates) of the specified dataset.
auto_xy_Mult	auto_xy_Mult creates a new dataset by multiplying the y-coordinates of the given 2D datasets.
auto_xy_OneDown	auto_xy_OneDown moves the specified dataset one position down in the drawing order.
auto_xy_OneUp	auto_xy_OneUp moves the specified dataset one position up in the drawing order.
auto_xy_Peaks	auto_xy_Peaks creates a new dataset with the local minima and maxima of the given dataset. See detect_peaks.
auto_xy_RemoveDoublePoints	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_Scale	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_SetStyleAttribs	auto_xy_SetStyleAttribs sets the line and/or marker style, color, etc. without using the style file.
auto_xy_Smooth	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_SortX	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_Spline	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_Statistic	auto_xy_Statistic calculates some statistical values and returns them as a string.
auto_xy_Step	The function is obsolete. New scripts should use the XYSetFilterFunctions function.
auto_xy_Sub	auto_xy_Sub creates a new dataset by subtracting the y coordinates of the given 2D datasets.
auto_xy_histogram	Creates a histogram for the given 2D dataset.

	Functions for x/y/z Datasets (3D Datasets)
auto_xyz_Add	auto_xyz_Add creates a new dataset by adding the z-coordinates of the given 3D datasets.
auto_xyz_CreateColorLegend	auto_xyz_CreateColorLegend creates a color legend for the given 3D dataset.
auto_xyz_CreateHull	auto_xyz_CreateHull calculates a non convex data hull (Full Load Line, WOT) for the given 3D dataset if the data was measured at approx. constant x- (e.g. speed) or y-values.
auto_xyz_CreateIsolines	auto_xyz_CreateIsolines creates isolines for a 3D dataset.
auto_xyz_CreatePowermap	auto_xyz_CreatePowermap creates a power map (power hyperbola).
auto_xyz_CrossSectionXY	auto_xyz_CrossSectionXY creates a new dataset by by calculating the z coordinates for the given curve coordinates.
auto_xyz_Div	auto_xyz_Div creates a new dataset by dividing the z coordinates of the given 3D datasets.
auto_xyz_Interpolate	auto_xyz_Interpolate calculates a new interpolation matrix for the given 3D dataset.
auto_xyz_Mean	auto_xyz_Mean creates a new dataset by calculating the mean value of the z coordinates of the given 3D datasets.
auto_xyz_Mult	auto_xyz_Mult creates a new dataset by multiplying the z coordinates of the given 3D datasets.
auto_xyz_RelDiv	auto_xyz_RelDiv creates a new dataset by calculating the relative distribution value of the z coordinates of the given 3D datasets.
auto_xyz_SetIsolineStyle	auto_xyz_SetIsolineStyle sets the line style for all Isolines of a 3D dataset to the specified style.
auto_xyz_Statistic	auto_xyz_Statistic creates a text element with some statistical information for the given 3D dataset.
auto_xyz_Sub	auto_xyz_Sub creates a new dataset by subtracting the z coordinates of the given 3D datasets.

_id-1891577