class anychart.core.cartesian.series.Area3d Improve this Doc

Extends: anychart.core.cartesian.series.ContinuousBase

3D Area Series Class.
Note: Use anychart.charts.Cartesian3d#area3d method to get this series.
Learn more about 3D Area series

Methods Overview

Specific settings
a11y()	Accessibility settings.
clip()	Series clip settings.
connectMissingPoints()	Missing points settings.
id()	Series id.
legendItem()	Legend item settings.
selectionMode()	Selection mode.
transformX()	Transforms X value to pixel coordinates.
transformY()	Transforms Y value to pixel coordinates.
xPointPosition()	Position of the point.
Coloring
color()	Color settings.
colorScale()	Color scale settings.
fill()	Fill settings.
hatchFill()	Hatch fill settings.
stroke()	Stroke settings.
Data
data()	Data settings.
excludePoint()	Excludes points at the specified index.
getExcludedPoints()	Returns an array of excluded points.
getStat()	Gets the statistics value by key.
includeAllPoints()	Includes all excluded points.
includePoint()	Includes excluded points with the specified indexes.
keepOnlyPoints()	Keep only the specified points.
meta()	Series meta data settings.
name()	Series name settings.
Interactivity
enabled()	Element state (enabled or disabled).
hover()	Hover settings.
hovered()	Hovered state settings.
normal()	Normal state settings.
select()	Select settings.
selected()	Selected state settings.
tooltip()	Tooltip settings.
unhover()	Removes hover from the series.
unselect()	Deselects all selected points.
Point Elements
getPoint()	Gets wrapped point by index.
labels()	Labels settings.
markers()	Markers settings.
maxLabels()	Maximum labels settings.
minLabels()	Minimum labels settings.
Scales
xScale()	X-scale settings.
yScale()	Y-scale settings.
Series
rendering()	Rendering settings
seriesType()	Switch the series type
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound settings.
top()	Top bound settings.
width()	Width settings.
zIndex()	Z-index of the chart.

Methods Description

a11y()

a11y(value)

Setter for the accessibility setting.

Detailed description

Params:

Name	Type	Description
value	boolean \| Object	Whether to enable accessibility.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

anychart.core.cartesian.series.Area3d - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for series bounds settings.

Returns:

anychart.core.utils.Bounds - Series bounds.

bounds(bounds)

Setter for bounds of the series using one parameter.

Params:

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

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

bounds(x, y, width, height)

Setter for series 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.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

clip

clip()

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.

Try it:

Usage sample

clip(value)

Setter for series clip settings.

Detailed description

Clips visible part of a series by a rectangle (or chart).

Params:

Name	Type	Default	Description
value	boolean \| anychart.math.Rect	False, if series is created manually. True, if created via chart	Enable/disable series clip.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

color

color()

Getter for the series color.

Returns:

string - Series color.

Try it:

Usage sample

color(value)

Setter for the series color.

Detailed description

Note: color methods sets fill and stroke settings, which means it is not wise to pass image fill here - stroke doesn't accept image fill.
Learn more about coloring.

Params:

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

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

colorScale

colorScale()

Getter for the color scale.

Returns:

anychart.scales.LinearColor | anychart.scales.OrdinalColor - Color scale instance.

See listing

var series = chart.line();
var colorScale = series.colorScale();

colorScale(settings)

Setter for the color scale.

Params:

Name	Type	Description
settings	anychart.scales.LinearColor \| anychart.scales.OrdinalColor \| Object \| anychart.enums.ScaleTypes \| string	Scale to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

connectMissingPoints

connectMissingPoints()

Getter for connect missing points settings.

Returns:

boolean - Connect missing points settings.

Try it:

Usage sample

connectMissingPoints(enabled)

Setter for connect missing points settings.

Params:

Name	Type	Default	Description
enabled	boolean	false	If set to true, the series will not be interrupted on missing points. Markers will not be drawn for missing points in both cases.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

data

data()

Getter for series mapping.

Returns:

anychart.data.View - Returns mapping.

Try it:

Usage sample

data(value, csvSettings)

Setter for series mapping.

Params:

Name	Type	Description
value	anychart.data.View \| anychart.data.Set \| Array \| string	Value to set.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

excludePoint

excludePoint(indexes)

Excludes points at the specified index.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Points indexes.

Returns:

boolean - Returns true if the points were excluded.

Try it:

Usage sample

fill

fill()

Getter for the fill color.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

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

Try it:

Usage sample

fill(color)

Setter for 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.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

fill(fillFunction)

Setter for fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	function():anychart.graphics.vector.Fill	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like: function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return fillValue; // type anychart.graphics.vector.Fill }

Name

Type

Default

Description

fillFunction

function():anychart.graphics.vector.Fill

function() {
 return anychart.color.darken(this.sourceColor);
}

Function that looks like:

function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

fill(color, opacity)

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.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

getExcludedPoints

getExcludedPoints()

Returns an array of excluded points.

Returns:

Array.<anychart.core.Point> - Array of the points.

Try it:

Usage sample

getPixelBounds

getPixelBounds()

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

Returns:

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

Try it:

Usage sample

getPoint

getPoint(index)

Gets wrapped point by index.

Params:

Name	Type	Description
index	number	Point index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

Try it:

Usage sample

getStat

getStat(key)

Gets the statistics value by key.

Params:

Name	Type	Description
key	anychart.enums.Statistics \| string	Key.

