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 2D
pltIAxis Class
pltIAxis GetName
Gets the title of the axis.

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
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
        
        pltIAxis GetAxesLockOption
        Displays current state of the Axes panel's Lock option.
        
        pltIAxis GetColor
        Gets the color of the axis.
        
        pltIAxis GetdB10Reference
        Gets the dB10 reference value for the axis.
        
        pltIAxis GetdB20Reference
        Gets the dB20 reference value for the axis.
        
        pltIAxis GetDisplayValue
        Gets the display value when the real value is input.
        
        pltIAxis GetIncrement
        Gets the spacing between tics for the axis.
        
        pltIAxis GetLabel
        Gets the label (displayed text) of the axis.
        
        pltIAxis GetLabelFontHandle
        Gets a handle to an hwIFont interface for the label font of the axis.
        
        pltIAxis GetLockOption
        Display the current state of the Axes panel's Lock option for selected axis.
        
        pltIAxis GetMax
        Gets the maximum value for the axis.
        
        pltIAxis GetMin
        Gets the minimum value for the axis.
        
        pltIAxis GetName
        Gets the title of the axis.
        
        pltIAxis GetNumberOfGrids
        Gets the number of grids between tics on the axis.
        
        pltIAxis GetNumberOfTics
        Gets the number of tics for the axis.
        
        pltIAxis GetNumericFormat
        Gets the format used for displaying tics on the axis.
        
        pltIAxis GetNumericPrecision
        Gets the number of decimal places displayed for tics on the axis.
        
        pltIAxis GetRealValue
        Gets the real value when the display value is input.
        
        pltIAxis GetScale
        Gets the scale type for the axis.
        
        pltIAxis GetTicMethod
        Gets the method used for placing tics on the axis.
        
        pltIAxis GetTicsFontHandle
        Gets a handle to an hwIFont interface for the tics font of the axis.
        
        pltIAxis GetVisibility
        Gets if the axis is displayed or hidden.
        
        pltIAxis GetWeighting
        Gets the weighting type for the axis.
        
        pltIAxis SetAxesLockOption
        Sets one of the three Lock option states for the axes.
        
        pltIAxis SetColor
        Sets the text color of the axis.
        
        pltIAxis SetdB10Reference
        Sets the dB10 reference value for the axis.
        
        pltIAxis SetdB20Reference
        Sets the dB20 reference value for the axis.
        
        pltIAxis SetIncrement
        Sets the spacing between tics for the axis.
        
        pltIAxis SetLabel
        Sets the label (displayed text) of the axis.
        
        pltIAxis SetLockOption
        Sets one of the three states for the selected axis.
        
        pltIAxis SetMax
        Sets the maximum value for the axis.
        
        pltIAxis SetMin
        Sets the minimum value for the axis.
        
        pltIAxis SetName
        Sets the title of the axis.
        
        pltIAxis SetNumberOfGrids
        Sets the number of grids between tics on the axis.
        
        pltIAxis SetNumberOfTics
        Sets the number of tics for the axis.
        
        pltIAxis SetNumericFormat
        Sets the format used for displaying tics on the axis.
        
        pltIAxis SetNumericPrecision
        Sets the number of decimal places displayed for tics on the axis.
        
        pltIAxis SetScale
        Sets the scale type for the axis.
        
        pltIAxis SetTicMethod
        Sets the method used for placing tics on the axis.
        
        pltIAxis SetVisibility
        Sets whether the axis is displayed or hidden.
        
        pltIAxis SetWeighting
        Sets the weighting type for the axis.
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
      - pltIDrawControl Class
      - pltIEdit Class
      - pltIExportCtrl Class
      - pltILegend Class
      - pltIMacro Class
      - pltINote Class
      - pltIPlot Class
      - pltIPlotManager Class
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
      - pulIMacroParameter Class
    - HyperGraph 3D
    - 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 2D
pltIAxis Class
pltIAxis GetName
Gets the title of the axis.

What's New
Get Started
Tutorials
API, Reference Guides

pltIAxis GetName

Gets the title of the axis.

Syntax

pltIAxis GetName

Application

Tcl Query

Description

Returns the title of the axis.

Errors

None.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent