API, Reference Guides

2023

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
pltIDatum Class
pltIDatum GetName
Gets the title of the datum.

What's New
Get Started
Tutorials
API, Reference Guides

2023

API, Reference Guides

What's New
View new features for version 2023.
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.
- 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
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
        
        pltIDatum GetAssociatedAxis
        Gets the associated axis for the datum.
        
        pltIDatum GetComplexAxis
        Sets the associated complex area for the datum line. Returns the complex component axis in which the datum line is located.
        
        pltIDatum GetContextMenuParameter
        Gets the datum’s context menu parameter.
        
        pltIDatum GetFontHandle
        Gets a handle to a hwIFont interface for the font of the datum.
        
        pltIDatum GetIndex
        Gets the datum’s index.
        
        pltIDatum GetLabel
        Gets the label (displayed text) of the datum.
        
        pltIDatum GetLabelLocation
        Gets the label location of the datum.
        
        pltIDatum GetLineColor
        Gets the line color of the datum.
        
        pltIDatum GetLineStyle
        Gets the line style of the datum.
        
        pltIDatum GetLineThickness
        Gets the line thickness of the datum.
        
        pltIDatum GetName
        Gets the title of the datum.
        
        pltIDatum GetPositionExpression
        Gets the position expression of the datum.
        
        pltIDatum GetPositionValue
        Gets the value (position) of the datum.
        
        pltIDatum GetType
        Gets the datum’s type.
        
        pltIDatum GetVisibility
        Gets whether the datum is displayed or hidden.
        
        pltIDatum SetAssociatedAxis
        Sets the associated axis for the datum.
        
        pltIDatum SetComplexAxis
        Sets the associated complex area for the datum line.
        
        pltIDatum SetLabel
        Sets the label (displayed text) of the datum.
        
        pltIDatum SetLabelLocation
        Sets the label location for the datum.
        
        pltIDatum SetLineStyle
        Sets the line style of the datum.
        
        pltIDatum SetLineThickness
        Sets the line thickness of the datum.
        
        pltIDatum SetName
        Sets the title of the datum.
        
        pltIDatum SetPosition
        Sets the value (position) of the datum.
        
        pltIDatum SetVisibility
        Sets whether the datum is displayed or hidden.
      - 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

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
pltIDatum Class
pltIDatum GetName
Gets the title of the datum.

What's New
Get Started
Tutorials
API, Reference Guides

pltIDatum GetName

Gets the title of the datum.

Syntax

pltIDatum_handle GetName

Application

Tcl Query

Description

Returns the title of the datum.

Errors

None.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent