AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.standalones.Background Improve this Doc

Methods Overview

Specific settings
cornerType()Corner type.
corners()Corner radius.
Coloring
fill()Fill settings.
stroke()Stroke settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Removes all listeners.
unlisten()Removes the listener.
unlistenByKey()Removes the listener by the key.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
parentBounds()Parent bounds settings.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
Miscellaneous
container()Getter for the background current container.
draw()Draw background.

Methods Description

bottom

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

anychart.standalones.Background - Returns self for method chaining.

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.standalones.Background - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.standalones.Background - Self instance for method chaining.

container

Getter for the background current container.

Returns:

string | Element - The current container.
Setter for the background container.

Params:

NameTypeDescription
valuestring | ElementThe value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.

cornerType

Getter for the corner type.

Returns:

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

Params:

NameTypeDefaultDescription
valueanychart.enums.BackgroundCornersType
"round"
Value to set.

Returns:

anychart.standalones.Background - 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
valuenumber | string | Array.<number>
0
Value to set.

Returns:

anychart.standalones.Background - 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.standalones.Background - Self instance for method chaining.

draw

Draw background.

Returns:

anychart.standalones.Background - Self instance for method chaining.

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

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

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill
"#fff"
Fill as an object or a string.

Returns:

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

Params:

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

Returns:

anychart.standalones.Background - 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.standalones.Background - 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.standalones.Background - Self instance for method chaining.

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

height

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.
Sets element height setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

anychart.standalones.Background - Returns self for method chaining.

left

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

anychart.standalones.Background - Returns self for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method. Function that looks like function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

maxHeight

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.
Setter for maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.

maxWidth

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.
Setter for maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.

minHeight

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.
Setter for minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.

minWidth

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.
Setter for minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.

parentBounds

Getter for bounds. As a getter falls back to stage bounds.

Returns:

anychart.math.Rect - Current bounds.
Setter for bounds using single value.

Params:

NameTypeDescription
valueanychart.math.Rect | Object | nullValue to set

Returns:

anychart.standalones.Background - Self instance for method chaining.
Setter for bounds using several value.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberA width for a background.
heightnumberA height for a background.

Returns:

anychart.standalones.Background - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

anychart.standalones.Background - Returns self 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
valueanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
"none"
Stroke formatted as "[thickness ]color[ opacity]".

Returns:

anychart.standalones.Background - Self instance for method chaining.
Setter for 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".
lineJoinanychart.graphics.vector.StrokeLineJoinLine join style.
lineCapanychart.graphics.vector.StrokeLineCapLine cap style.

Returns:

anychart.standalones.Background - Self instance for method chaining.

top

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

anychart.standalones.Background - Returns self for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for element width setting.

Returns:

number | string | undefined - Current element's width setting.
Sets element width setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

anychart.standalones.Background - Returns self for method chaining.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.standalones.Background - Self instance for method chaining.