Edit

Share via

ExcelScript.ChartBinOptions interface

  • Reference
Package:
ExcelScript

Encapsulates the bin options for histogram charts and pareto charts.

Methods

getAllowOverflow()

Specifies if bin overflow is enabled in a histogram chart or pareto chart.
getAllowUnderflow()

Specifies if bin underflow is enabled in a histogram chart or pareto chart.
getCount()

Specifies the bin count of a histogram chart or pareto chart.
getOverflowValue()

Specifies the bin overflow value of a histogram chart or pareto chart.
getType()

Specifies the bin's type for a histogram chart or pareto chart.
getUnderflowValue()

Specifies the bin underflow value of a histogram chart or pareto chart.
getWidth()

Specifies the bin width value of a histogram chart or pareto chart.
setAllowOverflow(allowOverflow)

Specifies if bin overflow is enabled in a histogram chart or pareto chart.
setAllowUnderflow(allowUnderflow)

Specifies if bin underflow is enabled in a histogram chart or pareto chart.
setCount(count)

Specifies the bin count of a histogram chart or pareto chart.
setOverflowValue(overflowValue)

Specifies the bin overflow value of a histogram chart or pareto chart.
setType(type)

Specifies the bin's type for a histogram chart or pareto chart.
setUnderflowValue(underflowValue)

Specifies the bin underflow value of a histogram chart or pareto chart.
setWidth(width)

Specifies the bin width value of a histogram chart or pareto chart.

Method Details

getAllowOverflow()

Specifies if bin overflow is enabled in a histogram chart or pareto chart.

getAllowOverflow(): boolean;

Returns

boolean

getAllowUnderflow()

Specifies if bin underflow is enabled in a histogram chart or pareto chart.

getAllowUnderflow(): boolean;

Returns

boolean

getCount()

Specifies the bin count of a histogram chart or pareto chart.

getCount(): number;

Returns

number

getOverflowValue()

Specifies the bin overflow value of a histogram chart or pareto chart.

getOverflowValue(): number;

Returns

number

getType()

Specifies the bin's type for a histogram chart or pareto chart.

getType(): ChartBinType;

Returns

ExcelScript.ChartBinType

getUnderflowValue()

Specifies the bin underflow value of a histogram chart or pareto chart.

getUnderflowValue(): number;

Returns

number

getWidth()

Specifies the bin width value of a histogram chart or pareto chart.

getWidth(): number;

Returns

number

setAllowOverflow(allowOverflow)

Specifies if bin overflow is enabled in a histogram chart or pareto chart.

setAllowOverflow(allowOverflow: boolean): void;

Parameters

allowOverflow

boolean

Returns

void

setAllowUnderflow(allowUnderflow)

Specifies if bin underflow is enabled in a histogram chart or pareto chart.

setAllowUnderflow(allowUnderflow: boolean): void;

Parameters

allowUnderflow

boolean

Returns

void

setCount(count)

Specifies the bin count of a histogram chart or pareto chart.

setCount(count: number): void;

Parameters

count

number

Returns

void

setOverflowValue(overflowValue)

Specifies the bin overflow value of a histogram chart or pareto chart.

setOverflowValue(overflowValue: number): void;

Parameters

overflowValue

number

Returns

void

setType(type)

Specifies the bin's type for a histogram chart or pareto chart.

setType(type: ChartBinType): void;

Parameters

type
ExcelScript.ChartBinType

Returns

void

setUnderflowValue(underflowValue)

Specifies the bin underflow value of a histogram chart or pareto chart.

setUnderflowValue(underflowValue: number): void;

Parameters

underflowValue

number

Returns

void

setWidth(width)

Specifies the bin width value of a histogram chart or pareto chart.

setWidth(width: number): void;

Parameters

width

number

Returns

void