plot-label

[ root » graph » crosshair-x » plot-label ]

The crosshair plot labels appear over the data points (or node values) on your chart. They can be customized to display any combination of tokens and text. On multi-series charts, they can be separated to display as multiple plot labels. Refer to the Crosshairs Tutorial for more information.

AttributeTypeInfo

alpha

Numeric

Demo

Sets the transparency of the object. Values must range between 0.0 and 1.0, with 0.0 being completely invisible and 1.0 being completely opaque. Please note that values also require the leading 0 before the decimal.

0.3 | 0.9 | ...

background-color backgroundColor

String

Demo

Sets the background color of the object. Colors can be entered by name (e.g. "red", "blue", "yellow"), in hexadecimal notation (e.g. "#FF0000", "#0000FF", "#FFFF00"), or in RGB notation (e.g. "rgb(255,0,0)", "rgb(0,0,255)", "rgb(255,255,0)").

One color will set a solid background color, two colors will, by default, create a horizontal gradient. For more complex gradients, use gradient-colors and gradient-stops.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-color-1 backgroundColor1

String

Demo

Sets the first color of a 2 color background gradient of the object. To be used with background-color-2.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-color-2 backgroundColor2

String

Demo

Sets the second color of a 2 color background gradient of the object. To be used with background-color-1.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-fit backgroundFit

String

Demo

Sets the direction/s on which the background image is being "stretched".

"x" | "y" | "xy"

background-image backgroundImage

String

Demo

Sets a background image for the object. Value can be a local file or a web image's location.

"image.png" | ...

background-position backgroundPosition

String

Demo

Sets the position of the background when the background-repeat value is no-repeat.

"0 0" | "50 100" | "80% 60%" | ...

background-repeat backgroundRepeat

String

Demo

Sets the repeating mode for the background image.

"no-repeat" | "repeat" | "repeat-x" | "repeat-y"

bold

Boolean

Demo

Sets whether the text is displayed with bold characters or not.

true | false | 1 | 0

border-alpha borderAlpha

Numeric

Sets the transparency of the border. Values must range between 0.0 and 1.0, with 0.0 being completely invisible and 1.0 being completely opaque. Please note that values also require the leading 0 before the decimal.

0.3 | 0.9 | ...

border-bottom borderBottom

String

Demo

Sets the object's bottom border style. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-color borderColor

String

Demo

Sets the border color of the object, applicable on closed shapes. See also line-color for closed shapes.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

border-left borderLeft

String

Demo

Sets the object's left border style. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-radius borderRadius

Mixed

Demo

Sets the object's border radius, for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A single value will affect all 4 corners, while multiple values will have separate effects on each corner, with the first value affecting the top-left corner, the second value affecting the top-right corner, and so on, in a clockwise direction. A negative value will cut a corner off without rounding.

4 | "6px" | "6px 10px 3px 5px" | "-10px" | ...

border-radius-bottom-left borderRadiusBottomLeft

Mixed

Demo

Sets the object's bottom-left border radius, for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.

4 | "6px" | "-6px" | -4 | ...

border-radius-bottom-right borderRadiusBottomRight

Mixed

Demo

Sets the object's bottom-right border radius, for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.

4 | "6px" | "-6px" | -4 | ...

border-radius-top-left borderRadiusTopLeft

Mixed

Demo

Sets the object's top-left border radius, for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.

4 | "6px" | "-6px" | -4 | ...

border-radius-top-right borderRadiusTopRight

Mixed

Demo

Sets the object's top-right border radius, for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding.

4 | "6px" | "-6px" | -4 | ...

border-right borderRight

String

Demo

Sets the object's right border style. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-top borderTop

String

Demo

Sets the object's top border style. Values must include the border width, style, and color. Accepts solid, dashed, and dotted styles.

"2px solid #f00" | ...

border-width borderWidth

Mixed

Demo

Sets the border width of the object, applicable on closed shapes. See also line-width for closed shapes.

4 | "6px" | ...

callout

Boolean

Demo

Sets whether an object will have a callout arrow or not.

true | false | 1 | 0

callout-height calloutHeight

Mixed

Demo

Sets the height of the object's callout arrow. A larger value will create a taller callout arrow.

4 | "6px" | ...

clip-text clipText

Boolean

Demo

Clips text that runs longer than the width of the parent object.

true | false | 1 | 0

color

String

Demo

Sets the text's color of the crosshair xy label when you hover over the graph items.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

fill-angle fillAngle

Numeric

Demo

Sets the angle of the axis along which the linear gradient is drawn.

-45 | 115 | ...

fill-offset-x fillOffsetX

Mixed

Demo

Sets an X offset to apply to the fill.

4 | "6px" | ...

fill-offset-y fillOffsetY

Mixed

Demo

Sets an Y offset to apply to the fill.

4 | "6px" | ...

fill-type fillType

String

Demo

Sets the background gradient fill type to either linear or radial.

"linear" | "radial"

font-angle fontAngle

Numeric

Demo

Sets the rotation angle of the crosshair xy label when you hover over the graph items. Similar with angle.

-45 | 115 | ...

font-color fontColor

String

Demo

Sets the text's color of the crosshair xy label when you hover over the graph items. Similar with color.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

font-family fontFamily

String

Demo

Sets the text's font family of the crosshair xy label when you hover over the graph items.

"Arial" | "Tahoma,Verdana" | ...

font-size fontSize

Mixed

Demo

Sets the text's font size of the crosshair xy label when you hover over the graph items.

4 | "6px" | ...

font-style fontStyle

String

Demo

Sets the text's font style of the crosshair xy label when you hover over the graph items.

"none" | "italic" | "oblique"

font-weight fontWeight

String

Demo

Sets the text's font weight of the crosshair xy label when you hover over the graph items. Similar with bold.

"normal" | "bold"

gradient-colors gradientColors

String

Demo

Sets a set of colors for a complex background gradient consisting of 2 or more colors. To be used with gradient-stops.

"#f00 #0f0 #00f" | ...

gradient-stops gradientStops

String

Demo

Sets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors.

"0.1 0.5 0.9" | ...

height

Mixed

Demo

Sets the object's height.

10 | "20px" | 0.3 | "30%" | ...

italic

Boolean

Demo

Sets whether the text of the crosshair xy label when you hover over the graph items is displayed with italic characters or not .

true | false | 1 | 0

max-chars maxChars

Numeric

Demo

Sets the maximum numbers of characters displayed in the object. The value determines how many characters will be displayed before the text is cut and appended with "..."

5 | 10 | ...

max-width maxWidth

Mixed

Demo

Sets the maximum width of the text box. If text is longer than the max-width value, it will overlap the box or will wrap if wrap-text is set to true.

10 | "20px" | 0.3 | "30%" | ...

multiple

Boolean

To separate the plot labels so that a label appears for each series. You can assign unique text and styling to each label by going to the "series" array. In each series object, create a "guide-label"object, where you can place your series-specific text and styling attributes.

true | false | 1 | 0

offset-x offsetX

Mixed

Demo

Sets an X offset to apply when positioning the object/shape.

4 | "6px" | ...

offset-y offsetY

Mixed

Demo

Sets a Y offset to apply when positioning the object/shape.

4 | "6px" | ...

padding

Mixed

Demo

Sets the object's padding around the text. Up to four values can be entered to set the padding for all four sides, with the first value affecting the top padding, the second value affecting the right padding, and so on, in a clockwise direction.

10 | "5px" | "10 20" | "5px 10px 15px 20px" | ...

padding-bottom paddingBottom

Mixed

Demo

Sets the object's bottom padding around the text.

4 | "6px" | ...

padding-left paddingLeft

Mixed

Demo

Sets the object's left padding around the text.

4 | "6px" | ...

padding-right paddingRight

Mixed

Demo

Sets the object's right padding around the text.

4 | "6px" | ...

padding-top paddingTop

Mixed

Demo

Sets the object's top padding around the text.

4 | "6px" | ...

placement

String

Demo

Fixes the crosshair plot labels above the nodes. Make sure to include the "multiple"attribute (set to true) in the same object. Use the "offset-y" attribute to adjust as needed.

"node-top"

rtl (right-to-left)

Boolean

Demo

Renders text right-to-left. Default value is false.

true | false | 1 | 0

shadow

Boolean

Demo

Sets whether the object's shadow is visible or not.

Has limited effect on HTML5 implementation.

true | false | 1 | 0

shadow-alpha shadowAlpha

Numeric

Demo

Sets the transparency of the shadow of the object. Values must range between 0.0 and 1.0, with 0.0 being completely invisible and 1.0 being completely opaque. Please note that values also require the leading 0 before the decimal.

0.3 | 0.9 | ...

shadow-angle shadowAngle

Numeric

Demo

Sets the angle of the shadow underneath the object.

-45 | 115 | ...

shadow-blur shadowBlur

Mixed

Demo

Sets the blur effect size for the shadow of the object.

Has limited effect on HTML5 implementation.

4 | "6px" | ...

shadow-color shadowColor

String

Demo

Sets the color of the shadow of the object.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

shadow-distance shadowDistance

Mixed

Demo

Sets the distance between the shadow and the object.

4 | "6px" | ...

sticky

Boolean

To create sticky crosshair labels. Use this with the "timeout" attribute, which allows you to specify how long you want the labels to "stick" to the chart. Refer to the Crosshairs Tutorial for more information.

true | false | 1 |0

text

String

Demo

Sets the text content of the object.

"Some Text" | ...

text-align textAlign

String

Demo

Sets the text's horizontal alignment relative to the object's box.

"left" | "center" | "right"

text-alpha textAlpha

Numeric

Demo

Sets the text's transparency independent of the object's transparency. Value must be between 0.0 and 1.0, with 0.0 being 100% transparent and 1.0 being 100% opaque. The leading 0 before the decimal is required.

0.3 | 0.9 | ...

text-decoration textDecoration

String

Demo

Sets the text's decoration to use underlined characters. Similar to underline.

May not display properly in Mozilla Firefox when charts are rendered using SVG.

"none" | "underline"

timeout

Numeric

To create sticky crosshair labels. Provide a value in milliseconds. Use this with the "sticky" attribute, which specifies whether or not labels will "stick" to the chart. Refer to the Crosshairs Tutorial for more information.

30000 | 10000 | ...

transform

Object

Allows the underlying data to be 'transformed' to a new format if it was in that format originally. For example, if data is coded as a date and time, and 'type':'date' is specified as an attribute of this object, '1311261385209' will display 'Wed, 19 of May 05:00 PM' if '%D, %d %M %h:%i %A' is specified under the transform attribute of scale-x.

{...}

underline

Boolean

Demo

Sets whether the text is displayed with underlined characters or not. Similar to text-decoration.

May not display properly in Mozilla Firefox when charts are rendered using SVG.

true | false | 1 | 0

vertical-align verticalAlign

String

Demo

Sets the text's vertical alignment to one of the three applicable values, relative to the object's box.

"top" | "middle" | "bottom"

visible

Boolean

Demo

Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON.

true | false | 1 | 0

width

Mixed

Demo

Sets the object's width.

10 | "20px" | 0.3 | "30%" | ...

wrap-text wrapText

Boolean

Demo

Sets whether the text will wrap, depending on the width of the object.

true | false | 1 | 0

x

Mixed

To create fixed crosshair labels. This attribute specifies the "x" position of your label, and can be used with the "y" attribute to specify the "y" position. Refer to the Crosshairs Tutorial for more information.

10 | "20px" | 0.3 | "30%" | ...

y

Mixed

To create fixed crosshair labels. This attribute specifies the "y" position of your label, and can be used with the "x" attribute to specify the "x" position. Refer to the Crosshairs Tutorial for more information.

10 | "20px" | 0.3 | "30%" | ...