updateAnnotation() Method

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

Description

Updates the settings of the annotation with the given id.

The methods is useful, when you want to change color or style of the existing annotation.

This method is more useful, than recreating in cases when only one or two params need to be altered.

Parameters

• id: String

  Id of annotation to update.

• config: Object or XML String

  Settings can be defined as:
  

  • JSON object of annotation type. Note, that type, chart, axis and id properties are ignored in this case.
  
  
  • XML stringg formatted as <annotation> node. Note, that type, chart, axis and id are ignored in this case.

Returns

Boolean.

If successfully updated returns "true", if there is no annotation with such id or format settings do not match the type - "false".

Samples

Calling sample - alter selected Line settings:

function updateSelectedLineAnnotation() { var id = chart.getSelectedAnnotationId(); if (id == null) return; chart.updateAnnotation(id, { lineAnnotation: { color: "Green", settings: { line: { thickness: 3, dashed: true } } }}); }

Sample:

See also

addAnnotation()