SeriesLayoutProperties

SeriesLayoutProperties class

Represents the properties of series layout.

class SeriesLayoutProperties;

Remarks

Only applicable to BoxWhisker,Funnel,ParetoLine,Sunburst,Treemap,Waterfall and Histogram chart.

Constructors

Constructor	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
showConnectorLines	boolean	Indicates whether connector lines are shown between data points.
showMeanLine	boolean	Indicates whether to show the line connecting all mean points.
showOutlierPoints	boolean	Indicates whether outlier data points are shown.
showMeanMarker	boolean	Indicates whether markers denoting the mean are shown.
showInnerPoints	boolean	Indicates whether to show non-outlier data points.
subtotals	number[]	Represents the index of a subtotal data point.
quartileCalculation	QuartileCalculationType	Represents the statistical properties for the series.
mapLabelLayout	MapChartLabelLayout	Gets and sets the layout of map labels.
isIntervalLeftClosed	boolean	Indicates whether the interval is closed on the left side.
mapChartRegionType	MapChartRegionType	Gets and sets the region type of the map.
mapChartProjectionType	MapChartProjectionType	Gets and sets the projection type of the map.

Methods

Method	Description
getShowConnectorLines()	@deprecated. Please use the ‘showConnectorLines’ property instead. Indicates whether connector lines are shown between data points.
setShowConnectorLines(boolean)	@deprecated. Please use the ‘showConnectorLines’ property instead. Indicates whether connector lines are shown between data points.
getShowMeanLine()	@deprecated. Please use the ‘showMeanLine’ property instead. Indicates whether to show the line connecting all mean points.
setShowMeanLine(boolean)	@deprecated. Please use the ‘showMeanLine’ property instead. Indicates whether to show the line connecting all mean points.
getShowOutlierPoints()	@deprecated. Please use the ‘showOutlierPoints’ property instead. Indicates whether outlier data points are shown.
setShowOutlierPoints(boolean)	@deprecated. Please use the ‘showOutlierPoints’ property instead. Indicates whether outlier data points are shown.
getShowMeanMarker()	@deprecated. Please use the ‘showMeanMarker’ property instead. Indicates whether markers denoting the mean are shown.
setShowMeanMarker(boolean)	@deprecated. Please use the ‘showMeanMarker’ property instead. Indicates whether markers denoting the mean are shown.
getShowInnerPoints()	@deprecated. Please use the ‘showInnerPoints’ property instead. Indicates whether to show non-outlier data points.
setShowInnerPoints(boolean)	@deprecated. Please use the ‘showInnerPoints’ property instead. Indicates whether to show non-outlier data points.
getSubtotals()	@deprecated. Please use the ‘subtotals’ property instead. Represents the index of a subtotal data point.
setSubtotals(number[])	@deprecated. Please use the ‘subtotals’ property instead. Represents the index of a subtotal data point.
getQuartileCalculation()	@deprecated. Please use the ‘quartileCalculation’ property instead. Represents the statistical properties for the series.
setQuartileCalculation(QuartileCalculationType)	@deprecated. Please use the ‘quartileCalculation’ property instead. Represents the statistical properties for the series.
getMapLabelLayout()	@deprecated. Please use the ‘mapLabelLayout’ property instead. Gets and sets the layout of map labels.
setMapLabelLayout(MapChartLabelLayout)	@deprecated. Please use the ‘mapLabelLayout’ property instead. Gets and sets the layout of map labels.
isIntervalLeftClosed()	@deprecated. Please use the ‘isIntervalLeftClosed’ property instead. Indicates whether the interval is closed on the left side.
setIsIntervalLeftClosed(boolean)	@deprecated. Please use the ‘isIntervalLeftClosed’ property instead. Indicates whether the interval is closed on the left side.
getMapChartRegionType()	@deprecated. Please use the ‘mapChartRegionType’ property instead. Gets and sets the region type of the map.
setMapChartRegionType(MapChartRegionType)	@deprecated. Please use the ‘mapChartRegionType’ property instead. Gets and sets the region type of the map.
getMapChartProjectionType()	@deprecated. Please use the ‘mapChartProjectionType’ property instead. Gets and sets the projection type of the map.
setMapChartProjectionType(MapChartProjectionType)	@deprecated. Please use the ‘mapChartProjectionType’ property instead. Gets and sets the projection type of the map.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

showConnectorLines

Indicates whether connector lines are shown between data points.

showConnectorLines : boolean;

Remarks

Only for Waterfall chart.

showMeanLine

Indicates whether to show the line connecting all mean points.

showMeanLine : boolean;

Remarks

Only works for BoxWhisker chart.

showOutlierPoints

Indicates whether outlier data points are shown.

showOutlierPoints : boolean;

showMeanMarker

Indicates whether markers denoting the mean are shown.

showMeanMarker : boolean;

showInnerPoints

Indicates whether to show non-outlier data points.

showInnerPoints : boolean;

subtotals

Represents the index of a subtotal data point.

subtotals : number[];

quartileCalculation

Represents the statistical properties for the series.

quartileCalculation : QuartileCalculationType;

Remarks

Only applicable to BoxWhisker chart.

mapLabelLayout

Gets and sets the layout of map labels.

mapLabelLayout : MapChartLabelLayout;

isIntervalLeftClosed

Indicates whether the interval is closed on the left side.

isIntervalLeftClosed : boolean;

Remarks

Only for ParetoLine chart.

mapChartRegionType

Gets and sets the region type of the map.

mapChartRegionType : MapChartRegionType;

Remarks

Only for map chart.

mapChartProjectionType

Gets and sets the projection type of the map.

mapChartProjectionType : MapChartProjectionType;

Remarks

Only for map chart.

getShowConnectorLines()

@deprecated. Please use the ‘showConnectorLines’ property instead. Indicates whether connector lines are shown between data points.

getShowConnectorLines() : boolean;

Remarks

Only for Waterfall chart.

setShowConnectorLines(boolean)

@deprecated. Please use the ‘showConnectorLines’ property instead. Indicates whether connector lines are shown between data points.

setShowConnectorLines(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for Waterfall chart.

getShowMeanLine()

@deprecated. Please use the ‘showMeanLine’ property instead. Indicates whether to show the line connecting all mean points.

getShowMeanLine() : boolean;

Remarks

Only works for BoxWhisker chart.

setShowMeanLine(boolean)

@deprecated. Please use the ‘showMeanLine’ property instead. Indicates whether to show the line connecting all mean points.

setShowMeanLine(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only works for BoxWhisker chart.

getShowOutlierPoints()

@deprecated. Please use the ‘showOutlierPoints’ property instead. Indicates whether outlier data points are shown.

getShowOutlierPoints() : boolean;

setShowOutlierPoints(boolean)

@deprecated. Please use the ‘showOutlierPoints’ property instead. Indicates whether outlier data points are shown.

setShowOutlierPoints(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowMeanMarker()

@deprecated. Please use the ‘showMeanMarker’ property instead. Indicates whether markers denoting the mean are shown.

getShowMeanMarker() : boolean;

setShowMeanMarker(boolean)

@deprecated. Please use the ‘showMeanMarker’ property instead. Indicates whether markers denoting the mean are shown.

setShowMeanMarker(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShowInnerPoints()

@deprecated. Please use the ‘showInnerPoints’ property instead. Indicates whether to show non-outlier data points.

getShowInnerPoints() : boolean;

setShowInnerPoints(boolean)

@deprecated. Please use the ‘showInnerPoints’ property instead. Indicates whether to show non-outlier data points.

setShowInnerPoints(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSubtotals()

@deprecated. Please use the ‘subtotals’ property instead. Represents the index of a subtotal data point.

getSubtotals() : number[];

Returns

number[]

setSubtotals(number[])

@deprecated. Please use the ‘subtotals’ property instead. Represents the index of a subtotal data point.

setSubtotals(value: number[]) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

getQuartileCalculation()

@deprecated. Please use the ‘quartileCalculation’ property instead. Represents the statistical properties for the series.

getQuartileCalculation() : QuartileCalculationType;

Returns

QuartileCalculationType

Remarks

Only applicable to BoxWhisker chart.

setQuartileCalculation(QuartileCalculationType)

@deprecated. Please use the ‘quartileCalculation’ property instead. Represents the statistical properties for the series.

setQuartileCalculation(value: QuartileCalculationType) : void;

Parameters:

Parameter	Type	Description
value	QuartileCalculationType	The value to set.

Remarks

Only applicable to BoxWhisker chart.

getMapLabelLayout()

@deprecated. Please use the ‘mapLabelLayout’ property instead. Gets and sets the layout of map labels.

getMapLabelLayout() : MapChartLabelLayout;

Returns

MapChartLabelLayout

setMapLabelLayout(MapChartLabelLayout)

@deprecated. Please use the ‘mapLabelLayout’ property instead. Gets and sets the layout of map labels.

setMapLabelLayout(value: MapChartLabelLayout) : void;

Parameters:

Parameter	Type	Description
value	MapChartLabelLayout	The value to set.

isIntervalLeftClosed()

@deprecated. Please use the ‘isIntervalLeftClosed’ property instead. Indicates whether the interval is closed on the left side.

isIntervalLeftClosed() : boolean;

Remarks

Only for ParetoLine chart.

setIsIntervalLeftClosed(boolean)

@deprecated. Please use the ‘isIntervalLeftClosed’ property instead. Indicates whether the interval is closed on the left side.

setIsIntervalLeftClosed(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for ParetoLine chart.

getMapChartRegionType()

@deprecated. Please use the ‘mapChartRegionType’ property instead. Gets and sets the region type of the map.

getMapChartRegionType() : MapChartRegionType;

Returns

MapChartRegionType

Remarks

Only for map chart.

setMapChartRegionType(MapChartRegionType)

@deprecated. Please use the ‘mapChartRegionType’ property instead. Gets and sets the region type of the map.

setMapChartRegionType(value: MapChartRegionType) : void;

Parameters:

Parameter	Type	Description
value	MapChartRegionType	The value to set.

Remarks

Only for map chart.

getMapChartProjectionType()

@deprecated. Please use the ‘mapChartProjectionType’ property instead. Gets and sets the projection type of the map.

getMapChartProjectionType() : MapChartProjectionType;

Returns

MapChartProjectionType

Remarks

Only for map chart.

setMapChartProjectionType(MapChartProjectionType)

@deprecated. Please use the ‘mapChartProjectionType’ property instead. Gets and sets the projection type of the map.

setMapChartProjectionType(value: MapChartProjectionType) : void;

Parameters:

Parameter	Type	Description
value	MapChartProjectionType	The value to set.

Remarks

Only for map chart.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;