Package | Description |
---|---|
org.pepstock.charba.client.annotation |
Contains all classes to activate the
AnnotationPlugin#ID plugin (AKA chartjs-plugin-annotation.js ) for CHART.js. |
Modifier and Type | Method and Description |
---|---|
static AnnotationId |
AnnotationId.checkAndGetAnnotationID(String id,
AnnotationId defaultValue)
Returns the ID of the annotation checking is consistent.
|
static AnnotationId |
AnnotationId.create(String id)
Returns a key instance by its string value.
|
AnnotationId |
AnnotationType.createId()
Creates a unique id for the annotation.
The format is: |
AnnotationId |
AbstractAnnotation.getId()
Returns the id of annotation.
|
Modifier and Type | Method and Description |
---|---|
static AnnotationId |
AnnotationId.checkAndGetAnnotationID(String id,
AnnotationId defaultValue)
Returns the ID of the annotation checking is consistent.
|
static void |
AnnotationId.checkIfValid(AnnotationId id)
Checks if id passed as argument is not
null and its value is not null as well and could be a valid annotation configuration object id.If not, throw a IllegalArgumentException . |
AbstractAnnotation |
AnnotationOptions.getAnnotation(AnnotationId id)
Returns the annotation with the id passed as argument or
null if not exist. |
boolean |
AnnotationOptions.hasAnnotation(AnnotationId id)
Returns
true if the annotation with the id passed as argument exists. |
static boolean |
AnnotationId.isValid(AnnotationId id)
Returns
true if id passed as argument is not null and its value is not null as well and could be a valid annotation configuration
object id. |
void |
AnnotationOptions.removeAnnotation(AnnotationId id)
Removes the annotation by the id passed as argument, if exists.
|
Constructor and Description |
---|
BoxAnnotation(AnnotationId id)
Creates a box annotation to be added to an
AnnotationOptions instance, using the ID passed as argument. |
BoxAnnotation(AnnotationId id,
IsChart chart)
Creates a box annotation to be added to an
AnnotationOptions instance, using the ID passed as argument.The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object. |
EllipseAnnotation(AnnotationId id)
Creates a ellipse annotation to be added to an
AnnotationOptions instance, using the ID passed as argument. |
EllipseAnnotation(AnnotationId id,
IsChart chart)
Creates a ellipse annotation to be added to an
AnnotationOptions instance, using the ID passed as argument.The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object. |
LineAnnotation(AnnotationId id)
Creates a line annotation to be added to an
AnnotationOptions instance, using the ID passed as argument. |
LineAnnotation(AnnotationId id,
IsChart chart)
Creates a line annotation to be added to an
AnnotationOptions instance, using the ID passed as argument.The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object. |
PointAnnotation(AnnotationId id)
Creates a line annotation to be added to an
AnnotationOptions instance, using the ID passed as argument. |
PointAnnotation(AnnotationId id,
IsChart chart)
Creates a line annotation to be added to an
AnnotationOptions instance, using the ID passed as argument.The chart instance, passed as argument, must be the chart where the annotations will be applied and is used to get the whole default options in order to get the default for this object. |