getMatlabProperty: Accessors for Matlab Graphics Handle properties

Description Usage Arguments Value Author(s) References See Also

Description

These functions provide vectorized accessors to get and set properties associated with Matlab graphics handle objects. These can only be called if we are interfacing to Matlab using the MEX interface, i.e. when R has originally been called from a top-level Matlab session. This does not work with the Engine interface (see .MatlabInit).

These are vectorized functions in that one can access multiple properties in a single call using a character vector containing the names and a list for specifying the values.

One can obtain the graphical handle object via a call to an appropriate Matlab function, e.g gcf, gco

Usage

1
2
getMatlabGraphicsProperty(property, handle)
setMatlabGraphicsProperty(value, property, handle)

Arguments

property

a character vector giving the names of the properties.

value

a list containing the values to be used for the associated properties. It is good practice to omit the property argument and explicitly use the property names as the names of the elements of the list.

handle

the Matlab graphics handle object in which we access the properties.

Value

getMatlabGraphicsProperty returns a named list giving the current values for the specified properties.

setMatlabGraphicsProperty returns a logical vector indicating the elements for which setting the property was successful.

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

References

Matlab External Interface Guide, the Engine API. Matlab User's Guide

See Also

.MatlabMexCall


omegahat/RMatlab documentation built on May 24, 2019, 1:54 p.m.