The IDLgrColorbar::ComputeDimensions function method retrieves the dimensions of a colorbar object for the given destination object. In order to compute the effective dimensions, the object must be inserted into an object graphics hierarchy prior to using this method. The result is a three-element double-precision floating-point vector [xDim, yDim, zDim] representing the dimensions of the colorbar object measured in data units.
Syntax
Result = Obj->[IDLgrColorbar::]ComputeDimensions( DestinationObj [, PATH=objref(s)] )
Return Value
Returns the dimensions of a colorbar object for the given destination object.
Arguments
DestinationObject
The object reference to a destination object (IDLgrBuffer, IDLgrClipboard, IDLgrPrinter, or IDLgrWindow) for which the dimensions of the colorbar are being requested.
Keywords
PATH
Set this keyword to a single object reference or a vector of object references. This keyword specifies the path in the graphics hierarchy to compute the dimensions. Each path object reference specified with this keyword must contain an alias. The text dimensions are computed for the version of the object falling within that path. If this keyword is not set, the PARENT properties determine the path from the current object to the top of the graphics hierarchy and no alias paths are pursued. If IDLgrColorbar::ComputeDimensions is called from within a Draw method and the PATH keyword is not set, the alias path used to find the object during the draw is used, rather than the PARENT path.
Note: For more information on aliases, refer to the ALIAS keyword in IDLgrModel::Add.
Version History