poILegend GetFooter
Gets the footer text.
Syntax
poILegend_handle GetFooter
Application
HyperView Tcl Query
Description
This command returns the footer text.
Error
None.
View new features for version 2023.
Learn the basics and discover the workspace.
Discover product functionality with interactive tutorials.
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 are programs integrated with the application to enhance or extend the user experience.
Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
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 allows you perform a series of operations outside the program interface.
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.
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
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.
Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
Examples of script uses cases.
Learn more about Tcl/Tk with this basic example.
Learn more about programming with Tcl/Tk commands with this tutorial.
Tcl/Tk classes for the following Altair HyperWorks applications.
Gets the bounding box of the legend.
Gets the category legend label.
Gets the contributing category layer name list for a Max/Min/Extreme layer contour.
Gets the contributing category label list for Category Legend plots.
Gets a handle to a cloned copy of this legend.
Gets the color at the given level index.
Gets the default script file path.
Gets the default legend state.
Gets the discrete coloring mode of the legend.
Gets the legend style.
Gets a valid numeric legend filter list.
Gets the footer text.
Gets the text attribute handle for the footer text.
Gets the header text.
Gets a font handle for the header font.
Gets the height of the legend bounding box.
Gets the maximum result value.
Gets the legend maximum for a given model ID.
Gets the maximum number of levels allowed in the Category Legend for a Max/Min/Extreme layer contour.
Gets the minimum result value.
Gets the legend minimum for a given model ID.
Gets the maximum and minimum legend visibility state.
Gets the text attribute handle for the legend numbers.
Gets the number of color levels.
Gets the format string used by the legend.
Sets the precision for numbers.
Sets the location of the legend.
Enables/disables the reverse state of the legend.
Sets the state of the Show Category ID option for the Category Legend.
Sets the legend style.
Sets the legend type.
Sets the legend visibility.
Applies the settings for the cloned legend to the original legend.
Removes the override value for the given color level.
Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
XML commands in the Result Math Module.
Record playback workflows in the application.
The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.
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.
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk classes for the following Altair HyperWorks applications.
Gets the footer text.
Gets the footer text.
poILegend_handle GetFooter
HyperView Tcl Query
This command returns the footer text.
None.
© 2023 Altair Engineering, Inc. All Rights Reserved.
Intellectual Property Rights Notice | Technical Support | Cookie Consent