2023.1
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk classes for the following Altair HyperWorks applications.
View new features for version 2023.1.
Learn the basics and discover the workspace.
Discover product functionality with interactive tutorials.
Extensions are programs integrated with the application to enhance or extend the user experience.
Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
Batch mode allows you perform a series of operations outside the program interface.
External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
The Python API documentation for HyperView and HyperGraph.
APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
Examples of script uses cases.
Learn more about Tcl/Tk with this basic example.
Learn more about programming with Tcl/Tk commands with this tutorial.
Adds a new bar chart curve to the HyperGraph 3D window. Bar chart curves display each point in the 3-D curve as a bar rising from the XY plane.
Adds a category string to the specified axis.
Adds a new curve group to the HyperGraph 3D window. Curve groups hold multiple 3-D line curves.
Adds a new note to the HyperGraph 3D window.
Adds a new plane to the HyperGraph 3D window.
Adds a new curve group to the HyperGraph 3D window.
Add a new 3-D Surface curve to the HyperGraph 3D window.
Returns whether or not the axes are displayed.
Adds a new waterfall curve to the HyperGraph 3D window. Waterfall curves hold multiple 3-D line curves.
Forces the plot to re-compute the minimum and maximum values for its axes.
Clears all data from the plot.
Copies the bar chart curve to the internal clipboard.
Copies the curve group to the internal clipboard.
Copies the note to the internal clipboard.
Copies the plane to the internal clipboard.
Copies the curve to the internal clipboard.
Copies the waterfall curve to the internal clipboard.
Forces the plot to redraw.
Gets the relative lengths of the Y and Z axes with respect to X.
Gets whether the axis ratios are locked.
Returns the current axes scaling method.
Gets a handle to a plt3DIAxis interface for the specified axis.
Returns the current background color of the HyperGraph 3D window.
Gets a pointer to a bar chart curve.
Returns a category string from the specified axis.
Gets whether clipped data is partially visible (displayed transparently).
Obtains the contour display state.
Gets a pointer to a curve group.
Gets whether the client wishes to receive curve-picking information.
Gets the state of blended versus discrete contour shading.
Gets a handle to a pltITitle interface for the footer.
Returns the current foreground color of the HyperGraph 3D window.
Returns the current axes grid line color of the HyperGraph 3D window.
Gets a handle to a pltITitle interface for the header.
Gets a handle to a pltILegend interface for the legend.
Gets the legend location for the plot.
Gets the lighting state.
Gets the thickness of the mesh lines.
Gets a named meta-data value previously associated with the plot.
Gets a pointer to a note.
Returns the number of bar charts in the HyperGraph 3D window.
Gets the current number of bar charts on the clipboard.
Returns the number of categories in the plot.
Gets the number of curves groups in the HyperGraph window.
Gets the current number of curve groups on the clipboard.
Gets the number of notes in the HyperGraph window.
Gets the current number of notes on the clipboard.
Gets the number of planes in the HyperGraph window.
Gets the current number of planes on the clipboard.
Gets the number of projection curve groups in the HyperGraph window.
Gets the current number of projection curve groups on the clipboard.
Gets the number of surfaces in the HyperGraph window.
Gets the current number of surfaces on the clipboard.
Gets the number of waterfall curves in the HyperGraph window.
Gets the current number of waterfalls on the clipboard.
Finds the size of the aperture.
Gets a handle to an interface for the picked object.
Gets a pointer to a plane.
Gets whether the client receives shift-picking information.
Gets the state of normal smoothing.
Gets a pointer to a surface curve.
Gets original component name of a 3D symbol.
Returns whether the axes are displayed.
Gets the original component name of a 3D symbol.
Gets a pointer to a waterfall curve.
Returns the current zero axes grid line color of the HyperGraph 3D window.
Pastes the bar chart curve from the internal clipboard.
Pastes the curve group from the internal clipboard.
Pastes the note from the internal clipboard.
Pastes the plane from the internal clipboard.
Pastes the curve from the internal clipboard.
Pastes the waterfall curve from the internal clipboard.
Forces the plot to regenerate all calculated data and reread all file data.
Releases MFC mouse capture to avoid problems with TCL menus.
Deletes a bar chart curve from the HyperGraph 3D window.
Deletes a note from the HyperGraph 3D window.
Deletes a plane from the HyperGraph 3D window.
Deletes a curve group from the HyperGraph 3D window.
Deletes a surface curve from the HyperGraph 3D window.
Deletes a waterfall curve from the HyperGraph 3D window.
Sets the relative lengths of Y and Z axes with respect to X.
Sets whether the axis ratios are locked.
Sets whether the axes are displayed.
Sets the current background color of the HyperGraph 3D window.
Sets whether clipped data is partially visible (displayed transparently).
Turns the contour display on and off.
Sets whether the client receives curve-picking information.
Displays the contour lines with edges or blended.
Sets the current foreground color of the HyperGraph window.
Sets the current axes grid line color of the HyperGraph 3D window.
Sets whether the axes box is kept visible by a fit operation.
Sets the legend location for the plot.
Turns lighting and shadows on and off.
Sets the display thickness of the mesh lines.
Sets whether the client receives shift-picking information.
Turns edge smoothing on and off.
Sets the current zero axes grid line color of the HyperGraph 3D window.
Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
XML commands in the Result Math Module.
Record playback workflows in the application.
The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.
View All Altair HyperWorks Help