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.
Framework
hwIPPTPublishOption Class
hwIPPTPublishOption SetGraphicsDistanceTop
Sets the graphics area for the top offset.

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
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
        hwIPPTPublishOption GetAspectRatioString
        Returns the aspect ratio string.
        hwIPPTPublishOption GetGraphicsDistanceBottom
        Gets the graphics area bottom offset for publishing.
        hwIPPTPublishOption GetGraphicsDistanceLeft
        Gets graphics area left offset of Publishing.
        hwIPPTPublishOption GetGraphicsDistanceRight
        Gets the graphics area right offset for publishing.
        hwIPPTPublishOption GetGraphicsDistanceTop
        Gets the graphics area top offset for publishing.
        hwIPPTPublishOption GetHeaderDistanceLeft
        Gets title's left offset for publishing.
        hwIPPTPublishOption GetHeaderDistanceTop
        Gets the title's top offset for publishing.
        hwIPPTPublishOption GetMasterDimension
        Returns the master dimension.
        hwIPPTPublishOption GetOneWindowPerPage
        Returns true or false.
        hwIPPTPublishOption GetPictureHeight
        Gets the image height for publishing.
        hwIPPTPublishOption GetPictureResolution
        Gets the picture resolution for publishing.
        hwIPPTPublishOption GetPictureWidth
        Gets the image width for publishing.
        hwIPPTPublishOption GetPPTMaster
        Gets the PowerPoint file's master path.
        hwIPPTPublishOption GetPPTScaleFactor
        Returns the PowerPoint scale factor.
        hwIPPTPublishOption GetSyncTableViewColorFormatting
        Gets whether or not to sync the table color formatting.
        hwIPPTPublishOption GetTitleAttribute
        Returns the title attribute for publishing.
        hwIPPTPublishOption GetTitleFontFamily
        Gets the title font name for publishing.
        hwIPPTPublishOption GetTitleFontSize
        Gets the title font size for publishing.
        hwIPPTPublishOption GetTitleFontSlant
        Gets the title font slant for publishing.
        hwIPPTPublishOption GetTitleFontWeight
        Gets the font weight for publishing.
        hwIPPTPublishOption SetAspectRatioString
        Updates the resolution with the selected aspect ratio string.
        hwIPPTPublishOption SetGraphicsDistanceBottom
        Sets the bottom offset of the graphics area.
        hwIPPTPublishOption SetGraphicsDistanceLeft
        Sets the left offset of the graphics area.
        hwIPPTPublishOption SetGraphicsDistanceRight
        Sets the right offset of the graphics area.
        hwIPPTPublishOption SetGraphicsDistanceTop
        Sets the graphics area for the top offset.
        hwIPPTPublishOption SetHeaderDistanceLeft
        Sets the title's left offset.
        hwIPPTPublishOption SetHeaderDistanceTop
        Sets the title distance from the top.
        hwIPPTPublishOption SetMasterDimension
        Returns the master dimension.
        hwIPPTPublishOption SetOneWindowPerPage
        Allows you to set whether or not to publish one window per page.
        hwIPPTPublishOption SetPictureHeight
        Sets the graphics height.
        hwIPPTPublishOption SetPictureResolution
        Sets the picture resolution to the fixed/graphics or scaling factor option.
        hwIPPTPublishOption SetPictureWidth
        Sets the graphics width.
        hwIPPTPublishOption SetPPTMaster
        Allows you to set the PowerPoint master file's path.
        hwIPPTPublishOption SetPPTScaleFactor
        Returns the PowerPoint scale factor.
        hwIPPTPublishOption SetSyncTableViewColorFormatting
        Sets whether or not to sync color formatting.
        hwIPPTPublishOption SetTitleAttribute
        Sets the title attribute to either text or master.
        hwIPPTPublishOption SetTitleFontFamily
        Allows to set the title font to different fonts
        hwIPPTPublishOption SetTitleFontSize
        Sets the size for title font.
        hwIPPTPublishOption SetTitleFontSlant
        Sets the title font slant to slant or italics.
        hwIPPTPublishOption SetTitleFontWeight
        Sets title font weight to bold or normal.
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - 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.

hwIPPTPublishOption SetGraphicsDistanceTop

Sets the graphics area for the top offset.

Syntax

hwIPPTPublishOption_handle SetGraphicsDistanceTop p_image_top_offset

Application

Tcl Modify

Inputs

p_image_top_offset: The top offset of the graphics area to publish.

Example

Sets the graphics distance from the top to 20 and changes either the width or height, whichever is not the master dimension:

Opt SetGraphicsDistanceTop 20

Sets the graphics distance from the top to 20, but does not change the width or height:

Opt SetGraphicsDistanceTop 20 false

Error

Returns success (0) or an error code.

Keywords

Tcl

Query