favSetDimName

AVVIEWER Subroutine: Associates a name with the given dimension.

Module: USE AVVIEWER

Syntax

favSetDimName (hv, dim, name, status)

hv
A handle that references an instance of Array Viewer created by favStartViewer.

dim
An input argument of type INTEGER(2). It specifies the array dimension that the following argument will be applied to. The dimension must be in the range 0 to rank, where rank is the rank of the currently loaded array.

name
An input argument of type CHARACTER string. It is the label to be associated with the given dimension. Only AV_MAX_LABEL_LEN characters of the label are used.

status
An output argument of type INTEGER(4). It returns a status code for the success of this call. The value 0 indicates success.

Remarks

The Graph View displays the dimension name as an axis label when the given dimension is assigned as either a row or column dimension, and SetUseAxisLabel has been set to FALSE for the indicated axis.

The Data View will display the dimension names as long as SetShowDimLabels has been enabled.

See Also

favSetRowColDim, favSetUseAxisLabel, favGetDimName