HyperWorks Desktop

2021

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following HyperWorks Desktop applications.
HyperView
poILegend Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

2021

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Learn how to create, open, import and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
- HyperWorks Desktop
  - External Readers and Altair Binary Format
    Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
  - Generic ASCII Reader
    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
    Batch mode allows you perform a series of operations outside the program interface.
  - External Resources
    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.
  - Tcl/Tk Commands
    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
    - Program with HyperWorks APIs for Beginners
      APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
    - Object Hierarchy
      Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, MotionView, MediaView and TextView.
    - Tcl/Tk Classes
      Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
    - Script Use Cases
      Examples of script uses cases.
    - Tcl/Tk Example
      Learn more about Tcl/Tk with this basic example.
    - Program with HyperWorks Tcl/Tk Command Tutorials
      Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
    - Tcl/Tk Commands
      Tcl/Tk classes for the following HyperWorks Desktop applications.
      - HyperWorks Desktop
      - MotionView
      - HyperView
        
        Hotspot Finder API Structure
        
        Upfront Data Loader APIs
        
        poI3DViewCtrl Class
        
        poIAdvancedQuery Class
        
        poIAssembly Class
        
        poIBestView Class
        
        poICFD Class
        
        poICFD_rake Class
        
        poICollisionCtrl Class
        
        poICollisionSet Class
        
        poIComplexCtrl Class
        
        poIComponent Class
        
        poIContourCtrl Class
        
        poIExplosion Class
        
        poIFBDCtrl Class
        
        poIFLDCtrl Class
        
        poIGraphicMaterial Class
        
        poIImagePlaneCtrl Class
        
        poIImagePlane Class
        
        poIIsoValueCtrl Class
        
        poILayerFilter Class
        
        poILegend Class
        
        poILegend GetBoundingBox
        Gets the bounding box of the legend.
        
        poILegend GetCategoryLabel
        Gets the category legend label.
        
        poILegend GetCategoryLayerList
        Gets the contributing category layer name list for a Max/Min/Extreme layer contour.
        
        poILegend GetCategoryList
        Gets the contributing category label list for Category Legend plots.
        
        poILegend GetCloneHandle
        Gets a handle to a cloned copy of this legend.
        
        poILegend GetColor
        Gets the color at the given level index.
        
        poILegend GetDefaultScript
        Gets the default script file path.
        
        poILegend GetDefaultState
        Gets the default legend state.
        
        poILegend GetDiscreteColorMode
        Gets the discrete coloring mode of the legend.
        
        poILegend GetFilter
        Gets the legend style.
        
        poILegend GetFilterList
        Gets a valid numeric legend filter list.
        
        poILegend GetFooter
        Gets the footer text.
        
        poILegend GetFooterAttributeHandle
        Gets the text attribute handle for the footer text.
        
        poILegend GetHeader
        Gets the header text.
        
        poILegend GetHeaderAttributeHandle
        Gets a font handle for the header font.
        
        poILegend GetHeight
        Gets the height of the legend bounding box.
        
        poILegend GetMax
        Gets the maximum result value.
        
        poILegend GetMaxByModel
        Gets the legend maximum for a given model ID.
        
        poILegend GetMaximumLevelForCategory
        Gets the maximum number of levels allowed in the Category Legend for a Max/Min/Extreme layer contour.
        
        poILegend GetMin
        Gets the minimum result value.
        
        poILegend GetMinByModel
        Gets the legend minimum for a given model ID.
        
        poILegend GetMinMaxVisibility
        Gets the maximum and minimum legend visibility state.
        
        poILegend GetNumberAttributeHandle
        Gets the text attribute handle for the legend numbers.
        
        poILegend GetNumberOfColors
        Gets the number of color levels.
        
        poILegend GetNumericFormat
        Gets the format string used by the legend.
        
        poILegend SetNumericPrecision
        Sets the precision for numbers.
        
        poILegend SetPosition
        Sets the location of the legend.
        
        poILegend SetReverseEnable
        Enables/disables the reverse state of the legend.
        
        poILegend SetShowCategoryID
        Sets the state of the Show Category ID option for the Category Legend.
        
        poILegend SetStyle
        Sets the legend style.
        
        poILegend SetType
        Sets the legend type.
        
        poILegend SetVisibility
        Sets the legend visibility.
        
        poILegend SyncWithClone
        Applies the settings for the cloned legend to the original legend.
        
        poILegend UnOverrideValue
        Removes the override value for the given color level.
        
        poIMeasure Class
        
        poIModel Class
        
        poINote Class
        
        poIPart Class
        
        poIPartAssembly Class
        
        poIPost Class
        
        poIPostManager Class
        
        poIQueryCtrl Class
        
        poIQueryDistanceRule Class
        
        poIQueryExpressionRule Class
        
        poIQueryExtremeRule Class
        
        poIQueryIgnoreElemTypeRule Class
        
        poIQueryIterator Class
        
        poIQueryRule Class
        
        poIQuerySetRule Class
        
        poIRenderOptions Class
        
        poIResultCtrl Class
        
        poIResultMathCtrl Class
        
        poIScalarDefine Class
        
        poIScaleCtrl Class
        
        poISCL Class
        
        poISection Class
        
        poISelectionSet Class
        
        poIStressLinearizationCtrl Class
        
        poISubcase Class
        
        poISweepCtrl Class
        
        poISymmetry Class
        
        poISystem Class
        
        poISystemCtrl Class
        
        poITensorCtrl Class
        
        poITensorDefine Class
        
        poITextAttribute Class
        
        poITracingCtrl Class
        
        poITrackingSystem Class
        
        poIVectorCtrl Class
        
        poIVectorDefine Class
      - HyperGraph 2D
      - HyperGraph 3D
      - MediaView
      - TextView
      - HgTrans
      - TableView
  - Translators
    Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
  - Result Math
    XML commands in the Result Math Module.
  - HyperWorks Record and Playback
    Record playback workflows in HyperView.
