AnnotationService.createAnnotation Method
Creates an annotation.
Parameters
- metricSetId
-
Type: String
The ID of the metric set this annotation is for.
- annotationText
-
Type: String
The text of the annotation.
- measureValue
-
Type: SingleNumberValue
The value of the measure.
- renderedMembers
-
Type: Array
ElementType: SingleMemberValue
The list of single member parameter values that the annotation is for.
- viewId
-
Type: String
The View ID that this annotation is attached to.
- isPublic
-
Type: Boolean
(optional) Whether or not this annotation is public. By default, it is not.
Optional: True
- parameterValues
-
Type: Array
ElementType: ParameterValue
(optional) The parameter values that were used for the retrieved data.
Optional: True
- privileges
-
Type: Array
ElementType: PrivilegeAssignment
(Optional) The privileges that the annotation will have.
Optional: True
Return Value
Type: jQuery.Promise
Value: dundas.data.Annotation
A promise object that is resolved when the call is complete.
If successful, a dundas.data.Annotation is returned.