graph » color-scale » media-rules

media-rules

[ root » graph » color-scale » 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.



AttributeTypeDescription
alphaNumberSets the opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0.
aspectStringSets the styling aspect for the colorScale data
Accepted Values: ['gradient', 'intervals']
Default Value: 'gradient'
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
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
Chart types: Color Scale
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
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
borderColor
border-color
StringSets the border color of the object.
Default Value: '#000'
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
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
classStringSets a class value on the object.
Default Value: null
colorStringFor the 'gradient' aspect, use the 'color' attribute to set the primary color for the choropleth map. The library will automatically lighten and darken the color depending on the effect attribute.
Default Value: '#369'
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
colorsArray.<String>When using the 'intervals' aspect, set the color for each interval with the 'colors' array.
Default Value: []
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
cursorObjectStyles the cursor that appears on the color scale when hovering over a map item
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
dataN
data-n
AnyPrefix attribute or array using "data-" to define a custom token.
effectStringSets the gradient effect when using the 'color' attribute and 'gradient' aspect.
Accepted Values: ['lighten', 'darken']
Default Value: 'lighten'
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
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'
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: ''
guideObjectStyles the grid lines on the scale (on the ends and at the midpoint)
Default Value: {}
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
heightNumberSets the object's height.
idStringSets the id of the object.
Default Value: ''
intervalsNumberSets the number of choropleth intervals or levels.
Default Value: 4
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
layoutStringDefines the layout of the items of the object.
Accepted Values: ['h', 'v']
Default Value: 'v'
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
mapBooleanSets whether or not to copy: ['aspect', 'intervals', 'color', 'maxPercent', 'effect', 'progression', 'minValue', 'maxValue', 'steps', 'colors', 'labels', 'mirrored'] from the choropleth object
Default Value: false
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps,Color Scale
marginNumber, StringSets the margin on the color scale
Accepted Values: ['dynamic']
Default Value: 'auto 10 auto auto'
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
maxHeight
max-height
NumberSets the maximum chart height in pixels.
Introduced in: v2.4.1
maxPercent
max-percent
NumberSets the maximum percentage that a color will be lightened or darkened
Default Value: 50
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
maxValue
max-value
NumberSets the maximum value on the color scale.
Default Value: 10
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
maxWidth
max-width
NumberSets the maximum chart width in pixels.
Introduced in: v2.4.1
minHeight
min-height
NumberSets the minimum chart height in pixels.
Introduced in: v2.4.1
minValue
min-value
NumberSets the minimum value on the color scale.
Default Value: 0
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
minWidth
min-width
NumberSets the minimum chart width in pixels.
Introduced in: v2.4.1
mirroredBooleanMirrors the color scale values when using a gradient.
Default Value: false
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
progressionStringSets whether the color scale should be analyzed on a linear ('lin') or logarithmic ('log') scale.
Accepted Values: ['lin', 'linear', 'log']
Default Value: 'lin'
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
stepsArray.<Number,String>When using the 'intervals' aspect, set the choropleth value thresholds as an array of numbers.
Default Value: []
Introduced in: v2.8.4
Chart types: Color Scale,Interactive-maps
visibleBooleanSets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
Default Value: true
widthNumberSets the object's width.
xNumberSets the X position of the object.
Default Value: -1
yNumberSets the Y position of the object.
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