- HyperWorks Report
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script Exchange
  The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.

View All Altair HyperWorks Help

HyperWorks Desktop

2021

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following HyperWorks Desktop applications.
HyperView
poILegend Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

poILegend Class

Note: See the Edit Legend topic in the HyperView User's Guide for additional information.

poILegend GetBoundingBox
Gets the bounding box of the legend.
poILegend GetCategoryLabel
Gets the category legend label.
poILegend GetCategoryLayerList
Gets the contributing category layer name list for a Max/Min/Extreme layer contour.
poILegend GetCategoryList
Gets the contributing category label list for Category Legend plots.
poILegend GetCloneHandle
Gets a handle to a cloned copy of this legend.
poILegend GetColor
Gets the color at the given level index.
poILegend GetDefaultScript
Gets the default script file path.
poILegend GetDefaultState
Gets the default legend state.
poILegend GetDiscreteColorMode
Gets the discrete coloring mode of the legend.
poILegend GetFilter
Gets the legend style.
poILegend GetFilterList
Gets a valid numeric legend filter list.
poILegend GetFooter
Gets the footer text.
poILegend GetFooterAttributeHandle
Gets the text attribute handle for the footer text.
poILegend GetHeader
Gets the header text.
poILegend GetHeaderAttributeHandle
Gets a font handle for the header font.
poILegend GetHeight
Gets the height of the legend bounding box.
poILegend GetMax
Gets the maximum result value.
poILegend GetMaxByModel
Gets the legend maximum for a given model ID.
poILegend GetMaximumLevelForCategory
Gets the maximum number of levels allowed in the Category Legend for a Max/Min/Extreme layer contour.
poILegend GetMin
Gets the minimum result value.
poILegend GetMinByModel
Gets the legend minimum for a given model ID.
poILegend GetMinMaxVisibility
Gets the maximum and minimum legend visibility state.
poILegend GetNumberAttributeHandle
Gets the text attribute handle for the legend numbers.
poILegend GetNumberOfColors
Gets the number of color levels.
poILegend GetNumericFormat
Gets the format string used by the legend.
poILegend SetNumericPrecision
Sets the precision for numbers.
poILegend SetPosition
Sets the location of the legend.
poILegend SetReverseEnable
Enables/disables the reverse state of the legend.
poILegend SetShowCategoryID
Sets the state of the Show Category ID option for the Category Legend.
poILegend SetStyle
Sets the legend style.
poILegend SetType
Sets the legend type.
poILegend SetVisibility
Sets the legend visibility.
poILegend SyncWithClone
Applies the settings for the cloned legend to the original legend.
poILegend UnOverrideValue
Removes the override value for the given color level.

(c) 2021. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support