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
pltIBuildPlotsCtrl Class
pltIBuildPlotsCtrl SetLegend
Sets whether the legend is on.

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
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
      - pltIBuildPlotsCtrl Class
        pltIBuildPlotsCtrl Class
        Takes information from a model and translates it to be graphed in the Build Plots panel.
        pltIBuildPlotsCtrl ClearRequestLocators
        Clears the request locators.
        pltIBuildPlotsCtrl GeneratePlots
        Draws the plots that are set in BuildPlots.
        pltIBuildPlotsCtrl GetActiveFilename
        Finds the active file’s filepath.
        pltIBuildPlotsCtrl GetActiveHashValue
        Finds the sum of the entire file by making a checksum.
        pltIBuildPlotsCtrl GetAnalysisType
        Finds the analysis type when Build Plots is in post mode.
        pltIBuildPlotsCtrl GetComponentFilter
        Finds the value in the Y Component filter.
        pltIBuildPlotsCtrl GetComponentList
        Gets one of the two component lists.
        pltIBuildPlotsCtrl GetDatatypeList
        Gets one of the two data type lists.
        pltIBuildPlotsCtrl GetFilesUsedList
        Finds all the files that have been used in build plots.
        pltIBuildPlotsCtrl GetLayerList
        Gets the layer list of the model within the file.
        pltIBuildPlotsCtrl GetLayout
        Finds the page layout number.
        pltIBuildPlotsCtrl GetLayoutOption
        Finds the current layout option.
        pltIBuildPlotsCtrl GetLegend
        Finds whether the legend is on.
        pltIBuildPlotsCtrl GetRequestFilter
        Finds the value in the Y request filter.
        pltIBuildPlotsCtrl GetRequestList
        Gets one of the two request list.
        pltIBuildPlotsCtrl GetSubcase
        Finds the current subcase.
        pltIBuildPlotsCtrl GetSubcaseList
        Finds the list of subcases.
        pltIBuildPlotsCtrl GetXDatatype
        Finds the current value for the X data type.
        pltIBuildPlotsCtrl GetYDatatype
        Finds the current value for the Y data type
        pltIBuildPlotsCtrl GetYDatatypeBinding
        Finds the request (y data type binding) based on the result type that has been set.
        pltIBuildPlotsCtrl IsPostMode
        Determines whether build plots is in post mode.
        pltIBuildPlotsCtrl SelectDataFile
        Selects a file to use in build plots mode.
        pltIBuildPlotsCtrl SelectXComponent
        Sets the value(s) for the X component.
        pltIBuildPlotsCtrl SelectXRequest
        Selects the value(s) for the X request.
        pltIBuildPlotsCtrl SelectYComponent
        Sets the value(s) for the Y component.
        pltIBuildPlotsCtrl SelectYRequests
        Sets the value(s) for the Y request.
        pltIBuildPlotsCtrl SetComponentFilter
        Sets the Y component filter.
        pltIBuildPlotsCtrl SetLayout
        Sets the layout.
        pltIBuildPlotsCtrl SetLayoutOption
        Sets the layout option.
        pltIBuildPlotsCtrl SetLegend
        Sets whether the legend is on.
        pltIBuildPlotsCtrl SetOutputWindow
        Sets the output window.
        pltIBuildPlotsCtrl SetOutputWindowMode
        Sets the chart style of the output window.
        pltIBuildPlotsCtrl SetRequestFilter
        Sets the Y request filter.
        pltIBuildPlotsCtrl SetSubcase
        Sets the subcase.
        pltIBuildPlotsCtrl SetXDatatype
        Sets the value for the X data type.
        pltIBuildPlotsCtrl SetYDatatype
        Sets the value for the Y data type.
      - 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
- 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.

pltIBuildPlotsCtrl SetLegend

Sets whether the legend is on.

Syntax

pltIBuildPlotsCtrl_handle SetLegend legend_on

Application

Tcl Modify

Description

This command sets whether the legend is on or off (visible or invisible).

Note: The command GeneratePlot must be called to draw the plot with these changes.

Inputs

legend_on

true: If you want the legend to be on (visible).
false: If you want the legend to be off (invisible).

Example

hwi GetSessionHandle sess;
sess GetClientManagerHandle mgr plot;
mgr GetBuildPlotsCtrlHandle build;
build SetLegend false;
build GeneratePlot;

Errors

Success (0) or an error message is returned.

Keywords

Tcl

Build Plots

Legend

Modify