API, Reference Guides

2023.1

Home
API, Reference Guides
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.
Tcl/Tk Commands
The application's 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 Altair HyperWorks applications.
HyperGraph 3D
plt3DILegend Class
plt3DILegend GetType
Gets the legend type.

What's New
Get Started
Tutorials
API, Reference Guides

2023.1

API, Reference Guides

What's New
View new features for version 2023.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
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.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- 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.
- Python API
  The Python API documentation for HyperView and HyperGraph.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    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.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, 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 Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
    - HyperGraph 2D
    - HyperGraph 3D
      - plt3DIAxis Class
      - plt3DIBarChart Class
      - plt3DIChart Class
      - plt3DICursor Class
      - plt3DICurve Class
      - plt3DICurveGroup Class
      - plt3DILegend Class
        
        plt3DILegend GetCloneHandle
        Gets a handle to a cloned copy of this legend.
        
        plt3DILegend GetColor
        Returns the color at the given level index.
        
        plt3DILegend GetDefaultScript
        Gets the default script file path.
        
        plt3DILegend GetDefaultState
        Gets the default legend state.
        
        plt3DILegend GetFilter
        Finds the legend style.
        
        plt3DILegend GetFooterAttributeHandle
        Gets the text attribute handle for the footer text.
        
        plt3DILegend GetHeader
        Gets the header text.
        
        plt3DILegend GetHeaderAttributeHandle
        Gets a font handle for the header font.
        
        plt3DILegend GetHighlighted
        Gets whether the legend is highlighted.
        
        plt3DILegend GetMax
        Gets the maximum result value.
        
        plt3DILegend GetMetaData
        Gets a named meta-data value previously associated with the legend.
        
        plt3DILegend GetMin
        Gets the minimum result value.
        
        plt3DILegend GetMinMaxVisibility
        Gets the maximum and minimum legend visibility state.
        
        plt3DILegend GetNumberAttributeHandle
        Gets the text attribute handle for the legend numbers.
        
        plt3DILegend GetNumberOfColors
        Gets the number of color levels.
        
        plt3DILegend GetNumericPrecision
        Gets the precision used by the legend.
        
        plt3DILegend GetPosition
        Gets the position of the legend.
        
        plt3DILegend GetReverseEnable
        Enables/disables the reverse state of the legend.
        
        plt3DILegend GetTitle
        Gets the legend title.
        
        plt3DILegend GetTitleAttributeHandle
        Gets the text attribute handle for the legend title.
        
        plt3DILegend GetType
        Gets the legend type.
        
        plt3DILegend GetValue
        Gets the value at the given level index.
        
        plt3DILegend GetVisibility
        Gets the legend visibility.
        
        plt3DILegend InterpolateColors
        Interpolates the legend colors.
        
        plt3DILegend IsValueOverriden
        Gets the override state of the given color level.
        
        plt3DILegend OverrideValue
        Sets a user-defined value for the given color level.
        
        plt3DILegend Recalculate
        Recalculates the legend min and max from plot data.
        
        plt3DILegend ReleaseClone
        Releases the handle to all clones copies of the legend.
        
        plt3DILegend Reset
        Resets the colors and number format to the default values.
        
        plt3DILegend SetColor
        Sets the color of the level.
        
        plt3DILegend SetDefaultState
        Sets the default state of the legend.
        
        plt3DILegend SetFilter
        Sets the legend style.
        
        plt3DILegend SetFooter
        Sets the legend footer text.
        
        plt3DILegend SetHeader
        Sets the legend header text.
        
        plt3DILegend SetHighlighted
        Sets whether the legend is highlighted.
        
        plt3DILegend SetMax
        Sets the maximum value.
        
        plt3DILegend SetMetaData
        Associates a named meta-data value with the legend.
        
        plt3DILegend SetMin
        Sets the minimum value.
        
        plt3DILegend SetMinMaxVisibility
        Enables/disables the display of the max and min values with the legend.
        
        plt3DILegend SetNumberOfColors
        Sets the number of legend color levels.
        
        plt3DILegend SetNumericFormat
        Sets the format for numbers.
        
        plt3DILegend SetNumericPrecision
        Sets the precision for numbers.
        
        plt3DILegend SetPosition
        Sets the location of the legend.
        
        plt3DILegend SetReverseEnable
        Enables/disables the reverse state of the legend.
        
        plt3DILegend SetTitle
        Sets the legend title.
        
        plt3DILegend SetType
        Sets the legend type.
        
        plt3DILegend SetVisibility
        Sets the legend visibility.
        
        plt3DILegend SyncWithClone
        Applies the settings for the cloned legend to the original legend.
        
        plt3DILegend UnOverrideValue
        Removes the override value for the given color level.
      - plt3DINote Class
      - plt3DIParametric Class
      - plt3DIPlane Class
      - plt3DIPlot Class
      - plt3DISurface Class
      - plt3DIWaterfall Class
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- 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.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  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

API, Reference Guides

2023.1

Home
API, Reference Guides
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.
Tcl/Tk Commands
The application's 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 Altair HyperWorks applications.
HyperGraph 3D
plt3DILegend Class
plt3DILegend GetType
Gets the legend type.

What's New
Get Started
Tutorials
API, Reference Guides

plt3DILegend GetType

Gets the legend type.

Syntax

plt3DILegend_handle GetType

Application

Tcl Query

Description

Gets the legend type.

Errors

None.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent