graph » plot » guide-label
guide-label, guideLabel
[ root » graph » plot » guide-label]
To use with crosshair plot labels. When you have multiple series in your chart, you may want to separate the crosshair plot labels so that a label appears for each series. To do this, you must add a multiple
attribute in the plot-label
object in crosshair-x
, and set the value to true
. You can then createguide-label
objects in individual series
objects to specify how the text and styling for individual plot labels appear. Refer to the Crosshairs Tutorial for more information.
Attribute | Type | Info |
---|---|---|
alpha | Numeric | 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. Note that values require the leading 0 before the decimal point. Use with "background-color" attribute. 0.3 | 0.4 | 0.9 | ... |
background-color backgroundColor | String | Sets the background color of the object. Colors can be entered by name (e.g., "purple", "blue"), hexadecimal notation (e.g., "#FF0000", "#0000FF"), or RGB notation (e.g., "rgb(255,0,0)", "rgb(0,0,255)"). "none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ... |
border-color borderColor | String | Sets the border color of the object. "none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ... |
border-width borderWidth | Numeric | Sets the border width of the object. 4 | "6px" | ... |
font-color fontColor | String | Sets the font color of the object. "none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ... |
font-family fontFamily | String | Sets the font family of the object. "Arial" | "Tahoma,Verdana" | ... |
font-size fontSize | String | Sets the font size of the object. 4 | "6px" | ... |
font-style fontStyle | String | Sets the font style of the object. "none" | "italic" |
font-weight fontWeight | String | Sets the font weight of the object. "none" | "bold" |
line-style lineStyle | String | Sets the style applied to lines and borders of the object. "solid" | "dotted" | "dashed" | "dashdot" |
padding | Mixed | Sets the padding around the text of the object. 10 | "5px" | "10 20" | "5px 10px 15px 20px" | ... |
sticky | Boolean | To create sticky crosshair labels. Use this with the true | false | 1 |0 |
text | String | Sets the crosshair plot label text to be displayed for that series. You can provide any combination of alphanumeric characters and/or ZingChart tokens. "%v widgets" | "Top Sales: %v" | "$%v" | "%v %t" | "..." |
timeout | Numeric | To create sticky crosshair labels. Provide a value in milliseconds. Use this with the 30000 | 10000 | ... |
visible | Boolean | Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON. 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 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 10 | "20px" | 0.3 | "30%" | ... |