[]
        
(Showing Draft Content)

GC.Spread.Sheets.Charts.Chart

Class: Chart

Sheets.Charts.Chart

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Chart(sheet, name, chartType, x, y, width, height, dataRange?, dataOrientation?, colorScheme?)

Represents a chart.

Parameters

Name Type Description
sheet Worksheet The host sheet of the chart.
name string The name of the chart.
chartType ChartType The type of the chart.
x number The x location of the chart.
y number The y location of the chart.
width number The width of the chart.
height number The height of the chart.
dataRange? string -
dataOrientation? RowCol -
colorScheme? ColorScheme -

Properties

typeName

typeName: string

Represents the type name string used for supporting serialization.

Methods

allowMove

allowMove(value?): any

Gets or sets whether to disable moving the chart.

Parameters

Name Type Description
value? boolean The setting for whether to disable moving the chart.

Returns

any

If no value is set, returns the setting for whether to disable moving the chart; otherwise, returns the chart.


allowResize

allowResize(value?): any

Gets or sets whether to disable resizing the chart.

Parameters

Name Type Description
value? boolean The setting for whether to disable resizing the chart.

Returns

any

If no value is set, returns the setting for whether to disable resizing the chart; otherwise, returns the chart.


alt

alt(value?): any

Gets or sets the alternative text of the chart for screen readers.

Parameters

Name Type Description
value? string The alternative text of the chart.

Returns

any

The alternative text of the chart.


axes

axes(value?): any

Gets or sets the chart axes of the chart.

Parameters

Name Type
value? IAxes

Returns

any

If no value is set, returns the chart axes of the chart; otherwise, returns the chart.


canPrint

canPrint(value?): any

Gets or sets whether this chart is printable.

Parameters

Name Type Description
value? boolean The value that indicates whether this chart is printable.

Returns

any

If no value is set, returns whether this chart is printable.


chartArea

chartArea(value?): any

Gets or sets the chart area style of the chart.

Parameters

Name Type
value? IChartArea

Returns

any

If no value is set, returns the chart area style of the chart; otherwise, returns the chart.


chartType

chartType(value?): any

Gets or sets the type of the chart.

Parameters

Name Type
value? ChartType

Returns

any

If no value is set, returns the type of the chart; otherwise, returns the chart.


cloneContent

cloneContent(): HTMLElement

Gets a copy of the current content of the instance.

deprecated since version 17.0.0, This method is not available in the charts plugin, to use this method, please use the legacy-charts plugin.

Returns

HTMLElement

A copy of the current content of the instance.


colorScheme

colorScheme(value?): ColorScheme | Chart

Gets or sets the chart colors.

Parameters

Name Type Description
value? ColorScheme that represent the chart color style.

Returns

ColorScheme | Chart

If no value is set, returns the current chart color style, otherwise, returns the chart.


content

content(value?): any

Gets or sets the content of the custom chart.

deprecated since version 17.0.0, This method is not available in the charts plugin, to use this method, please use the legacy-charts plugin.

Parameters

Name Type Description
value? HTMLElement The content of the custom chart.

Returns

any

If no value is set, returns the content of the custom chart; otherwise, returns the chart.


dataLabels

dataLabels(value?): any

Gets or sets the chart data labels style of the chart.

Parameters

Name Type
value? IDataLabels

Returns

any

If no value is set, returns the chart data labels style of the chart; otherwise, returns the chart.


dataRange

dataRange(value?): any

Gets or sets the whole data range of the chart as formula string.

Parameters

Name Type
value? string

Returns

any

If no value is set, returns the formula string of the whole data range for the chart; otherwise, returns the chart.


displayBlanksAs

displayBlanksAs(value?): any

Gets or sets the way that the chart display blank data.

Parameters

Name Type
value? DisplayBlanksAs

Returns

any

If no value is set, returns the way that the chart display blank data, otherwise, returns the chart.


displayNaAsBlank

displayNaAsBlank(value?): boolean | Chart

Gets or sets whether to show #N/A cells as blank cells.

Parameters

Name Type Description
value? boolean that whether to show #N/A cells as blank cells.

Returns

boolean | Chart

If no value is set, returns whether to show #N/A cells as blank cells, otherwise, returns the chart.


dynamicMove

dynamicMove(value?): any

Gets or sets whether the object moves when hiding or showing, resizing, or moving rows or columns.

Parameters

Name Type Description
value? boolean The value indicates whether the object moves when hiding or showing, resizing, or moving rows or columns.

Returns

any

If no value is set, returns whether this chart dynamically moves; otherwise, returns the chart.


dynamicSize

dynamicSize(value?): any

Gets or sets whether the position of the chart is fixed. When fixedPosition is true, dynamicMove and dynamicSize are disabled.

Parameters

Name Type Description
value? boolean The value indicates whether the position of the chart is fixed.

Returns

any

If no value is set, returns whether the position of the chart is fixed; otherwise, returns the chart.


endColumn

endColumn(value?): any

Gets or sets the end column index of the chart position.

Parameters

Name Type Description
value? number The end column index of the chart position.

Returns

any

If no value is set, returns the end column index of the chart position; otherwise, returns the chart.


endColumnOffset

endColumnOffset(value?): any

Gets or sets the offset relative to the end column of the chart.

Parameters

Name Type Description
value? number The offset relative to the end column of the chart.

Returns

any

If no value is set, returns the offset relative to the end column of the chart; otherwise, returns the chart.


endRow

endRow(value?): any

Gets or sets the end row index of the chart position.

Parameters

Name Type Description
value? number The end row index of the chart position.

Returns

any

If no value is set, returns the end row index of the chart position; otherwise, returns the chart.


endRowOffset

endRowOffset(value?): any

Gets or sets the offset relative to the end row of the chart.

Parameters

Name Type Description
value? number The offset relative to the end row of the chart.

Returns

any

If no value is set, returns the offset relative to the end row of the chart; otherwise, returns the chart.


fixedPosition

fixedPosition(value): any

Gets or sets whether the size of the object changes when hiding or showing, resizing, or moving rows or columns.

deprecated since version 17.0.0, This method is not available in the charts plugin, to use this method, please use the legacy-charts plugin.

Parameters

Name Type Description
value boolean The value indicates whether the size of the object changes when hiding or showing, resizing, or moving rows or columns.

Returns

any

If no value is set, returns whether this chart dynamically changes size; otherwise, returns the chart.


formatOvers

formatOvers(value?): IFormatOvers | Chart

Gets or sets waterfall chart different points collection style.

Parameters

Name Type Description
value? IFormatOvers The specific data points collection style of the waterfall chart.

Returns

IFormatOvers | Chart

If no value is set, return waterfall chart different points collection styles


getFormula

getFormula(path): string

Gets the formula string from the chart by the path.

Parameters

Name Type Description
path string The path which can accept a formula string, it could be one of "x", "y", "width", "height".

Returns

string

Returns the formula string from the chart by the path.


getHost

getHost(): HTMLElement[]

Gets the dom host of the custom content.

deprecated since version 17.0.0, This method is not available in the charts plugin, to use this method, please use the legacy-charts plugin.

Returns

HTMLElement[]


height

height(value?): any

Gets or sets the height of a chart.

Parameters

Name Type Description
value? number The height of a chart.

Returns

any

If no value is set, returns the height of a chart; otherwise, returns the chart.


hoverStyle

hoverStyle(value?): any

Gets or sets the style when user hover over the dataPoint.

Parameters

Name Type
value? IHoverStyle

Returns

any

If no value is set, returns the current hover style of the chart; otherwise, returns the chart.


ignoreHidden

ignoreHidden(value?): boolean | Chart

Gets or sets the way that if the chart display hidden rows and columns data.

Parameters

Name Type Description
value? boolean the value that if the chart display hidden rows and columns data.

Returns

boolean | Chart

If no value is set, returns the value that if the chart display hidden rows and columns data, otherwise, returns the chart.


isLocked

isLocked(value?): any

Gets or sets whether this chart is locked.

Parameters

Name Type Description
value? boolean The value that indicates whether this chart is locked.

Returns

any

If no value is set, returns whether this chart is locked; otherwise, returns the chart.


isSelected

isSelected(value?): any

Gets or sets whether this chart is selected.

Parameters

Name Type Description
value? boolean The value that indicates whether this chart is selected.

Returns

any

If no value is set, returns whether this chart is selected; otherwise, returns the chart.


isVisible

isVisible(value?): any

Gets or sets whether this chart is visible.

Parameters

Name Type Description
value? boolean The value that indicates whether this chart is visible.

Returns

any

If no value is set, returns whether this chart is visible; otherwise, returns the chart.


legend

legend(value?): any

Gets or sets the legend of the chart.

Parameters

Name Type
value? IChartLegend

Returns

any

If no value is set, returns the legend of the chart; otherwise, returns the chart.


name

name(value?): any

Gets the name of the chart.

Parameters

Name Type Description
value? string The name of the chart.

Returns

any

If no value is set, returns the name of the chart; otherwise, returns the chart.


refreshContent

refreshContent(): void

Refreshes the chart, in most cases does not need to call this method.

Returns

void


series

series(): SeriesCollection

Gets the series collection of the chart.

Returns

SeriesCollection

Returns the series collection of the chart.


setFormula

setFormula(path, formula): void

Sets the formula string to the chart by the path.

Parameters

Name Type Description
path string The path which can accept a formula string, it could be one of "x", "y", "width", "height".
formula string The formula string.

Returns

void


startColumn

startColumn(value?): any

Gets or sets the starting column index of the chart position.

Parameters

Name Type Description
value? number The starting column index of the chart position.

Returns

any

If no value is set, returns the starting column index of the chart position; otherwise, returns the chart.


startColumnOffset

startColumnOffset(value?): any

Gets or sets the offset relative to the start column of the chart.

Parameters

Name Type Description
value? number The offset relative to the start column of the chart.

Returns

any

If no value is set, returns the offset relative to the start column of the chart; otherwise, returns the chart.


startRow

startRow(value?): any

Gets or sets the starting row index of the chart position.

Parameters

Name Type Description
value? number The starting row index of the chart position.

Returns

any

If no value is set, returns the starting row index of the chart position; otherwise, returns the chart.


startRowOffset

startRowOffset(value?): any

Gets or sets the offset relative to the start row of the chart.

Parameters

Name Type Description
value? number The offset relative to the start row of the chart.

Returns

any

If no value is set, returns the offset relative to the start row of the chart; otherwise, returns the chart.


switchDataOrientation

switchDataOrientation(): boolean

Switches the data orientation between rows and columns.

Returns

boolean

Returns true when data orienetation is changable and successful switched; otherwise, false.


title

title(value?): any

Gets or sets the title of the chart.

Parameters

Name Type
value? IChartTitle

Returns

any

If no value is set, returns the title of the chart; otherwise, returns the chart.


toImageSrc

toImageSrc(): string

Get the chart Image src of type Base64 string.

example

let chartImageSrc = sheet.charts.all()[0].toImageSrc();

Returns

string

return the chart Image Base64 src string.


useAnimation

useAnimation(value?): any

Gets or sets whether apply animation to the chart.

Parameters

Name Type
value? boolean

Returns

any

If no value is set, returns whether apply animation to the chart; otherwise, returns the chart.


width

width(value?): any

Gets or sets the width of a chart.

Parameters

Name Type Description
value? number The width of a chart.

Returns

any

If no value is set, returns the width of a chart; otherwise, returns the chart.


x

x(value?): any

Gets or sets the horizontal location of the chart.

Parameters

Name Type Description
value? number The horizontal location of the chart.

Returns

any

If no value is set, returns the horizontal location of the chart; otherwise, returns the chart.


y

y(value?): any

Gets or sets the vertical location of the chart.

Parameters

Name Type Description
value? number The vertical location of the chart.

Returns

any

If no value is set, returns the vertical location of the chart; otherwise, returns the chart.