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.
TableView
tblITableEditor Class
tblITableEditor InsertColumnAfter

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
    - MediaView
    - TextView
    - HgTrans
    - TableView
      - tblIRule Class
      - tblITableEditor Class
        
        tblITableEditor AddRule
        Adds a rule having empty or default properties and returns the corresponding rule ID.
        
        tblITableEditor AutofitColumnWidth
        Sets the width of the column based on the column's largest cell width.
        
        tblITableEditor ClearAllRules
        Delete all rules present in the Table Client.
        
        tblITableEditor ClearDataOnCellList
        Clears any string or expression present in the specified cells.
        
        tblITableEditor ClearPropertyOnCellList
        Clears all properties (font, text color, background color or alignment) present in the specified cells.
        
        tblITableEditor DeleteRule
        Deletes the rule having a rule ID as an identifier.
        
        tblITableEditor Draw
        Redraws the table editor.
        
        tblITableEditor ExportCSV
        Exports the table in the CSV format.
        
        tblITableEditor GetCellAlignment
        Returns the text alignment of the queried cell.
        
        tblITableEditor GetCellBackgroundColor
        Returns the background color of the queried cell.
        
        tblITableEditor GetCellData
        Returns the string or expression present in the queried cell.
        
        tblITableEditor GetCellFontInfo
        Returns the font information present in the queried cell.
        
        tblITableEditor GetCellsHavingData
        Returns a string containing a list of cell names that have been assigned with a string or an expression.
        
        tblITableEditor GetCellsHavingDisplayablePropertyForPublish
        Returns a string containing a list of cell names that have been assigned with a property (font, text color, background color or alignment).
        
        tblITableEditor GetCellsHavingProperty
        Returns a string containing a list of cell names that have been assigned with a property (font, text color, background color or alignment).
        
        tblITableEditor GetCellsParticipatingInRules
        Returns a string containing a list of cell names that have been assigned with a rule.
        
        tblITableEditor GetCellTextColor
        Returns the Text Color of the queried cell.
        
        tblITableEditor GetCellTextColorById
        Returns the Text Color of the queried cell.
        
        tblITableEditor GetCellValue
        Returns the string or evaluated expression present in the queried cell.
        
        tblITableEditor GetColumnIndex
        Returns the index of a column.
        
        tblITableEditor GetColumnName
        Returns the name of a column.
        
        tblITableEditor GetData
        Returns value of a table cell.
        
        tblITableEditor GetFilledLowerRightCell
        Returns bottom right cell name.
        
        tblITableEditor GetFilledTableDetails
        Returns information about the table cells which are not empty.
        
        tblITableEditor GetFilledTableSize
        Returns a list of filled rows and columns.
        
        tblITableEditor GetFilledTableSizeColumns
        Returns the number of filled columns.
        
        tblITableEditor GetFilledTableSizeRows
        Returns the number of filled rows.
        
        tblITableEditor GetFilledUpperLeftCell
        Returns top left cell name.
        
        tblITableEditor GetHeaderVisibility
        Gets the visibility status of the header area of the table.
        
        tblITableEditor GetNumberOfColumns
        Returns the number of columns in the table.
        
        tblITableEditor GetNumberOfRows
        Returns the number of rows in the table.
        
        tblITableEditor GetRuleHandle
        Retrieves a tblIRule command object corresponding to the rule ID queried.
        
        tblITableEditor GetRuleIds
        Returns a list of all rule IDs present in the table client.
        
        tblITableEditor GetRuleIdsActingOnCell
        Returns a string containing a list of all the rule IDs acting on the queried cell.
        
        tblITableEditor ImportCSV
        Imports the CSV file into TableView.
        
        tblITableEditor InsertColumnAfter
        
        tblITableEditor SetCellAlignment
        Sets the text alignment on the selected cell.
        
        tblITableEditor SetCellBackgroundColor
        Sets the background color on the selected cell.
        
        tblITableEditor SetCellColumnSpan
        Merges cells over columns.
        
        tblITableEditor SetCellData
        Sets a string or expression on the selected cell.
        
        tblITableEditor SetCellFontInfo
        Sets the font information on the selected cell.
        
        tblITableEditor SetCellTextColor
        Sets the text color on the selected cell.
        
        tblITableEditor SetData
        Sets the value of a table cell.
        
        tblITableEditor SetHeaderVisibility
        Show/hides the header area of the table.
    - 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.
TableView
tblITableEditor Class
tblITableEditor InsertColumnAfter

What's New
Get Started
Tutorials
API, Reference Guides

tblITableEditor InsertColumnAfter

Syntax

tblITableEditor_handle InsertColumnAfter

Application

Tcl Query

Description

Inputs

Example

Errors

None.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent