AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.utils.Quarter Improve this Doc

Extends: anychart.core.ui.Background

Quarter settings representation class.
Learn more about the quarters.

Methods Overview

Specific settings
cornerType()Corner type.
corners()Corner radius.
title()Title settings.
Chart Controls
label()Label settings.
Coloring
bottomStroke()Bottom stroke settings.
fill()Fill settings.
leftStroke()Left stroke settings.
rightStroke()Right stroke settings.
stroke()Stroke settings.
topStroke()Top stroke settings.
Content Text Settings
disablePointerEvents()Pointer events settings.
Size and Position
margin()Margin settings.
padding()Padding settings.

Methods Description

bottomStroke

Getter for the bottom stroke.

Returns:

anychart.graphics.vector.Stroke - Returns bottom stroke.
See listing
var bottomStroke = background.bottomStroke();
Setter for bottom stroke settings using one parameter.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Object
'none'
Stroke formatted as '[thickness ]color[ opacity]'.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Setter for bottom stroke settings.

Params:

NameTypeDescription
valueanychart.graphics.vector.Stroke | stringStroke settings.
thicknessnumberLine thickness. Defaults to 1 of not set.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: '5 3 2' is equivalent to dashpattern: '5 3 2 5 3 2'.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

cornerType

Getter for the corner type.

Returns:

anychart.enums.BackgroundCornersType | string - Corners type.
Setter for the corner type.

Params:

NameTypeDefaultDescription
typeanychart.enums.BackgroundCornersType | string
'round'
Value to set.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

corners

Getter for the corner radius.

Returns:

Array.<number> - Corner settings.
Setter for the corner radius by one value.

Params:

NameTypeDefaultDescription
cornersnumber | string | Array.<number>
0
Value to set.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Setter for the corner radius by each value.

Params:

NameTypeDescription
topLeftnumber | stringTop left corner value.
topRightnumber | stringTop right corner value.
bottomRightnumber | stringBottom left corner value.
bottomLeftnumber | stringBottom right corner value.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

disablePointerEvents

Getter for the pointer events settings.

Returns:

boolean - The pointer events settings.
See listing
var quarters = chart.quarters();
var disablePointerEvents = quarters.disablePointerEvents();
Setter for the pointer events settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

fill

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill - Fill settings (empty fill is always 'none').
Setter for fill settings using an object, an array or a string.
Accepts: or a color as a string, along with opacity, if needed, format is "Color Opacity", e.g. "red 0.5".

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Fill as an object, an array or a string.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Fill as a color with opacity.

Params:

NameTypeDefaultDescription
colorstring
"#fff"
Fill as a string.
opacitynumber
Fill opacity.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Linear gradient fill.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Radial gradient fill.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

label

Getter for quarter label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - An instance of class.
Setter for quarter label.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for quarter label.

Params:

NameTypeDefaultDescription
indexstring | number
Label index.
settingsnull | boolean | Object | string
false
Chart label settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

leftStroke

Getter for the left stroke.

Returns:

anychart.graphics.vector.Stroke - Returns left stroke.
See listing
var leftStroke = background.leftStroke();
Setter for left stroke settings using one parameter.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | string | null | Object
'none'
Stroke formatted as '[thickness ]color[ opacity]'.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Setter for left stroke settings.

Params:

NameTypeDescription
valueanychart.graphics.vector.Stroke | stringStroke settings.
thicknessnumberLine thickness. Defaults to 1 of not set.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: '5 3 2' is equivalent to dashpattern: '5 3 2 5 3 2'.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

margin

Setter for the quarter margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
marginArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Margin to set.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));
Setter for the quarter margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, '15px');
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, '15px', 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, '15px', '5px', 12);

padding

Setter for the quarter paddings in pixels using a single value.

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Padding to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: '40%'}});
Setter for the quarter paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, '15px');
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, '15px', 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, '15%', '5px', 12);

rightStroke

Getter for the right stroke.

Returns:

anychart.graphics.vector.Stroke - Returns right stroke.
See listing
var rightStroke = background.rightStroke();
Setter for right stroke settings using one parameter.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Object
'none'
Stroke formatted as '[thickness ]color[ opacity]'.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Setter for right stroke settings.

Params:

NameTypeDescription
valueanychart.graphics.vector.Stroke | stringStroke settings.
thicknessnumberLine thickness. Defaults to 1 of not set.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: '5 3 2' is equivalent to dashpattern: '5 3 2 5 3 2'.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

stroke

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke - Returns stroke.
Setter for stroke settings using one parameter.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Object
'none'
Stroke formatted as '[thickness ]color[ opacity]'.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Setter for stroke settings.

Params:

NameTypeDescription
coloranychart.graphics.vector.Stroke | stringStroke settings.
thicknessnumberLine thickness. Defaults to 1 of not set.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: '5 3 2' is equivalent to dashpattern: '5 3 2 5 3 2'.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

title

Getter for the title.

Returns:

anychart.core.ui.Title - Title settings.
Setter for the title.

Params:

NameTypeDescription
settingsnull | boolean | Object | stringValue to set.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.

topStroke

Getter for the top stroke.

Returns:

anychart.graphics.vector.Stroke - Returns top stroke.
See listing
var topStroke = background.topStroke();
Setter for top stroke settings using one parameter.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Object
'none'
Stroke formatted as '[thickness ]color[ opacity]'.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.
Setter for top stroke settings.

Params:

NameTypeDescription
valueanychart.graphics.vector.Stroke | stringStroke settings.
thicknessnumberLine thickness. Defaults to 1 of not set.
dashpatternstringControls the pattern of dashes and gaps used to stroke paths. Dash array contains a list of white space separated lengths and percentages that specify the lengths of alternating dashes and gaps. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. Thus, stroke dashpattern: '5 3 2' is equivalent to dashpattern: '5 3 2 5 3 2'.
lineJoinstring | anychart.graphics.vector.StrokeLineJoinLine join style.
lineCapstring | anychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.core.utils.Quarter - Self instance for method chaining.