gui » context-menu » button

button

[ root » gui » context-menu » button ]

Use the button object to create a context menu button for your chart. You must add a visible attribute set to true for the button to appear. Refer to the Context Menu Tutorial for more information.

Note: If you are creating charts that will be primarily viewed on mobile devices, we recommend using the ZingChart mobile charts plugin. The plugin allows for the utilization of touch gestures and includes a mobile context menu.

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
anchor	String	Allows you to set an object's anchor position Accepted Values: ['tl', 'tr', 'bl', 'br', 'c', 't', 'r', 'b', 'l'] Default Value: 'tl'
angle	Number	Sets the rotation angle of the object.
angleEnd angle-end	Number	Sets the end angle of a pie shape. Default Value: 360
angleStart angle-start	Number	Sets the beginning angle of a pie shape. Default Value: 0
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
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'
cursor	String	Sets 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
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'
flat	Boolean	Set to true disables the chart interactivity. Default Value: false
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
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
lineCap line-cap	String	Sets the stroke-linecap attribute on SVGs Accepted Values: ['butt', 'round', 'square'] Default Value: 'butt'
lineColor line-color	String	Sets 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	Number	Can 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	Number	Sets the height of a line box. Default Value: -1
lineJoin line-join	String	Sets the stroke-linejoin attribute on SVGs Accepted Values: ['round', 'miter'] Default Value: 'round'
lineSegmentSize line-segment-size	Number	Can 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	String	Sets the line style of the object. Accepted Values: ['dashdot', 'dashed', 'dotted', 'solid'] Default Value: ''
lineWidth line-width	Number	Sets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes. Default Value: 0
lockRotation lock-rotation	Boolean	Set to lock scale labels in place and not rotate with viewing angle in 3D charts. Chart types: 3D Charts
margin	Number	Sets the object's margin/s from the top-left of the chart. Default Value: 0
marginBottom margin-bottom	Number	Sets the object's bottom margin. Default Value: -1
marginLeft margin-left	Number	Sets the object's left margin. Default Value: -1
marginRight margin-right	Number	Sets the object's right margin. Default Value: -1
marginTop margin-top	Number	Sets the object's top margin. 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
maxWidth max-width	Number	Sets a maximum width of the object.
mediaRules media-rules	Array.<Object>	Configure media rules.
offsetR offset-r	Number	Sets an R offset to apply when positioning the object. Default Value: 0 Chart types: Pie
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.
offsetZ offset-z	Number	Sets a Z offset to apply when positioning the object. Default Value: 0
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
points	Array.<any>	Sets the coordinates of the object/shape points. Default Value: []
position	String	Sets the object's position relative to its container. Similar results can be obtained by setting [margin] and [margin-...] attributes. Uses x,y coordinates originating from the top left of the chart. Default Value: ''
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
shadow	Boolean	Sets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation. Default Value: false
shadowAlpha shadow-alpha	Number	Sets 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	Number	Sets the angle of the shadow underneath the object. Default Value: 45
shadowBlur shadow-blur	Number	Sets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation. Default Value: 0
shadowColor shadow-color	String	Sets the color of the shadow of the object. Default Value: '#999'
shadowDistance shadow-distance	Number	Sets the distance between the shadow and the object. Default Value: 2
size	Number	Sets the size of the object. Default Value: ''
size2 size-2	Number	Sets the secondary size of the object. Used on ellipses or rectangle shapes. Default Value: 0
slice	Number	Sets the radius of the ring in chart. Accepts percentage or pixel value. Default Value: 0
target	String	Sets the target of the object. Accepted Values: ['_blank', '_top', '_parent', `_window=${string}`, 'graph', `graph=${string}`] Default Value: null
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'
type	String	Sets the type of the object. For shapes, accepted values: ['arc', 'arrow', 'circle', 'cross', 'diamond', 'ellipse', 'gear3', 'gear4', 'gear5', 'gear6', 'gear7', 'gear8', 'gear9', 'hamburger', 'line', 'none', 'parallelogram', 'pie', 'plus', 'poly', 'rect', 'rectangle', 'rpoly3', 'rpoly4', 'rpoly5', 'rpoly6', 'rpoly7', 'rpoly8', 'rpoly9', 'square', 'star3', 'star4', 'star5', 'star6', 'star7', 'star8', 'star9', 'trapezoid', 'triangle']. Additional accepted shape value to detect if map is used: ['zingchart.maps']. For legendmarker, accepted values are the same as shapes but also includes the following to match marker type set to series: ['default', 'inherit', 'match']. Accepted Values: ['arc', 'arrow', 'circle', 'cross', 'default', 'diamond', 'ellipse', 'gear3', 'gear4', 'gear5', 'gear6', 'gear7', 'gear8', 'gear9', 'hamburger', 'inherit', 'line', 'match', 'none', 'parallelogram', 'pie', 'plus', 'poly', 'rect', 'rectangle', 'rpoly3', 'rpoly4', 'rpoly5', 'rpoly6', 'rpoly7', 'rpoly8', 'rpoly9', 'square', 'star3', 'star4', 'star5', 'star6', 'star7', 'star8', 'star9', 'trapezoid', 'triangle', 'zingchart.maps'] Default Value: 'poly'
underline	Boolean	Sets whether the text is displayed with underlined characters or not. Default Value: false
url	String	Sets an URL associated with this object. Used mostly on nodes/labels/shapes with their associated click events. Default Value: null
verticalAlign vertical-align	String	Sets vertical alignment of the object. Accepted Values: ['top', 'middle', 'bottom'] Default Value: 'middle'
visible	Boolean	Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
width	Number	Sets the object's width. Default Value: 0
wrapText wrap-text	Boolean	Sets whether the text will wrap, depending on the width of the object. Default Value: false
x	Number	Sets the X position of the object. Default Value: -1
y	Number	Sets the Y position of the object.
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
zSort z-sort	Number	Used to force the sorting of the active areas (which trigger the tooltip) of two shapes in case they overlap. Default Value: 1