Home
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Reference Guide for OpenMatrix Language Functions
The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
Plotting Commands
gca
Returns a handle to the current axes object.

What's New
Get Started
Tutorials
Model Components
Physical Component Modeling
Hydraulic System Modeling
Electrical System Modeling
Multibody Mechanical System Modeling
Electromagnetic System Modeling
Simulation Basics
Simulation Results
Block Libraries
Reference Guides
Keyboard Shortcuts

What's New
Discover new features and enhancements.
Get Started
New to Activate? Learn the basics here.
Tutorials
Start using Activate with our interactive tutorials.
Model Components
Learn about the components in Activate models.
Physical Component Modeling
Learn about modeling physical components.
Hydraulic System Modeling
Learn about modeling hydraulic systems with the Hydraulics (By Fluidon) library.
Electrical System Modeling
Learn about modeling electrical and electronic systems with Modelica and Spice.
Multibody Mechanical System Modeling
Learn about modeling multibody dynamic systems.
Electromagnetic System Modeling
Learn about modeling electromagnetic systems.
Simulation Basics
Learn how to set up, run, and troubleshoot simulations.
Simulation Results
Discover options to review, display, and export results.
Block Libraries
Learn about block libraries for building dynamic system models.
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
- Extended Definitions for Advanced Users
  PDF file with in-depth information on key topics in the User's Guide.
- Scripting Guide for OpenMatrix Language
  OpenMatrix is a mathematical scripting language.
