UniScript 4.x¶
New Functions in UniPlot 4.2.3 |
|
|---|---|
ReportControl_GetStyleNames returns a string vector with style names of the specified style file which can be used to initialize the marker combo box in a report control. |
|
ReportControl_GetStyles returns the style names of the selected styles in the report control of a dialog box. |
New Functions in UniPlot 4.2.2 |
|
|---|---|
AppEventWndClear removes all events from the event window. |
|
CreateListBoxText creates the iniatialize string for list boxes and combo boxes. |
|
GetListBoxText splits the return value of a combo box or list box into a string vector. The value is returned from the DialogBox function. |
|
NC_GetVarNames returns the variable names of a netCDF data file (NC file). |
|
ReportControl_GetColorNames returns a string vector with color values and names. |
|
ReportControl_GetColorRGB returns the color values of a marker control in a report control. |
|
ReportControl_GetInit converts a string matrix into a scalar string which can be used to initialize the report control in a dialog box. |
|
ReportControl_GetLineStyle returns the line style value of a marker combo box of a report control. |
|
ReportControl_GetLineStyleNames returns a string vector with line style names which can be used to initialize the marker combo box in a report control. |
|
ReportControl_GetMarkerStyle returns the marker index of the marker selected in the report control in the dialog box. |
|
ReportControl_GetMarkerStyleNames returns a string vector with marker names which can be used to initialize the marker combo box in a report control. |
|
ReportControl_GetMatrix converts the DialogBox return value for the report control into a matrix. |
|
ReportControl_RemoveSelection is a helper function to remove the selected records from a report control. Add a button to the control and call this function in the button callback function. |
|
ReportControl_SelUpOrDown is a helper function to modify the record order in a report control. Add a button to the control and call this function in the button callback function. |
|
The ReportControl_Sort callback function can be set in the dialog box template string of a report control to enable sorting of records. The function is invoked by UniPlot when the user clicks the buttons in the header of a report control. |
New Functions in UniPlot 4.2.1 |
|
|---|---|
md5 calculates the MD5 check sum using the algorithm http://www.faqs.org/rfcs/rfc1321.html, MD5 Message-Digest Algorithm (RFC 1321). |
|
md5_file calculates the MD5 check sum using the algorithm http://www.faqs.org/rfcs/rfc1321.html, MD5 Message-Digest Algorithm (RFC 1321). |
New Functions in UniPlot 4.2.0 |
|
|---|---|
GridGetSwapRowCol checks if the channels are displayed in the Browser dialog in columns or rows. |
|
GridReplaceFile replaces the data file displayed in the Browser dialog. |
|
GridSetSwapRowCol sets the display of the data channels in the data browser (channels can be displayed in rows or columns). |
|
LayerMoveDataset moves datasets to the specified diagram. Datasets can only be moved inside a page. The function can also be used to change the drawing order of datasets. |
|
LayerMoveObjects moves Objects to the specified diagram. Objects can only be moved inside a page. The function can also be used to change the drawing order of Objects. |
|
OBJGetParentCB returns the handle of the parent group object. |
|
RBSetMillimeterEx displays a millimeter grid in the rectangle object. The gridlines are drawn with the edge pen. |
|
The interpol function executes a linear interpolation or cosine interpolation for the given x-coordinates. |
|
mem_alloc creates a scalar string of the given length. |
|
mem_compare compares two strings or string matrices which may contain 0-characters. |
|
mem_compress compresses a string which may contain 0-characters. |
|
mem_get reads bytes from a string and converts the data. |
|
mem_len returns the length in bytes of a scalar string or a matrix of strings. |
|
mem_set sets the bytes in a string to values of a specified data type. |
|
mem_uncompress uncompresses a string that was compressed with mem_compress or zlib. |
|
poly_poly_intersect returns the intersections of two polylines. |
Changed Functions in UniPlot 4.2.0 |
|
|---|---|
Labels the data points of the original data with its y value. |
|
DialogBox creates a dialog box with static text, edit fields, list boxes, combo boxes, check boxes, a report list (list with multiple columns), a property list box, a group box, tree control and buttons.The dialog box can be configured to be resizeable (see Dialog control |
|
GridGetConfigInfo returns a string vector with 6 elements containing the options, displayed in the option dialog box. |
|
GridSetConfigInfo sets the data browser configuration. |
|
LayerGetAllDatasets returns the handles of all datasets. |
|
MapLookup uses a hashing algorithm to quickly find the map element with a key that exactly matches the given key. |
|
MapSetAt means to insert an element in a map. First, the key is looked up. If the key is found, then the corresponding value is changed; otherwise a new key-value pair is created. |
|
RegisterFunction registers a function from a dynamic link library (DLL) to the UniScript symbol table. After a function is registered, the function can be called directly by UniScript. |
|
base64_decode decodes a string that had been encoded using the base64_encode function. |
|
base64_encode encodes data into the base64 format |
|
Is replaced by base64_encode. |
|
Is replaced by base64_encode. |
|
fread reads data from a file. |
|
Removed, use sqlite3_open. |
|
strcode returns the code values (numbers) of the given string. |
|
strextract returns a substring of its argument string. |
|
strlen returns the length of a string in bytes. |
New Functions in UniPlot 4.1.2 |
|
|---|---|
OnImportUpdateNCFile will be invoked by the frame work, when the user imports a datafile. |
|
XYZGetIsoAreas returns the area between the isolines as a percent value of the complete map. |
|
XYZGetIsoValuesScaleType returns information about the autoscaling of isoline values (Autoscale On/Off, Type, Number of values). |
|
XYZGetLabelFormatType returns a value that specifies how the decimal places of isoline labels are created (manually or automatically). |
|
XYZGetLabelTypeIsolines returns the isoline label settings. |
|
XYZSetIsoValues sets the isoline values. |
|
XYZSetIsoValuesScaleType specifies how the isoline values are calculated (atuomatically or manually). |
|
XYZSetLabelFormatType specifies how the decimal places of isoline values are calculated (manually or automatically). |
|
XYZSetLabelTypeIsolines specifies how the isoline labels are placed in the dataset. |
|
strmatchi returns a vector of indices of those matrix elements which match the given pattern. |
New Functions in UniPlot 4.1.0 |
|
|---|---|
error_create creates an error object. |
|
gc invokes the garbage-collector. |
|
obj_copy creates a copy of an object. |
|
obj_count returns the number of variables in an object. |
|
obj_count_num returns the number of number keys in an object. |
|
obj_count_str returns the number of string keys in an object. |
|
obj_create creates an UniScript object. |
|
obj_has_key checks if a given key exists. |
|
obj_info returns a string of the form “obj-name,hex-address”. |
|
obj_keys returns all keys or a range of keys for the given object. |
|
obj_load loads an object saved with obj_save from the hard drive. |
|
obj_lookup returns the value of a given key. |
|
obj_methods returns an object with methods (member functions) for the given object. |
|
obj_parent returns the parent object or 0 if the object does not have a parent. |
|
obj_remove removes a key-value pair from an object. |
|
obj_save saves an object as an XML file or as an binary file on the hard drive or as a string. |
|
obj_set_at adds a key-value pair to the given object. If the key already exists the value will be overwritten. |
|
obj_set_methods sets the methods (member functions) for the given object. |
|
obj_set_parent sets the parent object. |
|
obj_set_str_return specifies the return value of obj_lookup. If a key does not exist, obj_lookup may return 0, an empty string or throw an exception. |
|
utf8_decode converts an UTF8 string to an ANSI string. |
|
utf8_encode converts an ANSI string to an UTF8 string. |
New Functions in UniPlot 4.0.3 |
|
|---|---|
XYGetProps returns a string with properties of an x/y dataset. |
|
XYSetDefault sets all dataset properties of 2D dataset to default. |
|
XYSetProps sets the dataset properties of a 2D dataset. |
|
XYZGetProps returns the dataset properties of a 3D dataset (x/y/z). |
|
XYZIsIsolinesVisible returns a nonzero value if the isolines are visible; otherwise 0. |
|
XYZSetDefault sets all dataset properties of a 3D dataset to default. |
|
XYZSetProps sets the dataset properties of a 3D dataset. |
|
XYZShowIsolines shows or hides the isolines. |
|
nc_get_option gets an option. |
|
nc_set_option sets an option. |
New Functions in UniPlot 4.0.0 |
|
|---|---|
ADDIN_AddToUI adds a function to the UniPlot user interface. |
|
DocGetProtectionComment retrieves the comment that is displayed when a password protected document is opened. |
|
DocGetProtectionFlags returns the protection flag. |
|
DocIsReadOnly checks if the read-only flag is set. |
|
DocSetProtectionFlags sets the password, the comment and the protection flag. |
|
DocSetReadOnly sets the read-only flag. |
|
EdFind finds a string in an editor. |
|
EdFindReplace replaces a string in an editor. |
|
EdGetCurrentPos returns the cursor position in characters from the beginning of the file. |
|
EdGetCursorPos returns the cursor position in column/row coordinates. |
|
EdGetLineFromPos returns the line number for the given position. |
|
EdGetPosFromLine returns the position of the given line. The position is the number of characters from the beginning of the file. |
|
EdGetWnd returns the window handle |
|
EdGotoPos sets the cursor to the given position |
|
EdIsReadOnly checks if the read-only flag is set. |
|
EdSetReadOnly sets the read-only flag. |
|
GetProfileSection returns all keys with their values of the specified section in the form key=value. |
|
GetProfileSectionNames returns a string vector with the section names. |
|
GridLoadCallback_xxx is called when the user presses the Load button in the data browser. |
|
ImageIsFrame checks if the picture frame is visible. |
|
ImageMirror reflects the image vertically. |
|
ImageRotate90 rotates the image by 90 degrees clockwise or counterclockwise. |
|
ImageSaveAs saves the picture in its orignal format as a file. |
|
ImageShowFrame shows or hides the frame of the picture. |
|
The NC_DlgGetFileName function returns the NC file name of the currently open file in the NC file browser. |
|
OLESavePicture saves one OLE object in a file. |
|
PageSetBackgroundPageName selects the page given by its name to be displayed in the background. The page must belong to the same document. |
|
PageSetForegroundPageName selects the page given by its name to be displayed in the foreground. The page must belong to the same document. |
|
RemoveDirectory deletes an existing directory. The directory must be empty, and it must not be the current working directory or the root directory. |
|
Is replaced by EdFindReplace. |
|
Is replaced by EdFind. |
|
Is replaced by EdFoldAll. |
|
Is replaced by EdGetMarginType. |
|
Is replaced by EdSetMarginType |
|
Is replaced by EdToggleFolding. |
|
TYAddData adds data to a y/t dataset (1D dataset). |
|
TYSetData sets the coordinates of a y/t datasets (1D-dataset). |
|
TableAddBrush adds a new bush (fill color) to the brush list. |
|
TableAddFont adds a font to font list of a table object. |
|
TableAddFormat adds a format string and cell type to a table object. |
|
TableAddPen adds a pen to the list of pens of the specified table object. |
|
TableCreate create a new table object. |
|
TableDeleteColumn deletes a table column. |
|
TableDeleteRow removes the specified row from the table |
|
TableDestroy destroys the given table object and frees any memory the object occupied. |
|
TableGetAlign retrieves the text alignment for all cells or a range of cells. |
|
TableGetAttrib returns a matrix of cell attributes. |
|
TableGetBrushIndex returns a matrix with the brush indices. |
|
TableGetBrushList returns a matrix with 3 columns. Each row specifies a color used in the table. |
|
TableGetColumnWidth returns a vector with column width in centimeters. |
|
TableGetEdgeDistance returns the distance between the text and the left cell edge. |
|
TableGetFontIndex returns a vector of font indices. |
|
TableGetFontList returns a vector with font handles. |
|
TableGetFormatIndex returns a matrix with the format indices. |
|
TableGetFormatList returns a string matrix with two columns with cell format information. |
|
TableGetName returns a matrix of cell names. |
|
TableGetPenList returns a vector with pen handles. A pen is used to draw the cell border line. |
|
TableGetRowHeight returns a vector with row heights in centimeters. |
|
TableGetSelection returns the current selection. |
|
TableGetSize returns the number of rows and columns. |
|
TableGetText returns a matrix of cell text. |
|
TableGetTextAngle returns the text directions of all cells or a selection of cells. |
|
TableGetTextExt returns the width and height of cell text. |
|
TableInsertColumn inserts a new column of cells to the specified table. |
|
TableInsertRow inserts a new row of cells to the specified table. |
|
TableIsCellMerged returns TRUE (1) if the specified cell belongs to a merged cell. |
|
TableMergeCells specifies which neighbouring cells are merged. |
|
TableSetAlign sets the text alignment for all cells or a range of cells. |
|
TableSetAttrib sets the cell attributes. |
|
TableSetBorderPenIndex sets the pen index that is used to draw the border. Every cell is enclosed by 4 border lines. |
|
TableSetBrushIndex sets the brush indices. |
|
TableSetColumnWidth sets the column width in centimeters. |
|
TableSetEdgeDistance sets the distance between the text and the cell edge. |
|
TableSetFontIndex sets the font index. |
|
TableSetFormatIndex sets the format indices. |
|
TableSetName sets the cell name. |
|
TableSetRowHeight sets the row height in centimeters. |
|
TableSetSelection sets the selection. |
|
TableSetText sets the cell text. |
|
TableSetTextAngle sets the text direction of all cells or a selection of cells. |
|
TableUnMergeCell splits a merged cell. |
|
TableUsePlaceholderDialog spedifies the dialog box which will be displayed if the table is double-clicked. |
|
XYGetErrorbarConfig returns the error bar settings. |
|
XYGetFilterFunctions returns a scalar string with filter functions. |
|
XYGetGetOrgDataFlag returns the flag set with XYSetGetOrgDataFlag. |
|
XYGetScaleOffset gets the scaling for the x- and y coordinates of the given dataset. |
|
XYIsFilterUsed checks if the original data or the filtered data is displayed. |
|
XYIsMarkerOrgData checks if the marker are displayed for the original data points or the filtered data points. |
|
XYIsMonoton returns TRUE (1) if the x-coordinates are strictly monoton increasing. |
|
XYSetData sets the xy-coordinates of a dataset. |
|
XYSetErrorbarConfig sets the error bar settings. |
|
XYSetFilterFunctions sets one or more filter functions for a 2D dataset. |
|
XYSetGetOrgDataFlag specifies if the XYGetData function returns the original data or the filtered data. |
|
XYSetScaleOffset sets the scaling for the x- and y-coordinates of the given dataset. |
|
XYShowMarkerOrgData specifies if the dataset markers are displayed for the original data or the filtered data. |
|
The XYUpdate functions recalculates the filter functions of a 2D dataset. |
|
XYUseFilter specifies if the filter functions are used to calculate the output data. |
|
XYZGetBubbleAttribute returns the bubble plot settings. |
|
XYZGetBubbleSize returns the bubble scaling values. |
|
XYZGetBubbleSize returns the bubble diameter in centimeters. |
|
XYZIsBubbleVisible indicates whether the bubbles are visible. |
|
XYZSetBubbleAttribute sets the bubble plot attributes. |
|
XYZSetBubbleScaleValues sets the scale values to calculate the bubble size. |
|
XYZSetBubbleSize sets the bubble size in centimeters. |
|
XYZShowBubble shows or hides bubbles marking the original position of the data points. The bubble size and fill color can depend on the Z-Value. |
|
_mem returns the size of used memory allocated by UniScript. |
|
base64_decode decodes a string that had been encoded using the base64_encode function. |
|
base64_encode encodes data into the base64 format |
|
Is replaced by base64_encode. |
|
Is replaced by base64_encode. |
|
eval evaluates the string given as UniScript code. |
|
eval_file loads a file with UniScript program code. |
|
evalp evaluates UniScript program code. |
|
evalp_file loads a file with UniScript program code. |
|
get_prototype returns the prototype string of a UniScript function. |
|
nc_filename returns the file name for a given ncid. |
|
nc_varcopy copies the data of a variable from one NC file to another NC file. The variable must exist in both files and must have the same number of points. |
|
profiler_start starts the profiler. The profiler can be used for analyzing the run-time behavior and performance of programs. |
|
profiler_stop stops the profiler that has been started with the profiler_start function. The profiler can be used for analyzing the run-time behavior and performance of programs. |
Altered Functions in UniPlot 4.0.0 |
|
|---|---|
DocCreate creates a new document or opens an existing document. The document can contain pages with diagrams. The document will be displayed in a window. |
|
GetExceptionInfo returns the current exception information vector. |
|
GetTickCount returns the number of milliseconds that have elapsed since UniPlot was started. |
|
GetUserDirectory returns the UniPlot user directory. |
|
ImageCreate creates a picture object. |
|
ImageGetLinkType returns the link type. |
|
MnGetStrings returns the menu item strings of the specified menu. |
|
PageSaveAsBitmap creates a bitmap (.BMP) or JPEG (.JPG) file from the given page. |
|
TYCreate creates a new y/t datasets (1D dataset). |
|
TYSetMinAndDelta sets the minimum value x-min and the distance delta between 2 x-coordinates. |
|
The XYAddData function adds data to an existing dataset. |
|
XYIsSpline determines whether the data points are connected by a spline. |
|
XYIsTYDataset determines whether the dataset is a 1D dataset (yt-dataset). |
|
XYSetSpline determines if the data points should be connected with a spline or a polygon. |
|
poly_hull calculates the convex hull in the x/y plane. |
|
tic retrieves the number of milliseconds that have elapsed since UniPlot was started. |
Obsolete Functions |
|
|---|---|
Is replaced by AppNewTimer. |
|
Is replaced by vconvert. |
|
Deprecated. |
|
Is replaced by log_error. |
|
Is replaced by log_info. |
|
Is replaced by log_warning. |
|
Is replaced by fround. |
|
Is replaced by fround. |
|
Is replaced by fround. |
|
Is replaced by EdCreate. |
|
Is replaced by EdFindReplace. |
|
Is replaced by EdFind. |
|
Is replaced by EdFoldAll. |
|
Is replaced by EdGetMarginType. |
|
Is replaced by EdSetMarginType |
|
Is replaced by EdToggleFolding. |
|
Is replaced by vcast. |
|
Is replaced by vtype. |
|
Is replaced by XYSetData. |
|
Is replaced by XYZGetInterpolationType. |
|
Is replaced by XYZSetInterpolationType. |
|
Function is deprecated. The import options will be created automatically during import. |
|
Is replaced by base64_encode. |
|
Is replaced by base64_encode. |
|
finite checks if the argument is 0/0 or 1/0. |
|
inf returns the result of 1/0. |
|
isinf checks if its argument is in the range -INF … INF. |
|
nan (Not a Number) returns the number 0/0. |
|
Removed, use sqlite3_busy_timeout. |
|
Removed, use sqlite3_close. |
|
Removed, use sqlite3_execute. |
|
Removed, use sqlite3_last_insert_rowid. |
|
Removed, use sqlite3_libencoding. |
|
sqlite_libversion returns the SQLite library version. |
|
Removed, use sqlite3_open. |
id-1903559