NCL Website header
NCL Home > Documentation > HLUs

HLU API functions

NHLPERROR
The Fortran name of this function is NhlFPError.

Error handling functions for the HLU library.

NhlAddAnnotation
The Fortran name of this function is NhlFAddAnnotation.

This function adds an arbitrary View object to a plot object as an external annotation, and returns an AnnoManager object to manage it.

NhlAddData
The Fortran name of this function is NhlFAddData.

This function is used to associate a DataItem object with a data resource in a DataComm object.

NhlAddOverlay
The Fortran name of this function is NhlFAddOverlay.

This function adds an overlay plot member to a base plot.

NhlAppGetDefaultParentId
The Fortran name of this function is NhlFAppGetDefaultParentId.

This function retrieves the Id of the current default parent App object.

NhlChangeWorkstation
The Fortran name of this function is NhlFChangeWorkstation.

This function is used to change the Workstation parent of any graphical HLU object. It is provided as an access function to objects that are Base class.

NhlClassName
The Fortran name of this function is NhlFClassName.

Returns the name of the class of an object.

NhlClearWorkstation
The Fortran name of this function is NhlFClearWorkstation.

This function clears the drawing area of an instance of a Workstation object.

NhlClose
The Fortran name of this function is NhlFClose.

HLU library clean-up function.

NhlCreate
The Fortran name of this function is NhlFCreate.

This function is used to create an instance of any HLU object. It is provided as an access function to objects that are Base class.

NhlDataPolygon
The Fortran name of this function is NhlFDataPolygon.

Given arrays containing the X and Y coordinates of points in data coordinate space, this function outputs an immediate-mode polygon connecting each of the points.

NhlDataPolyline
The Fortran name of this function is NhlFDataPolyline.

Given arrays containing the X and Y coordinates of points in data coordinate space, this function outputs an immediate-mode polyline connecting each of the points.

NhlDataPolymarker
The Fortran name of this function is NhlFDataPolymarker.

Given arrays containing the X and Y coordinates of points in data coordinate space, this function outputs an immediate-mode marker at each of the points.

NhlDataToNDC
The Fortran name of this function is NhlFDataToNDC.

Given arrays containing the X and Y coordinates of points in data coordinate space, this function returns arrays containing the X and Y coordinates of the same points in NDC space.

NhlDestroy
The Fortran name of this function is NhlFDestroy.

This function is used to destroy an HLU object.

NhlDraw
The Fortran name of this function is NhlFDraw.

This function is used to make an HLU graphical object draw.

NhlErrAddTable
No corresponding Fortran function.

Error handling functions for the HLU library.

NhlErrClearMsgs
The Fortran name of this function is NhlFErrCleanMsgs.

Error handling functions for the HLU library.

NhlErrFPrintMsg
The Fortran name of this function is NhlFErrFPrintMsg.

Error handling functions for the HLU library.

NhlErrGetId
The Fortran name of this function is NhlFErrGetId.

Error handling functions for the HLU library.

NhlErrGetMsg
The Fortran name of this function is NhlFErrGetMsg.

Error handling functions for the HLU library.

NhlErrNumMsgs
The Fortran name of this function is NhlFErrNumMsgs.

Error handling functions for the HLU library.

NhlErrSPrintMsg
The Fortran name of this function is NhlFErrSprintMsg.

Error handling functions for the HLU library.

NhlFrame
The Fortran name of this function is NhlFFrame.

This function first updates and then clears the drawing area of an instance of a Workstation object.

NhlFree
No corresponding Fortran function.

Memory allocation functions.

NhlFreeColor
The Fortran name of this function is NhlFFreeColor.

This function removes a color, specified by its HLU index, from the Workstation color map.

NhlGetBB
The Fortran name of this function is NhlFGetBB.

This function returns the coordinates of the left, right, top, and bottom edges of a View class object's bounding box in NDC units.

NhlGetGksCi
The Fortran name of this function is NhlFGetGksCi.

This function returns the low-level GKS color index from an HLU color index and an instance of a Workstation object.

NhlGetValues
The Fortran name of this function is NhlFGetValues.

This function is used to retrieve the resource values of an instance of any HLU object. It is provided as an access function to objects that are Base class.

