graph » preview

preview

[ root » graph » preview ]

Preview charts are a miniaturized version of the main chart, allowing users to zoom in and examine sections of a chart while still viewing it in its entirety. Use the preview object to style the object, active area, background area, and preview chart handles. Refer to the Zooming, Scrollbar, and Preview Chart Tutorial for more information.

Note: Make sure the zooming attribute is set to true in the scale-x and/or scale-y object(s). You can also specify the starting and ending values that the chart will zoom to by default with the zoom-to or zoom-to-values array.



AttributeTypeDescription
activeObjectSets the styling for the active area of the preview chart.
alphaNumberSets the transparency level of 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
asyncBooleanDetaches the action of the preview (zooming) to the actual zooming of the scales, leaving to the user the option to perform other logic which depends on the preview state.
Default Value: false
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.
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
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
borderString,NumberSets 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'
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
classStringSets a class value on the object.
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
String,NumberSets the background gradient fill type to either linear or 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: ''
handleObjectSets the styling for the handle portions of the preview chart. Use the handle-left, handle-right, handle-top, and/or handle-bottom object(s) in the preview object. To apply the same styling to all of the handles, use the handle object.
handleBottom
handle-bottom
ObjectSets the styling for the bottom handle portion of the preview chart. To apply the same styling to all of the handles, use the handle object.
handleLeft
handle-left
ObjectSets the styling for the left handle portion of the preview chart. To apply the same styling to all of the handles, use the handle object.
handleRight
handle-right
ObjectSets the styling for the right handle portion of the preview chart. To apply the same styling to all of the handles, use the handle object.
handleTop
handle-top
ObjectSets the styling for the top handle portion of the preview chart. To apply the same styling to all of the handles, use the handle object.
idStringSets the id of the object.
Default Value: ''
labelObjectUse the label object to customize the scale title for preview.
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
String,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
lineJoin
line-join
StringSets the stroke-linejoin attribute on SVGs
Accepted Values: ['round', 'miter']
Default Value: 'round'
lineSegmentSize
line-segment-size
String,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.
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
liveBooleanSets whether the chart is updated when the preview active area is being moved. Default is false for classic theme and true for light/dark themes. The graph will update only when a the mouse is released.
Default Value: false
maskObjectSets the styling for the background area of the preview chart.
minDistanceX
min-distance-x
NumberSets the minimum width of preview's active area.
Default Value: 0
minDistanceY
min-distance-y
NumberSets the minimum height of preview's active area.
Default Value: 0
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
String,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
String,NumberSets the distance between the shadow and the object.
Default Value: 2
visibleBooleanSets whether the preview is visible or not.
Default Value: true
visibleBooleanSets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
Default Value: true