graph » options » box

box

[ root » graph » options » box ]

Box plots only: Styles each box in the boxplot Toolbar3D module only: Styles content boxes within 3D toolbar Treemaps only: Styles each box in the treemap




AttributeTypeDescription
alignStringSets the alignment of the object.
Accepted Values: ['left', 'center', 'right']
Chart types: Treemap
alphaNumberSets the opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0.
Default Value: 1
Chart types: Boxplot,3D Toolbar,Treemap
angleNumberSets the rotation angle of the object.
Chart types: 3D Toolbar
backgroundClip
background-clip
BooleanClips the background image to the margins of the shape/box.
Default Value: true
Chart types: Boxplot,Treemap
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
Chart types: Boxplot,3D Toolbar,Treemap
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
Chart types: Boxplot,3D Toolbar,Treemap
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
Chart types: Boxplot,3D Toolbar,Treemap
backgroundFit
background-fit
StringSets the direction/s on which the background image is being "stretched".
Default Value: ''
Chart types: Boxplot,Treemap
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: ''
Chart types: Boxplot,Treemap
backgroundPosition
background-position
StringSets the position of the background when the background-repeat value is no-repeat.
Default Value: '50% 50%'
Chart types: Boxplot,Treemap
backgroundRepeat
background-repeat
Boolean, StringSets the repeating mode for the background image.
Default Value: 'repeat'
Chart types: Boxplot,Treemap
backgroundScale
background-scale
NumberScales the background image using the specified ratio.
Default Value: 1
Chart types: Boxplot,Treemap
barWidth
bar-width
NumberSets the width of the boxplot bar widths.
Introduced in: v2.1.0
Chart types: Boxplot
boldBooleanSets whether the text is displayed with bold characters or not.
Default Value: false
Chart types: Treemap
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"
Chart types: 3D Toolbar
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
Chart types: Boxplot,3D Toolbar,Treemap
borderBottom
border-bottom
NumberSets the object's bottom border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
Chart types: Treemap
borderColor
border-color
StringSets the border color of the object.
Default Value: '#000'
Chart types: Boxplot,3D Toolbar,Treemap
borderLeft
border-left
NumberSets the object's left border style. Accepts solid, dashed, and dotted styles.
Chart types: Treemap
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
Chart types: Treemap
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
Chart types: Treemap
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
Chart types: Treemap
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
Chart types: Treemap
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
Chart types: Treemap
borderRight
border-right
NumberSets the object's right border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
Chart types: Treemap
borderTop
border-top
NumberSets the object's top border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
Chart types: Treemap
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
Chart types: Boxplot,3D Toolbar,Treemap
classStringSets a class value on the object.
Default Value: null
Chart types: Boxplot,3D Toolbar,Treemap
clipText
clip-text
BooleanTruncates text based on the setting of width.
Default Value: false
Chart types: Treemap
colorStringSets the object's font color. Similar to font-color.
Default Value: '#000'
Chart types: Treemap
cursorStringSets the cursor type when hovering over the object.
Accepted Values: ['alias', 'all-scroll', 'arrow', 'auto', 'cell', 'col-resize', 'context-menu', 'copy', 'crosshair', 'default', 'e-resize', 'ew-resize', 'hand', 'help', 'move', 'n-resize', 'ne-resize', 'nesw-resize', 'no-drop', 'none', 'not-allowed', 'ns-resize', 'nw-resize', 'nwse-resize', 'pointer', 'progress', 'row-resize', 's-resize', 'se-resize', 'sw-resize', 'text', 'vertical-text', 'w-resize', 'wait']
Default Value: 'auto'
Introduced in: v1.9.0
Chart types: Treemap
dataN
data-n
AnyPrefix attribute or array using "data-" to define a custom token.
Chart types: Boxplot,3D Toolbar,Treemap
fillAngle
fill-angle
NumberSets the angle of the axis along which the linear gradient is drawn.
Default Value: 90
Chart types: Boxplot,3D Toolbar,Treemap
fillOffsetX
fill-offset-x
NumberSets an X offset to apply to the fill.
Default Value: 0
Chart types: Boxplot,3D Toolbar,Treemap
fillOffsetY
fill-offset-y
NumberSets a Y offset to apply to the fill.
Default Value: 0
Chart types: Boxplot,3D Toolbar,Treemap
fillType
fill-type
StringSets the background gradient fill type to either linear or radial.
Accepted Values: ['linear', 'none', 'radial']
Default Value: 'linear'
Chart types: Boxplot,3D Toolbar,Treemap
flatBooleanSet to true disables the chart interactivity.
Default Value: false
Chart types: Treemap
fontColor
font-color
StringSets the font color of the text.
Chart types: Treemap
fontFamily
font-family
StringSets the text's font family.
Chart types: Treemap
fontSize
font-size
NumberSets the text's font size.
Chart types: Treemap
fontStyle
font-style
StringSets the text's font style.
Accepted Values: ['normal', 'italic', 'oblique', 'none']
Chart types: Treemap
fontWeight
font-weight
Number, StringSets the text's font weight. Similar to bold.
Accepted Values: ['bold', 'none', 'normal', `${string}`]
Default Value: 'normal'
Chart types: Treemap
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: ''
Chart types: Boxplot,3D Toolbar,Treemap
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: ''
Chart types: Boxplot,3D Toolbar,Treemap
hoverState
hover-state
ObjectSets the hover state styles of the object.
Chart types: Boxplot,Treemap
idStringSets the id of the object.
Default Value: ''
Chart types: Boxplot,3D Toolbar,Treemap
italicBooleanSets whether the text is displayed with italicized characters or not.
Default Value: false
Chart types: Treemap
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
Chart types: Boxplot,Treemap
lineHeight
line-height
NumberSets the height of a line box.
Default Value: -1
Chart types: Treemap
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
Chart types: Boxplot,Treemap
lineStyle
line-style
StringSets the line style of the object.
Accepted Values: ['dashdot', 'dashed', 'dotted', 'solid']
Default Value: ''
Chart types: Boxplot,Treemap
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
Chart types: Treemap
mediaRules
media-rules
Array.<Object>Configure media rules.
Chart types: Boxplot,Treemap
offsetX
offset-x
NumberSets an x-offset to apply when positioning the object.
Chart types: 3D Toolbar,Treemap
offsetY
offset-y
NumberSets an y-offset to apply when positioning the object.
Chart types: 3D Toolbar,Treemap
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
Chart types: Treemap
paddingBottom
padding-bottom
NumberSets the object's bottom padding around the text.
Default Value: 2
Chart types: Treemap
paddingLeft
padding-left
NumberSets the object's left padding around the text.
Default Value: 2
Chart types: Treemap
paddingRight
padding-right
NumberSets the object's right padding around the text.
Default Value: 2
Chart types: Treemap
paddingTop
padding-top
NumberSets the object's top padding around the text.
Default Value: 2
Chart types: Treemap
rectShortcut
rect-shortcut
BooleanUsed to force the library to create rectangles using a faster drawing API (instead of painting them like a closed polygon). However, using this would disable effects like rounded borders. It is a performance setting for edge cases.
Default Value: false
Chart types: Treemap
rtlBooleanRenders text right-to-left. Default value is false.
Default Value: false
Chart types: Treemap
shadowBooleanSets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation.
Default Value: false
Chart types: Boxplot
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
Chart types: Boxplot
shadowAngle
shadow-angle
NumberSets the angle of the shadow underneath the object.
Default Value: 45
Chart types: Boxplot
shadowBlur
shadow-blur
NumberSets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation.
Default Value: 0
Chart types: Boxplot
shadowColor
shadow-color
StringSets the color of the shadow of the object.
Default Value: '#999'
Chart types: Boxplot
shadowDistance
shadow-distance
NumberSets the distance between the shadow and the object.
Default Value: 2
Chart types: Boxplot
textAlign
text-align
StringSets the alignment of the object.
Accepted Values: ['center', 'bottom', 'left', 'middle', 'right']
Default Value: 'center'
Chart types: Treemap
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
Chart types: Treemap
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'
Chart types: Treemap
tooltipObjectConfigures the tooltip element, which appears when hovering over an object.
Introduced in: v2.1.0
Chart types: Boxplot,Treemap
underlineBooleanSets whether the text is displayed with underlined characters or not.
Default Value: false
Chart types: Treemap
visibleBooleanSets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
Default Value: true
Chart types: Boxplot,Treemap
wrapText
wrap-text
BooleanSets whether the text will wrap, depending on the width of the object.
Default Value: false
Chart types: Treemap
zIndex
z-index
NumberSets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values.
Default Value: 1
Chart types: Treemap