NhlGetWorkspaceObjectId
The Fortran name of this function is NhlFGetWorkspaceObjectId.

This function retrieves the Workspace objects id.

NhlInitialize
The Fortran names of this function is NhlFInitialize.

HLU library initialization functions.

NhlIsAllocatedColor
The Fortran name of this function is NhlFIsAllocatedColor.

This boolean function returns True if a color has been assigned to a particular HLU color index, and False otherwise.

NhlIsApp
The Fortran name of this function is NhlFIsApp.

This boolean function returns True if the given id identifies an App class object, and False otherwise.

NhlIsDataComm
The Fortran name of this function is NhlFIsDataComm.

This boolean function returns True if the given id identifies a DataComm class object, and False otherwise.

NhlIsDataItem
The Fortran name of this function is NhlFIsDataItem.

This boolean function returns True if the given id identifies a DataItem class object, and False otherwise.

NhlIsDataSpec
The Fortran name of this function is NhlFIsDataSpec.

This boolean function returns True if the given id identifies a DataSpec class object, and False otherwise.

NhlIsTransform
The Fortran name of this function is NhlFIsTransform.

This boolean function returns True if the given id identifies a Transform class object, and False otherwise.

NhlIsView
The Fortran name of this function is NhlFIsView.

This boolean function returns True if the given id identifies a View class object, and False otherwise.

NhlIsWorkstation
The Fortran name of this function is NhlFIsWorkstation.

This boolean function returns True if the given id identifies a Workstation class object, and False otherwise.

NhlMalloc
No corresponding Fortran function.

Memory allocation functions.

NhlNDCPolygon
The Fortran name of this function is NhlFNDCPolygon.

Given arrays containing the X and Y coordinates of points in NDC space, this function outputs an immediate-mode polygon connecting each of the points.

NhlNDCPolyline
The Fortran name of this function is NhlFNDCPolyline.

Given arrays containing the X and Y coordinates of points in NDC space, this function outputs an immediate-mode polyline connecting each of the points.

NhlNDCPolymarker
The Fortran name of this function is NhlFNDCPolymarker.

Given arrays containing the X and Y coordinates of points in NDC space, this function outputs an immediate-mode marker at each of the points.

NhlNDCToData
The Fortran name of this function is NhlFNDCToData.

Given arrays containing the X and Y coordinates of points in NDC space, this function returns arrays containing the X and Y coordinates of the same points in data coordinate space.

NhlName
The Fortran name of this function is NhlFName.

This function returns the "name" of an object.

NhlNewColor
The Fortran name of this function is NhlFNewColor.

This function adds a color specified as an RGB triple to the colormap of a Workstation instance and returns its HLU color index.

NhlNumber
No corresponding Fortran function.

This cpp macro determines the number of elements in a fixed-size array.

NhlOpen
The Fortran name of this function is NhlFOpen.

HLU library initialization functions.

NhlPError
The Fortran name of this function is NhlFPError.

Error handling functions for the HLU library.

NhlRLClear
The Fortran name of this function is NhlFRLClear.

ResList support function.

NhlRLCreate
The Fortran name of this function is NhlFRLCreate.

ResList support functions.

NhlRLDestroy
The Fortran name of this function is NhlFRLDestroy.

ResList support functions.

NhlRLGet
No corresponding Fortran function.

Used to add the given name and val_addr to the ResList.

NhlRLGetArray
No corresponding Fortran function.

Used to add the given name and val_addr to the ResList.

NhlRLGetDouble
The Fortran name of this function is NhlFRLGetDouble.

Used to add the given name and val_addr to the ResList.

NhlRLGetDoubleArray
The Fortran name of this function is NhlFRLGetDoubleArray.

Used to add the given name and val_addr to the ResList.

NhlRLGetFloat
The Fortran name of this function is NhlFRLGetFloat.

Used to add the given name and val_addr to the ResList.

NhlRLGetFloatArray
The Fortran name of this function is NhlFRLGetFloatArray.

Used to add the given name and val_addr to the ResList.

NhlRLGetInteger
The Fortran name of this function is NhlFRLGetInteger.

Used to add the given name and val_addr to the ResList.

