Chart Annotation
The Chart Canvas element's Chart Annotation child element allows you to Annotates the chart with labels and shapes placed at various points of interest.
The Chart Annotation element has the following attributes:
Attribute | Description |
---|---|
ID | Unique value within the definition. |
Popup Movable | Customize along which axis the annotation can be draggable. Valid values include: X, Y, XY, and Disable. The default value is XY. |
Visible | Controls visibility. Values include True/False. The default value is empty (False). |
AnnotationLabel.Mock
The Chart Annotation element works in conjunction with the AnnotationLabel.Mock child element. This element creates an annotation label and position on the chart by linking it to a created mock point.
The AnnotationLabel.Mock element has the following attributes:
Attribute | Description |
---|---|
Alignment Horizontal | Sets the horizontal alignment of the text as Left, Center, or Right, within the canvas. The default value is Center. |
Alignment Vertical | Sets the vertical alignment of the text as Top, Middle, or Bottom, within the canvas. The default value is Top. |
Allow Overlap | Controls whether the labels can overlap. The Default value is False. |
Background Color | Sets the background color of the element. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, e.g. #112233. |
Border Color | Sets the color of the border lines. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, e.g. #112233. |
Border Radius | Sets the amount of rounding for canvas, legend, and data label corners, in pixels. |
Border Width | For highlighting, controls width of border around data points in Line, Area, and Scatter charts. |
Caption | Identifies the text to be displayed. |
Condition | An expression that evaluates to a value of True or False. Expressions should be in JavaScript (recommended) or VBScript syntax. For .NET versions, the scripting language can be set in the _settings.lgx General element. For Java versions, the scripting language is always JavaScript. Typically, you would compare values using a token, such as "@Data.value~ < 0" or "@Session.ShowCol1~=='true'". Elements are removed when the Condition evaluates to False. Use quotes when working with strings: "@Data.myColumn~" == "SomeValue" If your data token may have a double quote inside of it, you should use single quotes: '@Data.myColumn~' == 'SomeValue' String valued data tokens with single and double quotes inside are not supported by the condition attribute. |
Crop | Specifies whether to crop/hide the label that is outside the plot area. The default value is False. |
Font Color | Sets the caption font color. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, e.g. #112233. |
Font Family | Specifies the names of one or more fonts. When multiple fonts are specified, with commas between each, the browser uses the first recognized font. |
Font Italic | Specifies whether the font is Italic. |
Font Size | Sets the caption font size, in pixels. |
Font Weight | Specifies the weight (thickness) of characters in the caption text. Options include: Lighter, Normal, Bold, and Bolder. The default value is Normal. |
Format | Specifies a format for the text displayed. For more information, see Format Data. |
Offset X | Sets the horizontal position offset of the caption relative to the horizontal alignment, in pixels. |
Offset Y | Sets the vertical position offset of the caption relative to the vertical alignment, in pixels. |
Overflow | Handles how the label renders when i goes outside the plot area. The default value is Justify, which aligns the label inside the plot area. This attribute can also be set to None. |
Padding | Sets the label padding. The default value is 5. |
Shape | Specifies the shape of the label. Options include: Circle, Rect, Diamond, and Triangle. The default value is callout. |
X | Specifies the X position of the point. Units can be in either axis or chart pixel coordinates. |
X Axis | Defines which X Axis the point is connected to. It refers to either the axis ID, or the index of the axis in the X Axis array. If the option is not configured, or the axis is not found, the x coordinate refers to the chart pixels. If a numeric value is used, it is considered to be the axis ID first. |
Y | Specifies the Y position of the point. Units can be in either axis or chart pixel coordinates. |
Y Axis | Defines which Y Axis the point is connected to. It refers to either the axis ID, or the index of the axis in the Y Axis array. If the option is not configured, or the axis is not found, the y coordinate refers to the chart pixels. If a numeric value is used, it is considered to be the axis ID first. |
Comments
0 comments
Please sign in to leave a comment.