graph » scale-r » markers » label » media-rules
media-rules
[ root » graph » scale-r » markers » label » media-rules]
Media rules allow for the creation of responsive charts by changing how the chart and its various objects appear at different breakpoints (or chart dimensions). You can create media rules based on the width and/or height of the chart. Try interacting with the following chart. Refer to the Media Rules Tutorial for more information.
| Attribute | Type | Description |
|---|---|---|
| align | String | Sets the alignment of the object. Accepted Values: ['left', 'center', 'right'] |
| alpha | Number | Sets 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 |
| angle | Number | Sets the rotation angle of the object. |
| backgroundClip background-clip | Boolean | Clips the background image to the margins of the shape/box. Default Value: true |
| backgroundColor background-color | String | Sets 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 | String | Sets 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 | String | Sets 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 | String | Sets the direction/s on which the background image is being "stretched". Default Value: '' |
| backgroundImage background-image | String | Sets 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 | String | Sets the position of the background when the background-repeat value is no-repeat. Default Value: '50% 50%' |
| backgroundRepeat background-repeat | Boolean, String | Sets the repeating mode for the background image. Default Value: 'repeat' |
| backgroundScale background-scale | Number | Scales the background image using the specified ratio. Default Value: 1 |
| bold | Boolean | Sets whether the text is displayed with bold characters or not. Default Value: false |
| border | Number | Sets 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 | Number | Sets 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 | Number | Sets the object's bottom border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderColor border-color | String | Sets the border color of the object. Default Value: '#000' |
| borderLeft border-left | Number | Sets the object's left border style. Accepts solid, dashed, and dotted styles. |
| borderRadius border-radius | Number | 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; 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 | Number | 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. Default Value: 0 |
| borderRadiusBottomRight border-radius-bottom-right | Number | 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. Default Value: 0 |
| borderRadiusTopLeft border-radius-top-left | Number | 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. Default Value: 0 |
| borderRadiusTopRight border-radius-top-right | Number | 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. Default Value: 0 |
| borderRight border-right | Number | Sets the object's right border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderTop border-top | Number | Sets the object's top border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderWidth border-width | Number | Sets the border width of the object. Default Value: 0 |
| callout | Boolean | Sets whether an object will have a callout arrow or not. Default Value: false |
| calloutExtension callout-extension | Number | Sets the length of the extension that extends beyond the tip of the callout arrow. Default Value: 0 |
| calloutHeight callout-height | Number | Sets the height of the object's callout arrow. A larger value will create a taller callout arrow. Default Value: 8 |
| calloutHook callout-hook | Array.<Number> | Sets the point of the tip of the callout arrow to a specified coordinate on the chart, with the starting point of [0,0] being the top left corner of the chart. Default Value: null |
| calloutOffset callout-offset | Number | Sets the offset along the callout direction of the arrow's base. Positive and negative values can be used to offset the callout arrow up, down, left, or right depending on the callout-position. Default Value: 0 |
| calloutPosition callout-position | String | Sets the position for the object's callout arrow. The position is "bottom" by default. Default Value: 'bottom' |
| calloutRatio callout-ratio | Array.<Number> | Sets how much to stretch/squeeze the callout arrow on its two sides. A zero value for example on one side would create like a half callout arrow. Negative values can also be set, in order to create various aspects. Default Value: [1, 1] |
| calloutWidth callout-width | Number | Sets the width of the object's callout arrow. A larger value will create a wider callout arrow. Default Value: 8 |
| centerRef center-ref | Boolean | Sets the (0,0) x/y coordinates as the center of the box (instead of the top-left corner). Default Value: false |
| class | String | Sets a class value on the object. Default Value: null |
| clipText clip-text | Boolean | Truncates text based on the setting of width. Default Value: false |
| color | String | Sets the object's font color. Similar to font-color. Default Value: '#000' |
| dataN data-n | Any | Prefix attribute or array using "data-" to define a custom token. |
| fillAngle fill-angle | Number | Sets the angle of the axis along which the linear gradient is drawn. Default Value: 90 |
| fillOffsetX fill-offset-x | Number | Sets an X offset to apply to the fill. Default Value: 0 |
| fillOffsetY fill-offset-y | Number | Sets a Y offset to apply to the fill. Default Value: 0 |
| fillType fill-type | String | Sets the background gradient fill type to either linear or radial. Accepted Values: ['linear', 'none', 'radial'] Default Value: 'linear' |
| fontAngle font-angle | Number | Sets the text's angle. A positive value will rotate the object by that number of degrees clockwise, while a negative value. |
| fontColor font-color | String | Sets the font color of the text. |
| fontFamily font-family | String | Sets the text's font family. |
| fontSize font-size | Number | Sets the text's font size. |
| fontStyle font-style | String | Sets the text's font style. Accepted Values: ['normal', 'italic', 'oblique', 'none'] |
| fontWeight font-weight | Number, String | Sets the text's font weight. Similar to bold. Accepted Values: ['bold', 'none', 'normal', `${string}`] Default Value: 'normal' |
| gradientColors gradient-colors | String | Sets 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 | String | Sets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors. Default Value: '' |
| height | Number | Sets the object's height. Default Value: 0 |
| hook | String | Hooks the label to specified node or scale index.
The plot value refers to the index of a series object and index refers to the specific value within series.
Ex. "node:index=4" | "node:plot=0,index=1" | "scale:name=scale-y,index=3" | "scale:value=1420501300000" (timestamp). Default Value: null |
| id | String | Sets the id of the object. Default Value: '' |
| italic | Boolean | Sets whether the text is displayed with italicized characters or not. Default Value: false |
| lineHeight line-height | Number | Sets the height of a line box. Default Value: -1 |
| maxChars max-chars | Number | 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 "..." Default Value: 0 |
| maxHeight max-height | Number | Sets the maximum chart height in pixels. Introduced in: v2.4.1 |
| maxWidth max-width | Number | Sets the maximum chart width in pixels. Introduced in: v2.4.1 |
| maxWidth max-width | Number | Sets a maximum width of the object. |
| minHeight min-height | Number | Sets the minimum chart height in pixels. Introduced in: v2.4.1 |
| minWidth min-width | Number | Sets the minimum chart width in pixels. Introduced in: v2.4.1 |
| offsetX offset-x | Number | Sets an x-offset to apply when positioning the object. |
| offsetY offset-y | Number | Sets an y-offset to apply when positioning the object. |
| overlap | Boolean | Sets whether the object allows overlapping with other labels. If false, and two objects overlap, only one will be displayed. Default Value: true |
| padding | Number | 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. Default Value: null |
| paddingBottom padding-bottom | Number | Sets the object's bottom padding around the text. Default Value: 2 |
| paddingLeft padding-left | Number | Sets the object's left padding around the text. Default Value: 2 |
| paddingRight padding-right | Number | Sets the object's right padding around the text. Default Value: 2 |
| paddingTop padding-top | Number | Sets the object's top padding around the text. Default Value: 2 |
| rectShortcut rect-shortcut | Boolean | Used 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 |
| rtl | Boolean | Renders text right-to-left. Default value is false. Default Value: false |
| text | String | Sets the text content of the object. Default Value: null |
| textAlign text-align | String | Sets the alignment of the object. Accepted Values: ['center', 'bottom', 'left', 'middle', 'right'] Default Value: 'center' |
| textAlpha text-alpha | Number | Sets 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 | String | 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. Default Value: 'none' |
| underline | Boolean | Sets whether the text is displayed with underlined characters or not. Default Value: false |
| verticalAlign vertical-align | String | Sets vertical alignment of the object. Accepted Values: ['top', 'middle', 'bottom'] Default Value: 'middle' |
| width | Number | Sets the object's width. Default Value: 0 |
| zIndex z-index | Number | Sets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values. Default Value: 1 |