- Reference Guide for OpenMatrix Language Functions
  The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
  - ABF Commands
  - CAE Commands
  - Calculus Commands
  - Control System Commands
  - Core Minimal Interpreter Commands
  - Data Structure Commands
  - Differential Equations Commands
  - Elementary Math Commands
  - File I/O Commands
  - Geometry Commands
  - GUI Commands
  - HDF5 Reader Commands
  - HDF5 Writer Commands
  - Image Commands
  - Linear Algebra Commands
  - Logical Commands
  - Omlh3d Commands
  - Optimization Commands
  - Plotting Commands
    - area
      Creates stacked areas in an axes and returns handles of the areas.
    - axes
      Create a new axes or set current axes by passing a handle argument.
    - axis
      Sets the scaling and range of x, y, and z axes (x by default). Called without arguments, axis turns autoscaling on.
    - bar
      Creates bars in an axis and returns handles of the bars.
    - bar3
      Creates 3d bars on an axis and returns the handles of the bars.
    - box
      Turn on/off the border of a 2D plot.
    - cla
      Clears the current axes or axes specified by handle.
    - clf
      Clears the current figure or figure specified by handle.
    - close
      Close the current, or a specific, or all figure window.
    - colormap
      Gets or sets the colormap of a figure or axes.
    - colorbar
      Turns the axes colorbar on/off. Get and set the colorbar's minimum and maximum values.
    - contour
      Creates a 2D contoured surface in an axes.
    - contour3
      Creates 3D contoured surface in an axes.
    - delete
      Deletes the file(s), f, or a graphic object, h.
    - dock
      Docks a floating figure in the main window.
    - drawnow
      Forces an update of the current axes.
    - ellipse
      Creates an elliptical shape on the figure.
    - fanplot
      Creates a surface and a set of 3D lines defined by the x, y, and z matrices.
    - figure
      Creates a new figure for plotting.
    - findobj
      Finds all objects which have a property named propertyName and the value for such property is propertyValue.
    - fill
      Creates 2D filled in polygons of range x and y and color c.
    - gca
      Returns a handle to the current axes object.
    - gcf
      Returns a handle to the current figure.
    - get
      Returns the value of the named property p from the graphics handle, h. If property name is omitted, all properties of h will be returned.
    - getmousepos
      Returns the mouse position in the figure area.
    - Graphics Object Properties
      Properties for the graphics object in OML.
    - grid
      Turn on/off grid lines in a plot. Toggle the states if no argument is used.
    - hist
      Creates a histogram in an axis.
    - hold
      Turn on/off the "hold" state of axes. Toggle the states if no argument is used. When the "hold" state is on, new plotting data will be added into current axes.
    - isaxes
      Returns true if x is an axis handle; returns false if otherwise.
    - isfigure
      Returns true if x is a figure graphics handle; returns false if otherwise.
    - ishandle
      Returns true if x is a graphics handle; returns false if otherwise.
    - ishold
      Returns true if the next plot will be added to the current one; returns false if otherwise.
    - legend
      Update axes' legend text, turn on/off the legend of axes. Toggle the states if no argument is used.
    - line
      Add a curve in current axes or a specified axes.
    - loglog
      Plots a given dataset in 2D axes with logarithmic scales for x and y axes.
    - mesh
      Creates mesh in an axes and returns handles of the mesh.
    - meshgrid
      Construct a grid of points from coordinate vectors.
    - patch
      Creates 2D or 3D patches in an axis.
    - pcolor
      Display a matrix as a heat map. The values of input matrix z are mapped to the colors of the colormap.
    - plot
      Plots a given dataset in 2D axes.
    - plot3
      Creates 3D lines in an axes and returns handles of the lines.
    - plotyy
      Plots given datasets in independent y-axes and a common x-axis.
    - polar
      Creates a line plot in polar coordinates.
    - rectangle
      Creates a rectangular shape on a figure.
    - saveas
      Save a figure to a specific file.
    - scatter
      Creates dots in an axes and returns handles of the dots.
    - scatter3
      Creates 3D dots in an axes and returns handles of the dots.
    - semilogx
      Plots a given dataset in 2D axes with logarithmic scales for x axis.
    - semilogy
      Plots a given dataset in 2D axes with logarithmic scales for y axis.
    - set
      Sets property values for graphics handles.
    - stem
      Creates a stem plot in an axis and returns the stem handles.
    - subplot
      Sets up a plot grid with rows by cols subwindows and sets the current axes for plotting to the location given by index.
    - surf
      Creates surfaces in an axes and returns handles of the surfaces.
    - text
      Creates a textbox at coordinate x,y with text 't'.
    - title
      Sets the title of the plot.
    - uibuttongroup
      Creates a button group in a figure to group radio buttons.
    - uicontextmenu
      Creates a context menu which is displayed with a right-mouse click for a figure, uitab, or select uicontrol objects.
    - uicontextmenuitem
      Creates a menu item in a context menu which is displayed with a right-mouse click for a figure, uitab, or select uicontrol objects.
    - uicontrol
      Creates interactive graphical control objects in a figure. Use the 'style' property of uicontrol to create different types of control objects.
    - uipanel
      Creates a frame for interactive graphical control objects in a figure.
    - uiresume
      Resumes execution of code, stopping uiwait on the given handle, handle, or stopping all uiwait commands in the current session.
    - uitab
      Creates a tab in a tabbed frame for interactive graphical control objects in a figure.
    - uitabgroup
      Creates a tabbed frame for interactive graphical control objects in a figure.
    - uitable
      Creates a table in a figure.
    - uiwait
      Pauses the execution of code until the given handle, handle, is deleted, and the timeout, waittime, is reached.
    - undock
      Undocks a figure, making it float over the main window.
    - view
      Sets the viewpoint for the current axes.
    - waterfall
      Creates waterfall meshes in an axes and returns handles of the meshes.
    - xlabel
      Annotates the x-axis.
    - xlim
      Set and query range of x axis.
    - ylabel
      Annotates the y-axis.
    - ylim
      Set and query range of y axis.
    - zlabel
      Annotates the z-axis.
    - zlim
      Set and query range of z axis.
  - Polynomial Math Commands
  - Signal Processing Commands
  - Statistical Analysis Commands
  - String Operations Commands
  - System Commands
  - Time Commands
  - Trigonometry Commands
  - OML to Python Bridge Commands
  - Python to OML Bridge Commands
- Block Reference Guide
  Describes all of the blocks in the installed Activate library.
- Glossary
  Key terms associated with the software.
Keyboard Shortcuts
Define shortcuts to common operations.

Home
Reference Guides
Explore the Extended Definitions, OML Guides, Block Library, API Guide and Glossary.
Reference Guide for OpenMatrix Language Functions
The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
Plotting Commands
gca
Returns a handle to the current axes object.

What's New
Get Started
Tutorials
Model Components
Physical Component Modeling
Hydraulic System Modeling
Electrical System Modeling
Multibody Mechanical System Modeling
Electromagnetic System Modeling
Simulation Basics
Simulation Results
Block Libraries
Reference Guides
Keyboard Shortcuts

gca

Returns a handle to the current axes object.

Outputs

R: Handle of the current axes object.

Example

Simple gca example.

R = gca()

R = 14.2513151

See Also

Graphics Object Properties

(c) Altair Engineering, Inc. All rights reserved.

Intellectual Property Rights Notice | Technical Support