removeAnnotation() Method

• Description
• Parameters
• Return type
• Samples
• See also

Description

Removes an annotation from the chart.

Parameters

• id: String

  Id of annotation to be removed. You should obtain this id before using removeAnnotation() for example using getSelectedAnnotationId() method.

Returns

Boolean.

Note: If "true" - an annotation is removed successfully, "false" - an annotation has not been removed.

Samples

Removing selected annotation sample:

function removeSelectedAnnotation() { var id = chart.getSelectedAnnotationId() chart.removeAnnotation(id); }

Sample:

See also

getSelectedAnnotationId(), removeAllAnnotations(), addAnnotation()