NhlRLGetIntegerArray
The Fortran name of this function is NhlFRLGetIntegerArray.

Used to add the given name and val_addr to the ResList.

NhlRLGetMDArray
No corresponding Fortran function.

Used to add the given name and val_addr to the ResList.

NhlRLGetMDDoubleArray
The Fortran name of this function is NhlFRLGetMDDoubleArray.

Used to add the given name and val_addr to the ResList.

NhlRLGetMDFloatArray
The Fortran name of this function is NhlFRLGetMDFloatArray.

Used to add the given name and val_addr to the ResList.

NhlRLGetMDIntegerArray
The Fortran name of this function is NhlFRLGetMDIntegerArray.

Used to add the given name and val_addr to the ResList.

NhlRLGetString
The Fortran name of this function is NhlFRLGetString.

Used to add the given name and val_addr to the ResList.

NhlRLGetStringArray
The Fortran name of this function is NhlFRLGetStringArray.

Used to add the given name and val_addr to the ResList.

NhlRLIsSet
The Fortran name of this function is NhlFRLIsSet.

ResList support functions.

NhlRLSet
No corresponding Fortran function.

Used to add the given name and value to the ResList.

NhlRLSetArray
No corresponding Fortran function.

Used to add the given name and value array to the ResList.

NhlRLSetDouble
The Fortran name of this function is NhlFRLSetDouble.

Used to add the given name and value to the ResList.

NhlRLSetDoubleArray
The Fortran name of this function is NhlFRLSetDoubleArray.

Used to add the given name and value array to the ResList.

NhlRLSetFloat
The Fortran name of this function is NhlFRLSetFloat.

Used to add the given name and value to the ResList.

NhlRLSetFloatArray
The Fortran name of this function is NhlFRLSetFloatArray.

Used to add the given name and value array to the ResList.

NhlRLSetInteger
The Fortran name of this function is NhlFRLSetInteger.

Used to add the given name and value to the ResList.

NhlRLSetIntegerArray
The Fortran name of this function is NhlFRLSetIntegerArray.

Used to add the given name and value array to the ResList.

NhlRLSetMDArray
No corresponding Fortran function.

Used to add the given name and value array to the ResList.

NhlRLSetMDDoubleArray
The Fortran name of this function is NhlFRLSetMDDoubleArray.

Used to add the given name and value array to the ResList.

NhlRLSetMDFloatArray
The Fortran name of this function is NhlFRLSetMDFloatArray.

Used to add the given name and value array to the ResList.

NhlRLSetMDIntegerArray
The Fortran name of this function is NhlFRLSetMDIntegerArray.

Used to add the given name and value array to the ResList.

NhlRLSetString
The Fortran name of this function is NhlFRLSetString.

Used to add the given name and value to the ResList.

NhlRLSetStringArray
The Fortran name of this function is NhlFRLSetStringArray.

Used to add the given name and value array to the ResList.

NhlRLUnSet
The Fortran name of this function is NhlFRLUnSet.

ResList support functions.

NhlRealloc
No corresponding Fortran function.

Memory allocation functions.

NhlRemoveAnnotation
The Fortran name of this function is NhlFRemoveAnnotation.

This function removes an arbitrary View object annotation from a Plot Object, destroying its AnnoManager object.

NhlRemoveData
The Fortran name of this function is NhlFRemoveData.

This function is used to dissociate a DataItem object from a data resource in a DataComm object.

NhlRemoveOverlay
The Fortran name of this function is NhlFRemoveOverlay.

This function removes an overlay plot member from a base plot.

NhlSetColor
The Fortran name of this function is NhlFSetColor.

This function sets the RGB color value for a specified HLU color index.

NhlSetValues
The Fortran name of this function is NhlFSetValues.

This function is used to change the resource values of an instance of any HLU object. It is provided as an access function to objects that are Base class.

NhlUpdateData
The Fortran name of this function is NhlFUpdateData.

This function is used to force a DataComm object to update its internal state to any changes that have occurred in associated DataItems.

NhlUpdateWorkstation
The Fortran name of this function is NhlFUpdateWorkstation.

This function updates the drawing area of an instance of a Workstation object.