Top

class anychart.core.utils.Quarter Improve this Doc

Extends: anychart.core.ui.Background

Quarter settings representation class.

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.
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:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"none"
Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.core.ui.Background - Self instance for method chaining.
Setter for bottom stroke settings.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Stroke settings.
thickness number Line thickness. Defaults to 1 of not set.
dashpattern string Controls 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".
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

cornerType

Getter for the corner type.

Returns:

anychart.enums.BackgroundCornersType - Corners type.

Try it:

Setter for the corner type.

Params:

Name Type Default Description
value anychart.enums.BackgroundCornersType
"round"
Value to set.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

corners

Getter for the corner radius.

Returns:

Array.<number> - Corner settings.

Try it:

Setter for the corner radius by one value.

Params:

Name Type Default Description
value number | string | Array.<number>
0
Value to set.

Returns:

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

Params:

Name Type Description
topLeft number | string Top left corner value.
topRight number | string Top right corner value.
bottomRight number | string Bottom left corner value.
bottomLeft number | string Bottom right corner value.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

fill

Getter for the background fill.

Returns:

anychart.graphics.vector.Fill - Fill settings (empty fill is always "none").

Try it:

Setter for fill settings using an object 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:

Name Type Default Description
value anychart.graphics.vector.Fill
"#fff"
Fill as an object or a string.

Returns:

anychart.core.ui.Background - Self instance for method chaining.
Fill as a color with opacity.

Params:

Name Type Default Description
color string
"#fff"
Fill as a string.
opacity number
Fill opacity.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Linear gradient fill.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

Radial gradient fill.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

label

Getter for quarter label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - An instance of class.

Try it:

Setter for quarter label.

Params:

Name Type Default Description
value null | 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:

Name Type Default Description
index string | number
Label index.
value null | 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:

Name Type Default Description
value anychart.graphics.vector.Stroke | string | null
"none"
Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.core.ui.Background - Self instance for method chaining.
Setter for left stroke settings.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Stroke settings.
thickness number Line thickness. Defaults to 1 of not set.
dashpattern string Controls 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".
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

margin

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

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value 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));

Try it:

Setter for the quarter margin in pixels using several simple values.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | 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);

Try it:

padding

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

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value 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%"}});

Try it:

Setter for the quarter paddings in pixels using several numbers.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | 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);

Try it:

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:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"none"
Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.core.ui.Background - Self instance for method chaining.
Setter for right stroke settings.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Stroke settings.
thickness number Line thickness. Defaults to 1 of not set.
dashpattern string Controls 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".
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

stroke

Getter for the background stroke.

Returns:

anychart.graphics.vector.Stroke - Returns stroke.

Try it:

Setter for stroke settings using one parameter.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"none"
Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.core.ui.Background - Self instance for method chaining.
Setter for stroke settings.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Stroke settings.
thickness number Line thickness. Defaults to 1 of not set.
dashpattern string Controls 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".
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it:

title

Getter for the title.

Returns:

anychart.core.ui.Title - Title settings.

Try it:

Setter for the title.

Params:

Name Type Description
value null | boolean | Object | string Value 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:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"none"
Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.core.ui.Background - Self instance for method chaining.
Setter for top stroke settings.

Params:

Name Type Description
value anychart.graphics.vector.Stroke | string Stroke settings.
thickness number Line thickness. Defaults to 1 of not set.
dashpattern string Controls 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".
lineJoin anychart.graphics.vector.StrokeLineJoin Line join style.
lineCap anychart.graphics.vector.StrokeLineCap Line cap style.

Returns:

anychart.core.ui.Background - Self instance for method chaining.

Try it: