graph » crosshair-x » plot-label » top-state

bottom-state

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

Customize the "top-state" of the area directly above the crosshair plot label.



AttributeTypeDescription
alignStringSets the alignment of the object.
Accepted Values: ['center', 'left', 'right']
alphaNumberSets the opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0.
anchorStringAllows you to set an object's anchor position
Accepted Values: ['tl', 'tr', 'bl', 'br', 'c', 't', 'r', 'b', 'l']
Default Value: 'tl'
angleNumberSets the rotation angle of the object.
Default Value: 0
backgroundClip
background-clip
BooleanClips the background image to the margins of the shape/box.
Default Value: true
backgroundColor
background-color
StringSets the background color of the object. Colors can be entered by name (e.g., "purple", "blue"), hexadecimal notation (e.g., "#666699", #33ccff"), or RGB notation (e.g., "rgb(255,0,0)", "rgb(0,0,255)")
Default Value: null
backgroundColor1
background-color-1
StringSets the first color of a 2 color background gradient of the object. To be used with background-color-2.
Default Value: null
backgroundColor2
background-color-2
StringSets the second color of a 2 color background gradient of the object. To be used with background-color-1.
Default Value: null
backgroundFit
background-fit
StringSets the direction/s on which the background image is being "stretched".
Default Value: ''
backgroundImage
background-image
StringSets a background image for the object. Value can be a local file or a web image's location. For patterns, the available patterns are: [`${string}`, 'PATTERN_BACKWARD_DIAGONAL', 'PATTERN_DARK_DOWNWARD_DIAGONAL', 'PATTERN_DARK_HORIZONTAL', 'PATTERN_DARK_UPWARD_DIAGONAL', 'PATTERN_DARK_VERTICAL', 'PATTERN_DASHED_DOWNWARD_DIAGONAL', 'PATTERN_DASHED_HORIZONTAL', 'PATTERN_DASHED_UPWARD_DIAGONAL', 'PATTERN_DASHED_VERTICAL', 'PATTERN_DIAGONAL_BRICK', 'PATTERN_DIAGONAL_CROSS', 'PATTERN_DIVOT', 'PATTERN_DOTTED_DIAMOND', 'PATTERN_DOTTED_GRID', 'PATTERN_FORWARD_DIAGONAL', 'PATTERN_HORIZONTAL', 'PATTERN_HORIZONTAL_BRICK', 'PATTERN_LARGE_CHECKER_BOARD', 'PATTERN_LARGE_GRID', 'PATTERN_LIGHT_DOWNWARD_DIAGONAL', 'PATTERN_LIGHT_HORIZONTAL', 'PATTERN_LIGHT_UPWARD_DIAGONAL', 'PATTERN_LIGHT_VERTICAL', 'PATTERN_NARROW_HORIZONTAL', 'PATTERN_NARROW_VERTICAL', 'PATTERN_OUTLINED_DIAMOND', 'PATTERN_PLAID', 'PATTERN_SHADE_25', 'PATTERN_SHADE_50', 'PATTERN_SHADE_75', 'PATTERN_SHINGLE', 'PATTERN_SMALL_CHECKER_BOARD', 'PATTERN_SMALL_GRID', 'PATTERN_SOLID_DIAMOND', 'PATTERN_SPHERE', 'PATTERN_TRELLIS', 'PATTERN_VERTICAL', 'PATTERN_WAVE', 'PATTERN_WEAVE', 'PATTERN_WIDE_DOWNWARD_DIAGONAL', 'PATTERN_WIDE_UPWARD_DIAGONAL', 'PATTERN_ZIGZAG'].
Accepted Values: ['PATTERN_BACKWARD_DIAGONAL', 'PATTERN_DARK_DOWNWARD_DIAGONAL', 'PATTERN_DARK_HORIZONTAL', 'PATTERN_DARK_UPWARD_DIAGONAL', 'PATTERN_DARK_VERTICAL', 'PATTERN_DASHED_DOWNWARD_DIAGONAL', 'PATTERN_DASHED_HORIZONTAL', 'PATTERN_DASHED_UPWARD_DIAGONAL', 'PATTERN_DASHED_VERTICAL', 'PATTERN_DIAGONAL_BRICK', 'PATTERN_DIAGONAL_CROSS', 'PATTERN_DIVOT', 'PATTERN_DOTTED_DIAMOND', 'PATTERN_DOTTED_GRID', 'PATTERN_FORWARD_DIAGONAL', 'PATTERN_HORIZONTAL', 'PATTERN_HORIZONTAL_BRICK', 'PATTERN_LARGE_CHECKER_BOARD', 'PATTERN_LARGE_GRID', 'PATTERN_LIGHT_DOWNWARD_DIAGONAL', 'PATTERN_LIGHT_HORIZONTAL', 'PATTERN_LIGHT_UPWARD_DIAGONAL', 'PATTERN_LIGHT_VERTICAL', 'PATTERN_NARROW_HORIZONTAL', 'PATTERN_NARROW_VERTICAL', 'PATTERN_OUTLINED_DIAMOND', 'PATTERN_PLAID', 'PATTERN_SHADE_25', 'PATTERN_SHADE_50', 'PATTERN_SHADE_75', 'PATTERN_SHINGLE', 'PATTERN_SMALL_CHECKER_BOARD', 'PATTERN_SMALL_GRID', 'PATTERN_SOLID_DIAMOND', 'PATTERN_SPHERE', 'PATTERN_TRELLIS', 'PATTERN_VERTICAL', 'PATTERN_WAVE', 'PATTERN_WEAVE', 'PATTERN_WIDE_DOWNWARD_DIAGONAL', 'PATTERN_WIDE_UPWARD_DIAGONAL', 'PATTERN_ZIGZAG', `${string}`]
Default Value: ''
backgroundPosition
background-position
StringSets the position of the background when the background-repeat value is no-repeat.
Default Value: '50% 50%'
backgroundRepeat
background-repeat
Boolean, StringSets the repeating mode for the background image.
Default Value: 'repeat'
backgroundScale
background-scale
NumberScales the background image using the specified ratio.
Default Value: 1
boldBooleanSets whether the text is displayed with bold characters or not.
Default Value: false
borderNumberSets the border width of the object. Can be a single value or a string of values, setting the values in the order "top right bottom left"
borderAlpha
border-alpha
NumberSets the transparency level of the border on the object. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading 0 before the decimal point.
Default Value: 1
Introduced in: v2.1.1
borderBottom
border-bottom
NumberSets the object's bottom border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderColor
border-color
StringSets the border color of the object.
Default Value: '#000'
borderLeft
border-left
NumberSets the object's left border style. Accepts solid, dashed, and dotted styles.
borderRadius
border-radius
NumberSets 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; 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.
Default Value: 0
borderRadiusBottomLeft
border-radius-bottom-left
NumberSets 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.
Default Value: 0
borderRadiusBottomRight
border-radius-bottom-right
NumberSets 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.
Default Value: 0
borderRadiusTopLeft
border-radius-top-left
NumberSets 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.
Default Value: 0
borderRadiusTopRight
border-radius-top-right
NumberSets 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.
Default Value: 0
borderRight
border-right
NumberSets the object's right border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderTop
border-top
NumberSets the object's top border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
centerRef
center-ref
BooleanSets the (0,0) x/y coordinates as the center of the box (instead of the top-left corner).
Default Value: false
clipText
clip-text
BooleanTruncates text based on the setting of width.
Default Value: false
colorStringSets the object's font color. Similar to font-color.
Default Value: '#000'
defaultValue
default-value
StringSets the default value token values to display until the value is available.
Default Value: null
fillAngle
fill-angle
NumberSets the angle of the axis along which the linear gradient is drawn.
Default Value: 90
fillOffsetX
fill-offset-x
NumberSets an X offset to apply to the fill.
Default Value: 0
fillOffsetY
fill-offset-y
NumberSets a Y offset to apply to the fill.
Default Value: 0
fillType
fill-type
StringSets the background gradient fill type to either linear or radial.
Accepted Values: ['linear', 'none', 'radial']
Default Value: 'linear'
fontAngle
font-angle
NumberSets the text's angle. A positive value will rotate the object by that number of degrees clockwise, while a negative value.
fontColor
font-color
StringSets the font color of the text.
fontFamily
font-family
StringSets the text's font family.
fontSize
font-size
NumberSets the text's font size.
fontStyle
font-style
StringSets the text's font style.
Accepted Values: ['italic', 'none', 'normal', 'oblique']
fontWeight
font-weight
Number, StringSets the text's font weight. Similar to bold.
Accepted Values: ['bold', 'none', 'normal', `${string}`]
Default Value: 'normal'
gradientColors
gradient-colors
StringSets a set of colors for a complex background gradient consisting of 2 or more colors. To be used with gradient-stops.
Default Value: ''
gradientStops
gradient-stops
StringSets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors.
Default Value: ''
headerText
header-text
StringSets the header text of the object.
Default Value: null
heightNumberSets the object's height.
htmlMode
html-mode
BooleanTo create HTML plot labels, set the value to `true`, and then in the attribute, provide your HTML markup.
Default Value: false
Introduced in: v2.6.2
italicBooleanSets whether the text is displayed with italicized characters or not.
Default Value: false
lineCap
line-cap
StringSets the stroke-linecap attribute on SVGs
Accepted Values: ['butt', 'round', 'square']
Default Value: 'butt'
lineColor
line-color
StringSets the line color of the object, applicable on non-closed shapes. See also border-color for closed shapes.
Default Value: '#000'
lineGapSize
line-gap-size
NumberCan be used to create custom dashed or dotted lines when used with line-segment-size. This will control the size of the gaps between each line segment.
Default Value: 0
lineHeight
line-height
NumberSets the height of a line box.
Default Value: -1
lineJoin
line-join
StringSets the stroke-linejoin attribute on SVGs
Accepted Values: ['round', 'miter']
Default Value: 'round'
lineSegmentSize
line-segment-size
NumberCan be used to create custom dashed or dotted lines when used with line-gap-size. This will control the size of the visible segment of line.
Default Value: 0
lineStyle
line-style
StringSets the line style of the object.
Accepted Values: ['dashdot', 'dashed', 'dotted', 'solid']
Default Value: ''
lineWidth
line-width
NumberSets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes.
Default Value: 0
marginNumber, StringSets the object's margin/s from the top-left of the chart.
Accepted Values: ['dynamic']
Default Value: 0
marginBottom
margin-bottom
NumberSets the object's bottom margin.
Default Value: -1
marginLeft
margin-left
NumberSets the object's left margin.
Default Value: -1
marginRight
margin-right
NumberSets the object's right margin.
Default Value: -1
marginTop
margin-top
NumberSets the object's top margin.
Default Value: -1
maxChars
max-chars
NumberSets 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 "..."
Default Value: 0
multipleBooleanSets each series to display its own label. Style each series label with `series.guide.label`.
Default Value: null
offsetX
offset-x
NumberSets an x-offset to apply when positioning the object.
Default Value: 0
offsetY
offset-y
NumberSets an y-offset to apply when positioning the object.
Default Value: 0
overlapBooleanSets whether the object allows overlapping with other labels. If false, and two objects overlap, only one will be displayed.
Default Value: true
paddingNumberSets 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.
Default Value: null
paddingBottom
padding-bottom
NumberSets the object's bottom padding around the text.
Default Value: 2
paddingLeft
padding-left
NumberSets the object's left padding around the text.
Default Value: 2
paddingRight
padding-right
NumberSets the object's right padding around the text.
Default Value: 2
paddingTop
padding-top
NumberSets the object's top padding around the text.
Default Value: 2
placementStringSets the placement of the object. For textboxes, fixes the crosshair plot labels above the nodes. Must include `multiple` set to true. Use `offsetY` to adjust ['node-top'].
Accepted Values: ['node-top']
Default Value: null
pointsArray.<any>Sets the coordinates of the object/shape points.
Default Value: []
rtlBooleanRenders text right-to-left. Default value is false.
Default Value: false
shadowBooleanSets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation.
Default Value: false
shadowAlpha
shadow-alpha
NumberSets the transparency of the shadow of the object. The higher the value, the less transparent the shadow will be.
Default Value: 0.75
shadowAngle
shadow-angle
NumberSets the angle of the shadow underneath the object.
Default Value: 45
shadowBlur
shadow-blur
NumberSets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation.
Default Value: 0
shadowColor
shadow-color
StringSets the color of the shadow of the object.
Default Value: '#999'
shadowDistance
shadow-distance
NumberSets the distance between the shadow and the object.
Default Value: 2
sortByValue
sort-by-value
StringSort the series by value displayed in the crosshair plotlabel.
Accepted Values: ['asc', 'desc']
Default Value: null
tableColumns
table-columns
NumberUsed with `htmlMode: true` layout plot label content in a table with specified number of columns.
Default Value: false
Introduced in: v2.6.2
textAlpha
text-alpha
NumberSets the opacity on the text, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0.
Default Value: true
textDecoration
text-decoration
StringSets the text's decoration to use underlined characters. Similar to underline. May not display properly in Mozilla Firefox when charts are rendered using SVG.
Default Value: 'none'
underlineBooleanSets whether the text is displayed with underlined characters or not.
Default Value: false
verticalAlign
vertical-align
StringSets vertical alignment of the object. For textboxes, aligns relative to object's box. Accepted values: ['top', 'middle', 'bottom'].
Accepted Values: ['bottom', 'middle', 'top']
Default Value: 'middle'
widthNumberSets the object's width.
wrapText
wrap-text
BooleanSets whether the text will wrap, depending on the width of the object.
Default Value: false
xNumberSets the X position of the object.
Default Value: -1
yNumberSets the Y position of the object.