Top
You are looking at an outdated 7.13.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

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

Getter for the background.

Returns:

anychart.core.ui.Background - Background instance.

Try it:

Setter for the background.

Params:

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

Returns:

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

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

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:

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

Returns:

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

Try it:

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

Try it:

descriptions

Getter for descriptions.

Returns:

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

Try it:

Setter for descriptions.

Params:

Name Type Description
value Object Object with settings.

Returns:

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

Try it:

drawBottomLine

Getter for the bottom line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawBottomLine();
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:

drawLeftLine

Getter for the left line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawLeftLine();
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:

drawRightLine

Getter for the right line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawRightLine();
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:

drawTopLine

Getter for the top line drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentResourceList = chart.resourceList();
var flag = currentResourceList.drawTopLine();
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:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

evenFill

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();
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.
Even fill color with 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:

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:

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:

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:

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:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

images

Getter for images.

Returns:

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

Try it:

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:

left

Getter for element left bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

maxHeight

Getter for maximum height.

Returns:

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

Params:

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

Returns:

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

Try it:

maxWidth

Getter for maximum width.

Returns:

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

Params:

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

Returns:

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

Try it:

minHeight

Getter for minimum height.

Returns:

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

Params:

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

Returns:

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

Try it:

minWidth

Getter for minimum width.

Returns:

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

Params:

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

Returns:

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

Try it:

names

Getter for names.

Returns:

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

Try it:

Setter for names.

Params:

Name Type Description
value Object Object with settings.

Returns:

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

Try it:

oddFill

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();
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.
Odd fill color with 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:

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:

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:

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:

overlay

Getter for the overlay element.

Returns:

anychart.core.ui.Overlay - Overlay element.
See listing
var element = resourceList.overlay();
Setter for the overlay element.

Params:

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

Returns:

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

Try it:

print

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:

removeAllListeners

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:

Getter for element right bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

stroke

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke - The stroke.
See listing
var currentResourceList = chart.resourceList();
var currentStroke = currentResourceList.stroke();
Setter for the stroke. Learn more about stroke settings.

Params:

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

tags

Getter for tags.

Returns:

anychart.core.resource.resourceList.TagsSettings - Returns a class to provide text settings for resource item tags.

Try it:

Setter for tags.

Params:

Name Type Description
value Object Object with settings.

Returns:

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

Try it:

top

Getter for element top bound setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

types

Getter for types.

Returns:

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

Try it:

Setter for types.

Params:

Name Type Description
value Object Object with settings.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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:

width

Getter for element width setting.

Returns:

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

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: