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.
HWC Console
Record playback workflows in the application.
HWC Commands
xy
Perform actions on XY plot files.
note
Copy, create, cut, delete, edit, and paste notes, either defined by a range or the marked entity.

Welcome
What's New
View new features for version 2025.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.
- 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.
  - Introduction
  - Work with the HWC Console
  - Interactive Help/Intellisense
  - HWC Console Command Syntax
  - Record Views
  - Command Files
  - Execute HWC Files
  - HWC and Tcl
  - Error Messages
  - HWC Commands
    - animate
      Animation controls.
    - annotation
      Annotation controls.
    - attribute
      Set entity attributes.
    - color
      Set the entity's color.
    - config
      Configuration options.
    - delete
      Delete content from the application.
    - explode
      Explode a model or selected components for improved visualization.
    - hide
      Hides all or a subset of entity types in the model.
    - hwd
      HyperWorks Desktop commands.
    - kpi hotspot
      Hotspot finder commands.
    - mark
      Marks entities on the active model.
    - open
      Open files.
    - report
      Report commands.
    - result - HyperView - MultiCore
      Result loading.
    - result
      Result loading.
    - save
      Save session content.
    - scale
      Specify parameters for deformation display.
    - section
      Section cut.
    - show
      Shows all or a subset of entity types in the model.
    - sset
      Modify entities in a selection set.
    - system
      Define a coordinate system.
    - tracking system
      Tracking system commands.
    - tracing
      Use tracing commands to trace system, component, and node entities during animation.
    - view
      View manipulation.
    - xy
      Perform actions on XY plot files.
      - axishorizontal
        Copy, create, cut, delete, edit, and paste an axis, either defined by a range or the marked entity.
      - axisvertical
        Copy, create, cut, delete, edit, and paste an axis, either defined by a range or the marked entity.
      - curve
        Copy, create, cut, delete, edit, paste, and perform stackmath operations on curves, either defined by a range or the marked curve(s).
      - datumhorizontal
        Copy, create, cut, delete, edit, and paste datum lines, either defined by a range or the marked entity.
      - datumvertical
        Copy, create, cut, delete, edit, and paste datum lines, either defined by a range or the marked entity.
      - footer
        Edit footer properties, either defined by a range or the marked entity.
      - header
        Edit header properties, either defined by a range or the marked entity.
      - legend
        Edit legend properties, either defined by a range or the marked entity.
      - load
        Load an xy file to plot.
      - mark
        Add, clear, create, delete and edit marks for a curve(s).
      - note
        Copy, create, cut, delete, edit, and paste notes, either defined by a range or the marked entity.
      - option
        Define the layout and appearance of the plot.
      - plot
        Edit plot attributes found in the Plot Browser and modify plot views.
      - select
        Select a file set or subset.
- 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.

View All Altair HyperWorks Help

xy note

Copy, create, cut, delete, edit, and paste notes, either defined by a range or the marked entity.

Syntax

xy note copy <mark|marked|range>

xy note create <mark|marked|range>

xy note cut <mark|marked|range>

xy note delete <mark|marked|range>

xy note edit <mark|marked|range>

xy note paste <mark|marked|range>

Arguments

copy

Copies the selected entity.

mark: mark=<marklabel>
marked: <true/false>.; True applies the action to the marked entity.
range: Define the range for the entity you want to apply the action to.

create

Create a datum.

mark: mark=<marklabel>
marked: <true/false>.; True applies the action to the marked entity.
range: Define the range for the entity you want to apply the action to.

cut

Removes the selected entity from the Plot Browser and deletes it from the current session.

mark: mark=<marklabel>
marked: <true/false>.; True applies the action to the marked entity.
range: Define the range for the entity you want to apply the action to.

delete

Deleted the selected entity.

mark: mark=<marklabel>
marked: <true/false>.; True applies the action to the marked entity.
range: Define the range for the entity you want to apply the action to.

edit

Edit the selected entity's properties.

mark: mark=<marklabel>
marked: <true/false>.; True applies the action to the marked entity.
range: Define the range for the entity you want to apply the action to.

Editable properties include:

alignment=<alignment>
attachmentcurve=<curveindex>
attachmentpoint=<index>
attachmentxcoordinate=<coordinate>
attachmentycoordinate=<coordinate>
attachto=<window/curve/view/coordinates>
attachtowindowposition=<position>
attachtowindowuserx=<value>
attachtowindowusery=<value>
autoposition=<true/false>
autopositionoffset=<offset>
autopositionstrategy=<strategy>
bgfillcolor=<color>
bordercolor=<color>
borderthickness=<thickness>
curvecolor=<true/false>
font=<font>
fontsize=<fontsize>
format=<format>
formatscalarvalues=<true/false>
minimized=<true/false>
name=<name>
precision=<precision>
text=<text>
textcolor=<color>
visibiltiy=<true/false>

paste

Pastes the selected entity into a window.

mark: mark=<marklabel>
marked: <true/false>.; True applies the action to the marked entity.
range: Define the window range for the entity you want to apply the action to.

Examples

Edit note properties:

xy note edit range="p:all w:all i:all" bordercolor=2

xy note edit range="p:all w:all i:all" attachto=window