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.
HyperView
poINote Class
poINote GetBackgroundColorMode
Gets the color mode for the background fill of the note.

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
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
      - poIFLDCtrl Class
      - poIGraphicMaterial Class
      - poIImagePlaneCtrl Class
      - poIImagePlane Class
      - poIIsoValueCtrl Class
      - poILayerFilter Class
      - poILegend Class
      - poIMeasure Class
      - poIModel Class
      - poINote Class
        poINote GetAlignment
        Gets the note text alignment.
        poINote GetAttachment
        Gets the note attachment method.
        poINote GetAttachmentTypeList
        Gets the list of entity types to which a note can be attached.
        poINote GetAutoHide
        Gets the note auto-hide status. Auto-hidden notes will not display if the attachment point is occluded.
        poINote GetBackgroundColor
        Gets the background/fill color of the note.
        poINote GetBackgroundColorMode
        Gets the color mode for the background fill of the note.
        poINote GetBorderThickness
        Gets the text border thickness.
        poINote GetBoundingBox
        Gets the bounding box of the note.
        poINote GetColor
        Gets the note text color index.
        poINote GetColorMode
        Gets the color mode for the border of the note.
        poINote GetExpandedText
        Gets the expanded/evaluated version of the text for a note, if it contains any Templex statements.
        poINote GetFieldList
        Gets the list of valid field names for a note.
        poINote GetFont
        Gets the font name being used to draw the note in the graphics area.
        poINote GetFontHandle
        Gets a handle to an hwIFont interface for the font of the note.
        poINote GetHeight
        Gets the height of the bounding box of the note.
        poINote GetLabel
        Gets the label of the note.
        poINote GetLineToEntity
        Gets the style of the hidden part of the line connecting the note to the entity.
        poINote GetName
        Gets the name of the note.
        poINote GetPosition
        Gets the note position.
        poINote GetPositionToAttachment
        Gets whether or not the note is positioned at the attachment location.
        poINote GetPositionType
        Gets the position type of the note.
        poINote GetRotationAngle
        Gets the rotation angle of the note.
        poINote GetScreenAnchor
        Gets whether or not the note is anchored.
        poINote GetShape
        Gets the current shape of the note.
        poINote GetText
        Gets the note text.
        poINote GetTextColorMode
        Gets the color mode for the text of the note.
        poINote GetTransparency
        Gets the transparency attribute value (true/false).
        poINote GetVisibility
        Gets the note visibility.
        poINote GetWidth
        Gets the width of the bounding box of the note.
        poINote SetAlignment
        Sets the text alignment for the note.
        poINote SetAttachment
        Sets the note attachment method.
        poINote SetAutoHide
        Sets the note auto-hide attribute.
        poINote SetBackgroundColor
        Sets the background/fill color for the note.
        poINote SetBackgroundColorMode
        Sets the color mode for the background fill of the note.
        poINote SetBorderThickness
        Sets the note border thickness.
        poINote SetBorderThickness
        Sets the note border thickness.
        poINote SetColor
        Sets the note border and leader line color.
        poINote SetColorMode
        Sets the color mode for the border of the note.
        poINote SetFont
        Sets the font by name.
        poINote SetLabel
        Sets the note label.
        poINote SetLineToEntity
        Sets the style of the hidden part of the line connecting the note to the entity.
        poINote SetName
        Sets the note label.
        poINote SetPosition
        Sets the note position.
        poINote SetPositionToAttachment
        Controls the leader length of the note.
        poINote SetPositionType
        Sets the position type of the note.
        poINote SetRotationAngle
        Sets the rotation angle of the note.
        poINote SetScreenAnchor
        Anchors the note at its current position.
        poINote SetShape
        Sets the current shape of the note.
        poINote SetText
        Sets the note text.
        poINote SetTextColor
        Sets the note border and leader line color.
        poINote SetTextColorMode
        Sets the color mode for the text of the note.
        poINote SetTransparency
        Sets the transparency attribute value (true/false).
        poINote SetVisibility
        Sets the note visibility.
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
      - poIPostManager Class
      - poIQueryCtrl Class
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
      - poISweepCtrl Class
      - poISymmetry Class
      - poISystem Class
      - poISystemCtrl Class
      - poITensorCtrl Class
      - poITensorDefine Class
      - poITextAttribute Class
      - poITracingCtrl Class
      - poITrackingSystem Class
      - poIVectorCtrl Class
      - poIVectorDefine Class
    - HyperGraph 2D
    - 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.

poINote GetBackgroundColorMode

Gets the color mode for the background fill of the note.

Syntax

poINote_handle GetBackgroundColorMode

Application

HyperView Tcl Query

Description

This command returns the color mode for the background fill of the note.

Errors

Returns 0 if successful, otherwise an error code.