NCL Website header
NCL Home > Documentation > HLUs > API

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.


C Synopsis

#include <ncarg/hlu/hlu.h>
#include <hfile for Plot Object>

int NhlAddAnnotation(
	        int	plot_id,
		int	view_id
		)

Fortran Synopsis

      subroutine NhlFAddAnnotation(plot_id, view_id, anno_manager_id)
      integer plot_id, view_id, anno_manager_id

Arguments

plot_id (input)
Identifier of the plot object to which the View object is to be added as an annotation.
view_id (input)
Identifier of the View object to be added as an annotation of the plot object.
anno_manager_id (output, Fortran only)
If successful, identifier of new AnnoManager object; else error code.

Types

Type name:		NhlTErrorTypes
Definition:
typedef enum _NhlErrType{
	NhlFATAL	= -4,	/* "FATAL"	*/
	NhlWARNING	= -3,	/* "WARNING"	*/
	NhlINFO		= -2,	/* "INFO"	*/
	NhlNOERROR	= -1	/* "NOERROR"	*/
} NhlErrorTypes;