class anychart.charts.Resource Improve this Doc
Extends: anychart.core.Chart
Resource chart class.
Methods Overview
| Specific settings | |
| activities() | Activities settings. |
| calendar() | Calendar settings. |
| conflicts() | Conflicts settings. |
| defaultMinutesPerDay() | Time tracking mode. |
| globalToLocal() | Converts the global coordinates to local coordinates. |
| grid() | Grid settings. |
| horizontalScrollBar() | Horizontal scrollbar settings. |
| localToGlobal() | Converts the local coordinates to global coordinates. |
| overlay() | Overlay element. |
| timeLine() | TimeLine settings. |
| timeTrackingMode() | Time tracking mode. |
| verticalScrollBar() | Vertical scrollbar settings. |
| Axes and Scales | |
| xScale() | X scale settings. |
| Chart Coloring | |
| animation() | Animation settings |
| background() | Background settings. |
| Chart Controls | |
| contextMenu() | Context menu settings. |
| label() | Label settings. |
| title() | Title settings. |
| Coloring | |
| logo() | Logo settings. |
| selectMarqueeFill() | Select marquee fill settings. |
| selectMarqueeStroke() | Stroke settings. |
| splitterStroke() | Stroke settings. |
| Data | |
| data() | Data settings. |
| getSelectedPoints() | Getter for the selected points. |
| 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. |
| saveAsCsv() | Saves chart data as CSV file. |
| saveAsJson() | Saves chart config as JSON document. |
| saveAsXlsx() | Saves chart data as Excel document. |
| saveAsXml() | Saves chart config as XML document. |
| toCsv() | Returns CSV string with series data. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| hover() | Setter for the hover state on an activity. |
| hoverPoint() | Hovers an activity by its global index. |
| select() | Setter for the select state on an activity. |
| selectPoint() | Selects an activity by its global index. |
| startSelectMarquee() | Starts select marquee drawing. |
| tooltip() | Tooltip settings. |
| unhover() | Removes hover from an activity by index. |
| unselect() | Removes select from an activity by index. |
| zoomLevel() | Zoom level settings. |
| zoomLevels() | Zoom levels settings. |
| Size and Position | |
| bottom() | Bottom bound setting. |
| bounds() | Bounds settings. |
| cellPadding() | Cell padding settings. |
| getPixelBounds() | Returns pixel bounds. |
| height() | Height setting. |
| left() | Left bound setting. |
| margin() | Margin settings. |
| maxHeight() | Maximum height. |
| maxWidth() | Maximum width. |
| minHeight() | Minimum height. |
| minRowHeight() | Minimal row height settings. |
| minWidth() | Minimum width. |
| padding() | Padding settings. |
| pixPerHour() | Hours row height settings. |
| resourceListWidth() | Time line height settings. |
| right() | Right bound setting. |
| timeLineHeight() | Time line height settings. |
| top() | Top bound setting. |
| width() | Width setting. |
| zIndex() | Z-index of the element. |
| XML/JSON | |
| toJson() | Return chart configuration as JSON object or string. |
| toXml() | Return chart configuration as XML string or XMLNode. |
| Miscellaneous | |
| cancelMarquee() | Stops current marquee action if any. |
| container() | Getter for the element's container. |
| draw() | Drawing of the chart. |
| inMarquee() | Gets marquee process running value. |
| saveAsJpg() | Saves the current chart as JPEG image. |
| saveAsPdf() | Saves the current chart as PDF image. |
| saveAsPng() | Saves the current chart as PNG image. |
| saveAsSvg() | Saves the current chart as SVG image. |
| toSvg() | Returns SVG string. |
Methods Description
activities
Getter for the activities settings.
Returns:
anychart.core.resource.Activities - Activities settings.Try it:
Setter for the activities settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
animation
Getter for the current animation setting.
Returns:
anychart.core.utils.Animation - Returns true if the animation is enabled.Try it:
Setter for the animation setting by one value.
Detailed description
Sets animation settings depending on parameter type:
- null/boolean - disable or enable animation.
- object - sets animation settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | Object | false | Whether to enable animation. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Setter for the animation settings using several parameters.
Detailed description
Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable animation. |
| duration | number | 1000 | Duration in milliseconds. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
background
Getter for the current chart background.
Returns:
anychart.core.ui.Background - The current chart background.Try it:
Setter for the chart background.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | {enabled: true, fill: "#fff", stroke: 'none', zIndex: 1} | Background object to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
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.charts.Resource - 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.charts.Resource - 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.charts.Resource - Self instance for method chaining.Try it:
calendar
Setter for calendar.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
cancelMarquee
Stops current marquee action if any.
Returns:
anychart.charts.Resource - Self instance for method chaining.cellPadding
Setter for cell paddings in pixels using a single value.
Params:
| Name | Type | Description |
|---|---|---|
| value | null | Array.<(number|string)> | Object | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining. Examples for paddings
// all paddings 15px
chart.padding(15);
// all paddings 15px
chart.padding('15px');
// top and bottom 5px ,right and left 15px
chart.padding(anychart.utils.padding(5,15));Try it:
Setter for cell paddings in pixels using several numbers.
Params:
| Name | Type | Description |
|---|---|---|
| value1 | string | number | Top or top-bottom space. |
| value2 | string | number | Right or right-left space. |
| value3 | string | number | Bottom space. |
| value4 | string | number | Left space. |
Returns:
anychart.charts.Resource - Self instance for method chaining. Examples for paddings
// 1) top and bottom 10px, left and right 15px chart.cellPadding(10, '15px'); // 2) top 10px, left and right 15px, bottom 5px chart.cellPadding(10, '15px', 5); // 3) top 10px, right 15px, bottom 5px, left 12px chart.cellPadding(10, '15px', '5px', 12);
Try it:
conflicts
Getter for the conflicts settings.
Returns:
anychart.core.resource.Conflicts - Conflicts settingsTry it:
Setter for the conflicts settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
container
Getter for the element's container.
Setter for the element's container.
Detailed description
Each element appends all its content to this container.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining. Example
// string
element.container('containerIdentifier');
// DOM-element
var domElement = document.getElementById('containerIdentifier');
element.container(domElement);
// Framework-element
var fwElement = anychart.standalones.title();
element.container( fwElement.container() );Try it:
contextMenu
Getter for the current context menu.
Returns:
anychart.ui.ContextMenu - The current context menu.Try it:
Setter for the context menu.
Detailed description
Sets context menu settings depending on parameter type:
- null/boolean - disable or enable context menu.
- object - sets context menu settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Context menu settings |
Returns:
anychart.charts.Resource - Self instance for method chaining.data
Getter for the chart data.
Returns:
anychart.data.View - Data mapping. See listing
var currentData = chart.data();
Setter for the chart data.
Learn more about mapping at anychart.data.Mapping.
Params:
| Name | Type | Description |
|---|---|---|
| value | 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.charts.Resource - Self instance for method chaining.defaultMinutesPerDay
Getter for default minutes per day.
Returns:
number - Minutes per day. See listing
var time = chart.defaultMinutesPerDay();
Setter for default minutes per day.
Note: Use method when number of minutes per day isn't specified in the data.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 60 | Minutes per day. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
draw
Starts the rendering of the chart into the container.
Params:
| Name | Type | Description |
|---|---|---|
| async | boolean | Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously. |
Returns:
anychart.charts.Resource - Self instance for method chaining.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.charts.Resource - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
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.getSelectedPoints
Getter for the selected points.
Returns:
Array.<anychart.core.Point> - An array of the selected points.Try it:
globalToLocal
Converts the global coordinates to local coordinates.
Note: Works only after anychart.core.Chart#draw is called.
Detailed description
Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Global X coordinate. |
| yCoord | number | Global Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
grid
Setter for the grid.
Detailed description
Sets grid settings depending on parameter type:
- null/boolean - disable or enable grid.
- object - sets grid settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | null | boolean | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.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.charts.Resource - Returns self for method chaining.Try it:
horizontalScrollBar
Setter for the horizontal scrollbar.
Detailed description
Sets scrollbar settings depending on parameter type:
- null/boolean - disable or enable scrollbar.
- object - sets scrollbar settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | null | boolean | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.hover
Setter for the hover state on an activity.
Hovers an activity determined by the resourceIndex and the activityIndex.
Hovers an activity determined by the resourceIndex and the activityIndex.
Params:
| Name | Type | Description |
|---|---|---|
| resourceIndex | number | Resource index. |
| activityIndex | number | Activity index. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
hoverPoint
Hovers an activity by its global index.
Params:
| Name | Type | Description |
|---|---|---|
| globalIndex | number | Global activity index. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
inMarquee
Gets marquee process running value.
Returns:
boolean - Returns true if there is a marquee process running.label
Getter for chart 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 chart label.
Detailed description
Sets chart label settings depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Setter for chart label.
Detailed description
Sets chart label settings by index depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | Label index. | |
| value | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.Resource - Self instance 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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.charts.Resource - Returns self for method chaining.Try it:
listen
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.
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:
listenOnce
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).
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:
localToGlobal
Converts the local coordinates to global coordinates.
Note: Works only after anychart.core.Chart#draw is called.
Detailed description
Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Local X coordinate. |
| yCoord | number | Local Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
logo
Setter for the logo.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
margin
Getter for current chart margin.
Detailed description
Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left,
anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.
Returns:
anychart.core.utils.Margin - Chart margin.Try it:
Setter for the chart 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.charts.Resource - 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 chart 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.charts.Resource - 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:
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.charts.Resource - 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.charts.Resource - 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.
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.charts.Resource - Self instance for method chaining.Try it:
minRowHeight
Getter for the minimal row height.
Returns:
number - Minimal row height See listing
var minHeight = chart.minRowHeight();
Setter for the minimal row height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 50 | Value to set. |
Returns:
anychart.charts.Resource - 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.
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.charts.Resource - Self instance for method chaining.Try it:
overlay
Getter for the overlay element.
Returns:
anychart.core.ui.Overlay - Overlay element. See listing
var element = chart.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 |
|---|---|---|
| value | Object | null | boolean | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
padding
Getter for the chart padding.
Detailed description
Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.
Returns:
anychart.core.utils.Padding - Chart padding.Try it:
Setter for the chart 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.charts.Resource - 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 chart 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.charts.Resource - 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:
pixPerHour
Getter for hours row height in pixels.
Returns:
number - The hour height in pixel See listing
var height = chart.pixPerHour();
Setter for hours row height in pixels.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 25 | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
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:
resourceListWidth
Getter for the resource list width.
Returns:
number | string - Time line height. See listing
var width = chart.resourceListWidth();
Setter for the resource list width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 260 | Value to set |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
right
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.charts.Resource - Returns self for method chaining.Try it:
saveAsCsv
Saves chart data as CSV file.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
| filename | string | File name to save. |
Try it:
saveAsJpg
Saves the current chart as JPEG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Object | Image width or object with options. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Force transparent to white or not. |
| filename | string | File name to save. |
Try it:
saveAsJson
Saves chart config as JSON document.
Params:
| Name | Type | Description |
|---|---|---|
| includeTheme | boolean | If the current theme properties should be included into the result. |
| filename | string | File name to save. |
Try it:
saveAsPdf
Saves the current chart as PDF image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSizeOrWidthOrOptions | number | string | Object | Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options. |
| landscape | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
| filename | string | File name to save. |
Try it:
saveAsPng
Saves the current chart as PNG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Object | Image width or object with options. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| filename | string | File name to save. |
Try it:
saveAsSvg
Saves the current chart as SVG image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Object | Paper Size or object with options. |
| landscape | boolean | Landscape. |
| filename | string | File name to save. |
Try it:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
saveAsXlsx
Saves chart data as Excel document.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| filename | string | File name to save. |
Try it:
saveAsXml
Saves chart config as XML document.
Params:
| Name | Type | Description |
|---|---|---|
| includeTheme | boolean | If the current theme properties should be included into the result. |
| filename | string | File name to save. |
Try it:
select
Setter for the select state on an activity.
Selects an activity determined by the resourceIndex and the activityIndex.
Selects an activity determined by the resourceIndex and the activityIndex.
Params:
| Name | Type | Description |
|---|---|---|
| resourceIndex | number | Resource index. |
| activityIndex | number | Activity index. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
selectMarqueeFill
Getter for the select marquee fill.
Returns:
anychart.graphics.vector.Fill - Select marquee fill. See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for 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.charts.Resource - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
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.charts.Resource - Self instance for method chaining.Try it:
Linear gradient 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.charts.Resource - Self instance for method chaining.Try it:
Radial gradient 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.charts.Resource - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
selectMarqueeStroke
Getter for the select marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke. See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
Setter for the select marquee 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.charts.Resource - Self instance for method chaining.Try it:
selectPoint
Selects an activity by its global index.
Params:
| Name | Type | Description |
|---|---|---|
| globalIndex | number | Global activity index. |
| event | anychart.core.MouseEvent | Mouse event. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
splitterStroke
Getter for the splitter stroke.
Returns:
anychart.graphics.vector.Stroke - Splitter stroke settings. See listing
var stroke = chart.splitterStroke();
Setter for the splitter stroke.
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 joint style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
startSelectMarquee
Starts select marquee drawing.
Note: Works only after anychart.core.Chart#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
timeLine
Setter for the time line.
Detailed description
Sets time line settings depending on parameter type:
- null/boolean - disable or enable time line.
- object - sets time line settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | null | boolean | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.timeLineHeight
Getter for the time line height.
Returns:
number | string - The time line height See listing
var height = chart.timeLineHeight();
Setter for the time line height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | 52 | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
timeTrackingMode
Getter for the time tracking mode.
Returns:
anychart.enums.TimeTrackingMode - The time tracking mode. See listing
var mode = chart.timeTrackingMode();
Setter for the time tracking mode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.TimeTrackingMode | string | "activityPerResource" | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
title
Setter for the chart title.
Detailed description
Sets chart title settings depending on parameter type:
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.charts.Resource - Self instance for method chaining.toCsv
Returns CSV string with series data.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
Returns:
string - CSV string.Try it:
toJson
Return chart configuration as JSON object or string.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| stringify | boolean | false | Returns JSON as string. |
| includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
Object | string - Chart configuration.toSvg
Returns SVG string with paper size and landscape.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Object | Paper Size or object of options. |
| landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Returns SVG string with with determined the width and height.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Returns:
string - SVG content or empty string.Try it:
toXml
Return chart configuration as XML string or XMLNode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| asXmlNode | boolean | false | Return XML as XMLNode. |
| includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
string | Node - Chart configuration.tooltip
Getter for current chart tooltip.
Returns:
anychart.core.ui.Tooltip - An instance of the class for method chaining. Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null |
Returns:
anychart.charts.Resource - 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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.charts.Resource - Returns self for method chaining.Try it:
unhover
Removes hover from an activity by index.
Params:
| Name | Type | Description |
|---|---|---|
| resourceIndex | number | Array.<number> | Resource index or array of indexes. |
| activityIndex | number | Activity index. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
unlisten
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:
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:
unselect
Removes select from an activity by index.
Params:
| Name | Type | Description |
|---|---|---|
| resourceIndex | number | Array.<number> | Resource index or array of indexes. |
| activityIndex | number | Self instance for method chaining. |
Try it:
verticalScrollBar
Setter for the vertical scrollbar.
Detailed description
Sets scrollbar settings depending on parameter type:
- null/boolean - disable or enable scrollbar.
- object - sets scrollbar settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | null | boolean | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.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.charts.Resource - Returns self for method chaining.Try it:
xScale
Setter for the X scale.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | Value to set |
Returns:
anychart.charts.Resource - Self instance 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.
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.charts.Resource - Self instance for method chaining.Try it:
zoomLevel
Getter for the zoom level.
Returns current zoom level identifier or index, if no identifier specified at current zoom level.
Returns:
number | string - The zoom level. See listing
var level = chart.zoomLevel();
Setter for the zoom level.
Zooms chart to the level denoted by the passed index or identifier.
Params:
| Name | Type | Description |
|---|---|---|
| indexOrId | number | string | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it:
zoomLevels
Getter for zoom levels set.
Returns:
Array.<anychart.charts.Resource.ZoomLevel> - The zoom levels set. See listing
var levels = chart.zoomLevels();
Setter for zoom levels set.
Params:
| Name | Type | Description |
|---|---|---|
| value | Array.<anychart.charts.Resource.ZoomLevel> | Value to set. |
Returns:
anychart.charts.Resource - Self instance for method chaining.Try it: