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
plt3DIAxis Class
plt3DIAxis SetMetaData
Associates a named meta-data value with the axis.

Welcome
What's New
View new features for version 2024.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 HyperMesh applications.
- 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
        plt3DIAxis GetAutoFit
        Determines if autofit is applied to the axis.
        plt3DIAxis GetColor
        Gets the color of the axis.
        plt3DIAxis GetIncrement
        Gets the spacing between tics for the axis.
        plt3DIAxis GetLabel
        Gets the label (displayed text) of the axis.
        plt3DIAxis GetMax
        Gets the maximum value for the axis.
        plt3DIAxis GetLabelFontHandle
        Gets a handle to an hwIFont interface for the label font of the axis.
        plt3DIAxis GetMetaData
        Gets a named meta-data value previously associated with the axis.
        plt3DIAxis GetMin
        Gets the minimum value for the axis.
        plt3DIAxis GetName
        Gets the title of the axis.
        plt3DIAxis GetNumberOfGrids
        Gets the number of grids between tics on the axis.
        plt3DIAxis GetNumberOfTics
        Gets the number of tics for the axis.
        plt3DIAxis GetNumericFormat
        Gets the format used for displaying tics on the axis.
        plt3DIAxis GetNumericPrecision
        Gets the number of decimal places displayed for tics on the axis.
        plt3DIAxis GetScale
        Gets the scale type for the axis.
        plt3DIAxis GetTicMethod
        Gets the method used for placing tics on the axis.
        plt3DIAxis GetTicsFontHandle
        Gets a handle to an hwIFont interface for the tics font of the axis.
        plt3DIAxis GetVisibility
        Gets if the axis is displayed or hidden.
        plt3DIAxis SetAutoFit
        Sets whether autofit is applied to the axis.
        plt3DIAxis SetColor
        Sets the text color of the axis.
        plt3DIAxis SetIncrement
        Sets the spacing between tics for the axis.
        plt3DIAxis SetLabel
        Sets the label (displayed text) of the axis.
        plt3DIAxis SetMax
        Sets the maximum value for the axis.
        plt3DIAxis SetMetaData
        Associates a named meta-data value with the axis.
        plt3DIAxis SetMin
        Sets the minimum value for the axis.
        plt3DIAxis SetName
        Sets the title of the axis.
        plt3DIAxis SetNumberOfGrids
        Sets the number of grids between tics on the axis.
        plt3DIAxis SetNumberOfTics
        Sets the number of tics for the axis.
        plt3DIAxis SetNumericFormat
        Sets the format used for displaying tics on the axis.
        plt3DIAxis SetNumericPrecision
        Sets the number of decimal places displayed for tics on the axis.
        plt3DIAxis SetScale
        Sets the scale type for the axis.
        plt3DIAxis SetTicMethod
        Sets the method used for placing tics on the axis.
        plt3DIAxis SetVisibility
        Sets whether the axis is displayed or hidden.
      - plt3DIBarChart Class
      - plt3DIChart Class
      - plt3DICursor Class
      - plt3DICurve Class
      - plt3DICurveGroup Class
      - plt3DILegend Class
      - 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
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- 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.

plt3DIAxis SetMetaData

Associates a named meta-data value with the axis.

Syntax

plt3DIAxis_handle SetMetaData name value

Application

Tcl Modify

Description

Metadata can be any string or string representation of a number.

Inputs

name: The name of the value.
value: The value.

Example

To set and get a meta-data value from a 3D axis:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetAxisHandle myAxisName x
myAxisName SetMetaData species dog
myAxisName GetMetaData species

Errors

None.