Returns:

* - Statistics value.

Try it:

Usage sample

hatchFill

hatchFill()

Getter for hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.

hatchFill(type, color, thickness, size)

Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
type	anychart.graphics.vector.HatchFill.HatchFillType \| string	false	Type of hatch fill.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

hatchFill(hatchFillFunction)

Setter for hatch fill settings using function. Learn more about coloring.

Params:

Name	Type	Description
hatchFillFunction	function	HatchFill function.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

hatchFill(patternFill)

Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

Name	Type	Description
patternFill	anychart.graphics.vector.PatternFill	Pattern fill to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

hatchFill(settings)

Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

Name	Type	Description
settings	anychart.graphics.vector.HatchFill	Hatch fill instance.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

hatchFill(enabled)

Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether to enable hatch fill or no.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

anychart.core.cartesian.series.Area3d - Returns self for method chaining.

Try it:

Usage sample

hover

hover()

Hovers points.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

hovered

hovered()

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

id

id()

Getter for the series id.

Returns:

string | number - Series id.

Try it:

Usage sample

id(id)

Setter for the series id.

Detailed description

If you will set series id that is equal to an existing index, all changes will be set for the first series with this index.

Params:

Name	Type	Description
id	string \| number	Id of the series. Default id is equal to internal index.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

includeAllPoints

includeAllPoints()

Includes all excluded points.

Returns:

boolean - Returns true if all points were included.

Try it:

Usage sample

includePoint

includePoint(indexes)

Includes excluded points with the specified indexes.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Points indexes.

Returns:

boolean - Returns true if the points were included.

Try it:

Usage sample

keepOnlyPoints

keepOnlyPoints(indexes)

Keep only the specified points.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Point index or indexes.

Try it:

Usage sample

labels

labels()

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)

Setter for series data labels.

Detailed description

Sets series labels settings depending on parameter type:

null/boolean - disable or enable chart labels.
object - sets chart labels settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Series data labels settings.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

left

left()

Getter for series left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for series left bound settings.

Params:

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

Returns:

anychart.core.cartesian.series.Area3d - Returns self for method chaining.

Try it:

Usage sample

legendItem

legendItem()

Getter for legend item settings of series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.

Try it:

Usage sample

legendItem(value)

Setter for legend item settings of series.

Params:

Name	Type	Description
value	Object	Legend item settings object.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

markers

markers()

Getter for series data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(settings)

Setter for series data markers.

Detailed description

Sets series markers settings depending on parameter type:

null/boolean - disable or enable series markers.
object - sets series markers settings.
string - sets series markers type.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null \| string	false	Series data markers settings.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

maxLabels

maxLabels()

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

maxLabels(settings)

Setter for maximum labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable maximum labels.
object - sets maximum labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Maximum labels settings.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

Name	Type	Description
key	*	Metadata key.

Name	Type	Description
object	*	Object to replace metadata.

Name	Type	Description
key	string	Metadata key.
value	*	Metadata value.

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(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.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

minLabels

minLabels()

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

minLabels(settings)

Setter for minimum labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable minimum labels.
object - sets minimum labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Minimum labels settings.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(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.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

name

name()

Getter for the series name.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

string | undefined - Series name.

Try it:

Usage sample

name(value)

Setter for the series name.

Detailed description

Basically, name of series is used in Legend displaying, but it can be used in tooltips.

Params:

Name	Type	Description
value	string	Value to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

normal

normal()

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

rendering

rendering()

Getter for the series rendering.

Returns:

anychart.core.series.RenderingSettings - Rendering settings.

rendering(settings)

Setter for the series rendering settings.
Rendering settings are used to override the standard series drawing functions. Learn more about rendering

Params:

Name	Type	Description
settings	Object \| function	Rendering settings to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

right

right()

Getter for series right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for series right bound setting.

Params:

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

Returns:

anychart.core.cartesian.series.Area3d - Returns self for method chaining.

Try it:

Usage sample

select

select()

Selects points.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

selected

selected()

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

selectionMode

selectionMode()

Getter for the selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.

Try it:

Usage sample

selectionMode(value)

Setter for the selection mode.
Allows to select points of the series.
To select multiple points, press 'ctrl' and click on them.

Params:

Name	Type	Default	Description
value	anychart.enums.SelectionMode \| string \| null	'multiSelect'	Selection mode.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

seriesType

seriesType()

Getter for switching of the series type.

Returns:

string - Series type.

Try it:

Usage sample

seriesType(type)

Setter for switching of the series type.

Detailed description

You can use seriesType() method to fast switching series type. Note: The switching of series type resets markers and labels settings.

Params:

Name	Type	Description
type	string	Series type to set.

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()

Getter for stroke settings.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.

Try it:

Usage sample

stroke(strokeFunction)

Setter for stroke by function.

Params:

Name	Type	Default	Description
strokeFunction	function():anychart.graphics.vector.Stroke\|anychart.graphics.vector.ColoredFill	function() { return anychart.color.darken(this.sourceColor); }	Function that looks like: function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }

Name

Type

Default

Description

strokeFunction

function():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill

function() {
 return anychart.color.darken(this.sourceColor);
}

Function that looks like:

function(){
   // this.index - series index.
   // this.sourceColor - color returned by fill() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
}

Returns:

anychart.core.cartesian.series.Area3d - Self instance for method chaining.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for stroke settings. 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.