class anychart.core.resource.ResourceList Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Resource list constructor.

Methods Overview

Specific settings
drawBottomLine()	Drawing of the bottom line.
drawLeftLine()	Drawing of the left line.
drawRightLine()	Drawing of the right line.
drawTopLine()	Drawing of the top line.
images()	Images settings.
Coloring
background()	Background settings.
evenFill()	Even fill settings.
oddFill()	Odd 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.
right()	Right bound setting.
top()	Top bound setting.
width()	Width setting.
zIndex()	Z-index of the element.
Text settings
descriptions()	Descriptions settings.
names()	Names settings.
overlay()	Overlay element.
tags()	Tags settings.
types()	Types settings.

Methods Description

background

background()Since version 7.12.0

Getter for the background.

Returns:

anychart.core.ui.Background - Background instance.

Try it:

Usage sample

background(value)Since version 7.12.0

Setter for the background.

Detailed description

Sets background settings depending on parameter type:

null/boolean - disable or enable background.
object - sets background settings.
string - sets background color.

Params:

Name	Type	Description
value	string \| Object \| null \| boolean	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

bottom

bottom()

Getter for element bottom bound setting.

Returns:

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

bottom(value)

Sets element bottom bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Bottom bound setting for the element.

Returns:

anychart.core.resource.ResourceList - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

descriptions

descriptions()Since version 7.12.0

Getter for descriptions.

Returns:

anychart.core.resource.resourceList.TextSettings - Returns a class to provide text settings for resource item descriptions.

Try it:

Usage sample

descriptions(value)Since version 7.12.0

Setter for descriptions.

Params:

Name	Type	Description
value	Object	Object with settings.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

drawBottomLine

drawBottomLine()Since version 7.12.0

Getter for the bottom line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawBottomLine();

drawBottomLine(value)Since version 7.12.0

Setter for the bottom line drawing flag.

Params:

Name	Type	Default	Description
value	boolean	true	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

drawLeftLine

drawLeftLine()Since version 7.12.0

Getter for the left line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawLeftLine();

drawLeftLine(value)Since version 7.12.0

Setter for the left line drawing flag.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

drawRightLine

drawRightLine()Since version 7.12.0

Getter for the right line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawRightLine();

drawRightLine(value)Since version 7.12.0

Setter for the right line drawing flag.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

drawTopLine

drawTopLine()Since version 7.12.0

Getter for the top line drawing flag.

Returns:

boolean - Drawing flag.

See listing

var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawTopLine();

drawTopLine(value)Since version 7.12.0

Setter for the top line drawing flag.

Params:

Name	Type	Default	Description
value	boolean	false	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

evenFill

evenFill()Since version 7.12.0

Getter for the even fill color.

Returns:

anychart.graphics.vector.Fill - The odd fill color.

See listing

var currentResourceList = chart.resourceList();
var evenFillSettings = currentResourceList.evenFill();

evenFill(value)Since version 7.12.0

Setter for even fill settings using an array or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an object or a string.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

evenFill(color, opacity)Since version 7.12.0

Even fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

evenFill(keys, angle, mode, opacity)Since version 7.12.0

Linear gradient even fill. Learn more about coloring.

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.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

evenFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.12.0

Radial gradient even fill. Learn more about coloring.

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.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

evenFill(imageSettings)Since version 7.12.0

Image even fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

getPixelBounds

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

height()

Getter for element height setting.

Returns:

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

height(value)

Sets element height setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Height setting for the element.

Returns:

anychart.core.resource.ResourceList - Returns self for method chaining.

Try it:

Usage sample

images

images()Since version 7.12.0

Getter for images.

Returns:

anychart.core.resource.resourceList.ImageSettings - Returns a class to provide settings for resource item images.

Try it:

Usage sample

images(value)Since version 7.12.0

Setter for images.

Params:

Name	Type	Description
value	Object	Object with settings for resource images.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

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

left(value)

Sets element left bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.resource.ResourceList - Returns self for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		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 }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

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

maxHeight(value)

Setter for maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

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

maxWidth(value)

Setter for maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

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

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

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

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

names

names()Since version 7.12.0

Getter for names.

Returns:

anychart.core.resource.resourceList.TextSettings - Returns a class to provide text settings for resource item names.

Try it:

Usage sample

names(value)Since version 7.12.0

Setter for names.

Params:

Name	Type	Description
value	Object	Object with settings.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

oddFill

oddFill()Since version 7.12.0

Getter for the odd fill color.

Returns:

anychart.graphics.vector.Fill - The odd fill color.

See listing

var currentResourceList = chart.resourceList();
var oddFillSettings = currentResourceList.oddFill();

oddFill(value)Since version 7.12.0

Setter for odd fill settings using an array or a string. Learn more about coloring.

Params:

Name	Type	Description
value	anychart.graphics.vector.Fill	Color as an object or a string.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

oddFill(color, opacity)Since version 7.12.0

Odd fill color with opacity.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

oddFill(keys, angle, mode, opacity)Since version 7.12.0

Linear gradient odd fill. Learn more about coloring.

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.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

oddFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.12.0

Radial gradient odd fill. Learn more about coloring.

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.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

oddFill(imageSettings)Since version 7.12.0

Image odd fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

overlay

overlay()Since version 7.12.0

Getter for the overlay element.

Returns:

anychart.core.ui.Overlay - Overlay element.

See listing

var element = resourceList.overlay();

overlay(value)Since version 7.12.0

Setter for the overlay element.

Detailed description

The overlay method creates a DIV Element by specified bounds and saves its bounds for resize of the chart.

Params:

Name	Type	Description
value	string \| Object \| null \| boolean	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

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

right(value)

Sets element right bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.resource.ResourceList - Returns self for method chaining.

Try it:

Usage sample

stroke

stroke()Since version 7.12.0

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke - The stroke.

See listing

var currentResourceList = chart.resourceList();
var currentStroke = currentResourceList.stroke();

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.12.0

Setter for the stroke. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

top

top()

Getter for element top bound setting.

Returns:

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

top(value)

Sets element top bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.resource.ResourceList - Returns self for method chaining.

Try it:

Usage sample

types

types()Since version 7.12.0

Getter for types.

Returns:

anychart.core.resource.resourceList.TextSettings - Returns a class to provide text settings for resource item types.

Try it:

Usage sample

types(value)Since version 7.12.0

Setter for types.

Params:

Name	Type	Description
value	Object	Object with settings.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

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

Params:

Name	Type	Description
key	Object	The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

width

width()

Getter for element width setting.

Returns:

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

width(value)

Sets element width setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Width setting for the element.

Returns:

anychart.core.resource.ResourceList - Returns self for method chaining.

Try it:

Usage sample

zIndex

zIndex()

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Usage sample

zIndex(value)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

anychart.core.resource.ResourceList - Self instance for method chaining.

Try it:

Usage sample

class anychart.core.resource.ResourceList Improve this Doc

Methods Overview

Methods Description

background

bottom

bounds

descriptions

drawBottomLine

drawLeftLine

drawRightLine

drawTopLine

enabled

evenFill

getPixelBounds

height

images

left

listen

listenOnce

maxHeight

maxWidth

minHeight

minWidth

names

oddFill

overlay

print

removeAllListeners

right

stroke

tags

top

types

unlisten

unlistenByKey

width

zIndex