Annotation References

In the following sections, you can see an exhaustive set of attributes and macros supported by annotations in FusionCharts Suite XT.

General configuration attributes

The root annotations object accepts a number of attributes for configuring generic aspects of annotations globally.

These attributes are defined using the code structure shown below:

{
  "annotations": {
    // Define the general configuration attributes here.
  }
}COPY

Configure attributes for annotation groups

You can uniformly configure all annotation items contained within an annotation group, by using a number of attributes, as detailed in the list below. Group attributes inherit default values from the ones defined as root-level annotation attributes.

These attributes are defined using the code structure shown below:

{
  "annotations": {
    "groups": [
      {
        //Define the group configuration attributes here.
      }
    ]
  }
}COPY

Configure attributes for annotation items

You can segregate attributes for annotation items into two types, common (which work for all annotation types) and ad-hoc (which only work for certain annotation types).

Common Attributes

Ad Hoc Attributes

Line

Circle

Arc

Rectangle

Polygon

Text

Path

Images

Use macros to position annotations

Use the following macros to position annotations within charts and gauges:

• Define the annotation position attributes (x, y, toX, toY, etc.) relative to the chart using the $chartStartX, $chartStartY, $chartEndX, $chartEndY, $chartCenterX, $chartCenterY, $chartWidth, and $chartHeight macros.

• Position annotations with respect to the chart margins using the $chartTopMargin, $chartBottomMargin, $chartLeftMargin, and $chartRightMargin macros.

• Position annotations relative to the chart caption and subcaption, using the $captionStartX, $captionStartY, $captionEndX, $captionEndY, $captionWidth, $captionHeight, $subCaptionStartX, $subCaptionStartY, $subCaptionEndX, $subCaptionEndY, $subCaptionWidth, and $subCaptionHeight macros.

• Position annotations with respect to the canvas, using the $canvasStartX, $canvasStartY, $canvasEndX, $canvasEndY, $canvasWidth, and $canvasHeight macros. Note that these macros are only applicable to Cartesian charts.

• Position annotations around a legend using the $legendStartX, $legendStartY, $legendEndX, $legendEndY, $legendWidth, and $legendHeight macros. Note that these macros are only applicable to Cartesian charts.

• Position annotations around gauges using the $gaugeStartX, $gaugeStartY, $gaugeEndX, $gaugeEndY, $gaugeCenterX, and $gaugeCenterY macros.

• Position annotations with respect to the start angle and end angle of an angular gauge, using the $gaugeStartAngle and $gaugeEndAngle macros respectively.

• Position annotations with respect to the radius of a bulb gauge using the $gaugeRadius macro.

• Position annotations with respect to the width of the entire funnel or pyramid plot using the $plotWidth macro.

• Position annotations with respect to half-width of the entire funnel or pyramid plot, using the $plotSemiWidth macro.

Use sub-token macros to position annotations

Use the following sub-token macros to position annotations with respect to datasets and axes:

\$dataset

Use the \$dataset macro to add the position information of the plots in a dataset to the annotation. You can apply the "dataset_index [separator] set [separator] set_index [separator] position_key" sub token to the macro.

Possible values you can assign to the position_key include X, Y, STARTX, STARTY, ENDX, ENDY, CENTERX, and CENTERY.

For example, you can use the following values to position a rectangle above the second column in a column chart:

• x:\$dataset.0.set.1.STARTX

• y:\$dataset.0.set.1.STARTY

• tox:\$dataset.0.set.1.STARTX+100

• toy:\$dataset.0.set.1.STARTY-40

\$yaxis

Use the \$yaxis macro to add the position information of the y-axis labels to the annotation. You can apply the "yaxis_index [separator] label [separator] label_index [separator] position_key" sub token to the macro.

Possible values you can assign to the position_key include X, Y, STARTX, STARTY, ENDX, ENDY, CENTERX, and CENTERY.

For example, you can position a text on the y axis, using the following values:

• x: \$yaxis.0.label.1.startx -12

• y: \$yaxis.0.label.0.starty - 5

\$xaxis

Use the \$xaxis macro to add the position information of the x-axis labels to the annotation. You can apply the "xaxis_index [separator] label [separator] label_index [separator] position_key" sub-token to the macro.

Possible values you can assign to the position_key are the same as the ones you can use with the $yaxis macro.

For example, you can position a text on the x axis, using the following values:

• x: \$xaxis.label.1.startx+2

• y: \$xaxis.label.0.starty+3