2022.3
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Provides information about developing and simulating models through the Activate Application Program Interface.
Learn about the APIs available for manipulating blocks through the Block Diagram Editor.
Discover new features and enhancements.
New to Activate? Learn the basics here.
Start using Activate with our interactive tutorials.
Learn about the features and functionality available in Activate.
PDF file with in-depth information on key topics in the User's Guide.
OpenMatrix is a mathematical scripting language.
The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
Describes all of the blocks in the installed Activate library.
Adds buttonParameterName with the value, buttonValue, to the tab sectionName within block. Works with inline blocks. Super blocks are inlined blocks.
Adds a parameter to a given block.
Adds validValues for a parameter within block.
Adds a sub parameter to a parameter in a given block. Works only with parameters that have a widget of the type table or combobox. Works only with inline blocks. Super blocks are inlined blocks.
Adds a text parameter for block. Works only with inline blocks. Super blocks are inlined blocks.
Applies the changes that have been made through the editor apis.
Clears the parameters for a given block. Will only clear the parameters for inline blocks, hence it works with super blocks.
Creates and adds a tab parameter for a block.
Deletes the dialog box.
Disables a parameter within block. Works with inline blocks. Super blocks are inlined blocks.
Enables a parameter within block. Works with inline blocks. Super blocks are inlined blocks.
Executes the callback script for a buttonParameter within block. Only works with parameters of the type button. Works with inline blocks. Super blocks are inlined blocks.
Returns the block that the dialog is for.
Returns the block that the editor is being used for.
Returns a parameter, parameterName, of a given block.
Returns the callback of buttonParameter in a given block. This is ran while the button is shown in the user interface.
Returns the value of buttonParameter in a given block.
Returns the image of a button parameter in a given block.
Returns the tooltip of buttonParameter in a given block.
Returns the value of a buttonParameter in a given block.
Returns a callback script of a parameter in a given block.
Returns the value of the subparameter column in a given block. This only works with parameters of the type table.
Returns a short description of a parameter in a given block.
Returns the button of a given dialog box.
Returns the filepath of a given dialog box.
Returns the dimensions of a parameter in a given block. Works with parameters of the type matrix.
Returns the button image of a parameter in a given block that has a editor or uneditor widget.
Returns the button text of a parameter in a given block that has a editor or uneditor widget.
Returns whether or not a parameter of a given block is enabled.
Returns the names of the parameters within a given block.
Returns the objects within the parameters section of a given block.
Returns the row size of a parameter in a given block.
Returns a parameters editor from the given dialog.
Returns the value of a subparameter within a parameter.
Returns the script to call for a given block after clicking ok on a parameters dialog.
Returns the script to call for a given block before showing the parameters dialog.
Gets the values of the parameters in block.
Returns the section that the parameter is in within block.
Returns a list of the different section tabs of parameters within the block.
Returns text parameters of a given block.
Returns the tooltip of a given text parameter, parameterName, within block.
Returns text value of a given text parameter, parameterName, within block.
Returns a description of a parameter in a given block that is useful for understanding the parameters.
Returns the type of a parameter in a given block.
Returns the unit of a parameter in a given block.
Returns a list of the valid values you can use for a specific parameter within block.
Returns whether or not a parameter of a given block is visible.
Returns the type of widget that is used to enter the parameter within the user interface.
Returns the names of the sub parameters within a given block.
Returns whether or not an editor has modified any of its parameters.
Sets the visibility of parameter within block to be not visible. Works with inline blocks. Super blocks are inlined blocks.
Removes a parameter from a given block.
Saves a parameters tab of the dialog box of a given block. Must be saved as .png, .jpg, or .jpeg. Block must be inline. This means the block is not included in the library system.
Sets the callback parameter for the button, buttonName, within block. The callback is ran while the button is shown. Works with inline blocks. Super blocks are inlined blocks.
Sets a description for a button, buttonParameterName, within block. Works with inline blocks. Super blocks are inlined blocks.
Sets the enabled flag for the button, buttonName, within block. Works with inline blocks. Super blocks are inlined blocks.
Sets the buttonImage for a parameter within block. Works only with parameters with the widget editor or uneditor. Works only with inline blocks. Super blocks are inlined blocks.
Sets a shortDescription for a buttonParameter within block. Only works with parameters with the widget type button. Works with inline blocks. Super blocks are inlined blocks.
Sets a buttonValue for a button, buttonParameterName, within block. Works with inline blocks. Super blocks are inlined blocks.
Sets the callback script for parameter in a given block. Works with inline blocks. Super blocks are inlined blocks.
Sets a short description for a parameter within block. Works with inline blocks. Super blocks are inlined blocks.
Sets the dimension for a parameter within block. Used for parameters with the type of matrix. Works with inline blocks. Super blocks are inlined blocks.
Sets the buttonText for a parameter within block. Works only with parameters with the widget editor or uneditor. Works only with inline blocks. Super blocks are inlined blocks.
Sets a parameter within block to be enabled based on the variable enable. Enable can be a boolean or a string. Only works on inlined blocks. Super blocks are inline blocks.
Sets the rowSize for a parameter within block. Works only with parameters that have the widget type table. Works with inline blocks. Super blocks are inlined blocks.
Sets the value for a subparameter using an editor. The variable value can be different types depending on what the parameter that is being set is.
Sets the script for post callback for a block, which will happen after pressing ok on the dialog box. Works with inline blocks. Super blocks are inlined blocks.
Sets the script for pre callback for a block, which will happen before showing the parameters dialog box. Works with inline blocks. Super blocks are inlined blocks.
Sets a description for a textParameter within block. Works with inline blocks. Super blocks are inlined blocks.
Sets the paramValue for a textParameter in block. Works only with inline blocks. Super blocks are inlined blocks.
Sets a description for a parameter within block. This should contain useful information on how to use the block's parameter's valid options. Works with inline blocks. Super blocks are inlined blocks.
Sets the paramType for a parameter within block. Works with inline blocks. Super blocks are inlined blocks.
Sets a unit for a parameter within block.
Sets the validValues for a parameter within block. Works for parameters with widgets of the type listbox, checkbox, comboboxelement, radiobuttonelement.
Sets the value for a parameter using an editor from block. The variable value can be different types depending on what the parameter that is being set is.
Sets the visibility of parameter within block. Works with inline blocks. Super blocks are inlined blocks.
Sets the type of widget for a parameter within block. Works with inlined blocks. All super blocks are inline blocks.
Sets the flag for the enabled flag of a parameter.
Sets the flag for the visible flag of a parameter.
Sets the visibility of parameter within block to be visible. Works with inline blocks. Super blocks are inlined blocks.
Learn about the APIs available for obtaining information from Activate models, for example information about variables and environments.
Learn about the APIs available for simulating models.
Key terms associated with the software.
You've got questions? We've got answers!
View All Altair Simulation Help