plt3DILegend GetValue
Gets the value at the given level index.
Syntax
plt3DILegend_handle GetValue index
Application
Tcl Query
Description
Returns the result value.
Inputs
- index
- The color level index.
Errors
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 a handle to a cloned copy of this legend.
Returns the color at the given level index.
Gets the default script file path.
Gets the default legend state.
Finds the legend style.
Gets the text attribute handle for the footer text.
Gets the header text.
Gets a font handle for the header font.
Gets whether the legend is highlighted.
Gets the maximum result value.
Gets a named meta-data value previously associated with the legend.
Gets the minimum result value.
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 precision used by the legend.
Gets the position of the legend.
Enables/disables the reverse state of the legend.
Gets the legend title.
Gets the text attribute handle for the legend title.
Gets the legend type.
Gets the value at the given level index.
Gets the legend visibility.
Interpolates the legend colors.
Gets the override state of the given color level.
Sets a user-defined value for the given color level.
Recalculates the legend min and max from plot data.
Releases the handle to all clones copies of the legend.
Resets the colors and number format to the default values.
Sets the color of the level.
Sets the default state of the legend.
Sets the legend style.
Sets the legend footer text.
Sets the legend header text.
Sets whether the legend is highlighted.
Sets the maximum value.
Associates a named meta-data value with the legend.
Sets the minimum value.
Enables/disables the display of the max and min values with the legend.
Sets the number of legend color levels.
Sets the format for numbers.
Sets the precision for numbers.
Sets the location of the legend.
Enables/disables the reverse state of the legend.
Sets the legend title.
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 value at the given level index.
Gets the value at the given level index.
plt3DILegend_handle GetValue index
Tcl Query
Returns the result value.
None.
© 2023 Altair Engineering, Inc. All Rights Reserved.
Intellectual Property Rights Notice | Technical Support | Cookie Consent