Namespace: AnnotationService

AnnotationService

A utility namespace that provides annotation service REST functionality.

Methods

staticAnnotationService.getTileJSON(layerId, level, x, y, params, success)

Get a tiles worth of annotations from the server. Upon success, will execute success callback function passing the resulting object as first argument.
Name Type Description
layerId String The annotation layer identification string.
level integer The zoom level.
x integer The tile x index.
y integer The tile y index.
params Object The query parameter configuration overrides (optional).
success function The callback function executed after success received (optional).

staticAnnotationService.modifyAnnotation(layerId, annotation, success)

Modify an annotation on the server. Upon success, will execute success callback function passing the resulting certificate as first argument.
Name Type Description
layerId String The annotation layer identification string.
annotation Object The annotation to be modified.
success function The callback function executed after success received (optional).

staticAnnotationService.removeAnnotation(layerId, certificate, success)

Remove an annotation from the server.
Name Type Description
layerId String The annotation layer identification string.
certificate Object The certificate of the annotation to be removed.
success function The callback function executed after success received (optional).

staticAnnotationService.writeAnnotation(layerId, annotation, success)

Write an annotation to the server. Upon success, will execute success callback function passing the resulting certificate as first argument.
Name Type Description
layerId String The annotation layer identification string.
annotation Object The annotation to be written.
success function The callback function executed after success received (optional).