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
pltICurveComplex Class
pltICurveComplex SetDisplayInLegend
Sets whether or not the curve is displayed in the legend.

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
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
        pltICurveComplex AddDataAttribute
        Adds a new, empty attribute to the curve.
        pltICurveComplex Bridge
        Applies a bridge edit to the curve.
        pltICurveComplex Cut
        Applies a cut edit to the curve.
        pltICurveComplex DisplayBar
        Indicates whether to display the curve as a line or a series of bars.
        pltICurveComplex GetBarStyle
        Gets the bar style of the curve.
        pltICurveComplex GetDataAttributeHandle
        Gets a handle to a pltAttribute interface for the specified attribute.
        pltICurveComplex GetEditHandle
        Gets a handle to a pltEdit interface for the specified attribute.
        pltICurveComplex GetHighlighted
        Gets the highlight state of the curve.
        pltICurveComplex GetNumberOfEdits
        Returns the number of edits in a curve.
        pltICurveComplex GetNumberOfPoints
        Gets the number of points on the curve.
        pltICurveComplex GetVectorHandle
        Gets a handle to a pltVector interface for the specified curve.
        pltICurveComplex Hide
        Applies a hide edit to the curve.
        pltICurveComplex RemoveDataAttribute
        Removes the specified attribute from the curve.
        pltICurveComplex RemoveLastEdit
        Removes the most recently applied edit from the curve.
        pltICurveComplex Replace
        Applies a replace edit to the curve.
        pltICurveComplex SetBarStyle
        Sets the bar style of the curve.
        pltICurveComplex SetDisplayInLegend
        Sets whether or not the curve is displayed in the legend.
        pltICurveComplex SetHighlighted
        Sets the highlight state of the curve.
        pltICurveComplex SetLineColor
        Sets the line color of the curve.
        pltICurveComplex SetLineStyle
        Sets the line style of the curve.
        pltICurveComplex SetLineThickness
        Sets the line thickness of the curve.
        pltICurveComplex SetSymbolColor
        Sets the symbol color of the curve.
        pltICurveComplex SetSymbolEvery
        Sets the symbol frequency of the curve.
        pltICurveComplex SetSymbolStyle
        Sets the symbol style of the curve.
        pltICurveComplex SetVisibility
        Sets whether the curve is displayed or not.
        pltICurveComplex Trim
        Applies a trim edit to the curve.
      - 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.

pltICurveComplex SetDisplayInLegend

Sets whether or not the curve is displayed in the legend.

Syntax

pltICurveComplex_handle SetDisplayInLegend state

Application

Tcl Modify

Description

Sets whether or not the curve is displayed in the legend.

Inputs

state

True: To display the legend.
False: To hide the legend.

Errors

Returns success or an error code.