class anychart.standalones.ResourceList Improve this Doc
Extends: anychart.core.resource.ResourceList
The ResourceList class contains methods for configuring standalones resource list.
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. |
| target() | Target settings. |
| verticalScrollBarPosition() | Vertical scroll bar position. |
| Coloring | |
| background() | Background settings. |
| evenFill() | Even fill settings. |
| oddFill() | Odd fill settings. |
| stroke() | Stroke settings. |
| Data | |
| data() | Data settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| Size and Position | |
| bottom() | Bottom bound settings. |
| bounds() | Bounds settings. |
| getPixelBounds() | Returns pixel bounds. |
| height() | Height settings. |
| left() | Left bound settings. |
| maxHeight() | Maximum height. |
| maxRowHeight() | Maximum row height settings. |
| maxWidth() | Maximum width. |
| minHeight() | Minimum height. |
| minRowHeight() | Minimum row height settings. |
| minWidth() | Minimum width. |
| parentBounds() | Parent bounds settings. |
| right() | Right bound settings. |
| rowHeight() | Row height settings. |
| top() | Top bound settings. |
| width() | Width settings. |
| zIndex() | Z-index of the element. |
| Text settings | |
| descriptions() | Descriptions settings. |
| names() | Names settings. |
| overlay() | Overlay element. |
| tags() | Tags settings. |
| types() | Types settings. |
| Miscellaneous | |
| container() | Container settings. |
| draw() | Draws resource list. |
Methods Description
background
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 |
|---|---|---|
| settings | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.bottom
Getter for element bottom bound settings.
Returns:
number | string | undefined - Element's bottom bound setting.Setter for element bottom bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| bottom | number | string | null | null | Bottom bound settings for the element. |
Returns:
anychart.standalones.ResourceList - Returns self for method chaining.Try it:
bounds
Getter for element bounds settings.
Returns:
anychart.core.utils.Bounds - Bounds of the element.Setter for bounds of the element using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
Setter for 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.standalones.ResourceList - Self instance for method chaining.Try it:
container
Getter for the resource list container.
Returns:
anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - The resource list container. See listing
var container = resourceList.container();
Setter for the resource list container.
Params:
| Name | Type | Description |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
data
Getter for resource list data.
Returns:
anychart.data.View - Returns the data mapping. See listing
var data = resourceList.data();
Setter for resource list data.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Value to set. |
| csvSettings | anychart.enums.TextParsingMode | anychart.data.TextParsingSettings | If CSV string is passed, you can pass CSV parser settings here as a hash map. |
Returns:
anychart.standalones.ResourceList - 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 |
|---|---|---|
| settings | Object | Object with settings. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
draw
Draws resource list.
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
drawBottomLine
Getter for the bottom line drawing flag.
Returns:
boolean - Drawing flag. See listing
var resourceList = chart.resourceList(); var drawBottomLine = resourceList.drawBottomLine();
Setter for the bottom line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
drawLeftLine
Getter for the left line drawing flag.
Returns:
boolean - Drawing flag. See listing
var resourceList = chart.resourceList(); var drawLeftLine = resourceList.drawLeftLine();
Setter for the left line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
drawRightLine
Getter for the right line drawing flag.
Returns:
boolean - Drawing flag. See listing
var resourceList = chart.resourceList(); var drawRightLine = resourceList.drawRightLine();
Setter for the right line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
drawTopLine
Getter for the top line drawing flag.
Returns:
boolean - Drawing flag. See listing
var resourceList = chart.resourceList(); var drawTopLine = resourceList.drawTopLine();
Setter for the top line drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.standalones.ResourceList - 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 resourceList = chart.resourceList(); var evenFill = resourceList.evenFill();
Setter for even fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.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.standalones.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.standalones.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.standalones.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.standalones.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 settings.
Returns:
number | string | undefined - Element's height setting.Setter for element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the element. |
Returns:
anychart.standalones.ResourceList - 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 |
|---|---|---|
| settings | Object | Object with settings for resource images. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
left
Getter for element left bound settings.
Returns:
number | string | undefined - Element's left bound setting.Setter for element left bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| left | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.standalones.ResourceList - Returns self for method chaining.Try it:
maxHeight
Getter for the maximum height.
Returns:
number | string | null - Element's maximum height.Setter for the maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Maximum height to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
maxRowHeight
Getter for the maximum row height.
Returns:
number - Maximum row height See listing
var maxRowHeight = resourceList.maxRowHeight();
Setter for the maximum row height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | Maximum row height to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
maxWidth
Getter for the maximum width.
Returns:
number | string | null - Element's maximum width.Setter for the maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Maximum width to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
minHeight
Getter for the minimum height.
Returns:
number | string | null - Element's minimum height.Setter for the 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 |
|---|---|---|---|
| height | number | string | null | null | Minimum height to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
minRowHeight
Getter for the minimum row height.
Returns:
number - Minimum row height See listing
var minRowHeight = resourceList.minRowHeight();
Setter for the minimum row height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | Minimum row height to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
minWidth
Getter for the minimum width.
Returns:
number | string | null - Element's minimum width.Setter for the 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 |
|---|---|---|---|
| width | number | string | null | null | Minimum width to set. |
Returns:
anychart.standalones.ResourceList - 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 |
|---|---|---|
| settings | Object | Object with settings. |
Returns:
anychart.standalones.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 resourceList = chart.resourceList(); var oddFill = resourceList.oddFill();
Setter for odd fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.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 (0 to 1). |
Returns:
anychart.standalones.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.standalones.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.standalones.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.standalones.ResourceList - Self instance for method chaining.Try it:
overlay
Getter for the overlay element.
Returns:
anychart.core.gantt.Overlay - Overlay element. See listing
var element = resourceList.overlay();
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 |
|---|---|---|
| settings | string | Object | null | boolean | Value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
parentBounds
Getter for parent bounds.
Returns:
anychart.math.Rect - Stage bounds. See listing
var parentBounds = resourceList.parentBounds();
Setter for bounds using single value.
Params:
| Name | Type | Description |
|---|---|---|
| bounds | anychart.math.Rect | Object | null | Parent to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
Setter for bounds using several values.
Params:
| Name | Type | Description |
|---|---|---|
| left | number | Left space. |
| top | number | Top space. |
| width | number | A width for a resource list. |
| height | number | A height for a resource list. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
right
Getter for element right bound settings.
Returns:
number | string | undefined - Element's right bound setting.Setter for element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| right | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.standalones.ResourceList - Returns self for method chaining.Try it:
rowHeight
Getter for the row height.
Returns:
number - Minimum row height See listing
var minRowHeight = resourceList.minRowHeight();
Setter for the minimum row height.
Params:
| Name | Type | Description |
|---|---|---|
| height | number | Minimum row height to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
stroke
Getter for the stroke.
Returns:
anychart.graphics.vector.Stroke - The stroke. See listing
var resourceList = chart.resourceList(); var stroke = resourceList.stroke();
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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
Setter for stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.standalones.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 |
|---|---|---|
| settings | Object | Object with settings. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
target
Getter for the source chart for list.
Returns:
anychart.charts.Resource - Source chart for target.Setter for the source chart for list.
Params:
| Name | Type | Description |
|---|---|---|
| target | anychart.charts.Resource | Target to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.top
Getter for element top bound settings.
Returns:
number | string | undefined - Element's top bound setting.Setter for element top bound settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| top | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.standalones.ResourceList - 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 |
|---|---|---|
| settings | Object | Object with settings. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it:
verticalScrollBarPosition
Getter for the vertical scroll bar position.
Returns:
number - Returns scroll bar position.Setter for the vertical scroll bar position.
Params:
| Name | Type | Description |
|---|---|---|
| position | number | Position value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.width
Getter for element width settings.
Returns:
number | string | undefined - Element's width setting.Setter for element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the element. |
Returns:
anychart.standalones.ResourceList - Returns self for method chaining.Try it:
zIndex
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 |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.standalones.ResourceList - Self instance for method chaining.Try it: