类: Chart

Sheets.Charts.Chart

Table of contents

构造方法

• constructor

属性

• typeName

方法

• allowMove
• allowResize
• alt
• axes
• canPrint
• chartArea
• chartType
• cloneContent
• content
• dataLabels
• dataRange
• displayBlanksAs
• displayNaAsBlank
• dynamicMove
• dynamicSize
• endColumn
• endColumnOffset
• endRow
• endRowOffset
• fixedPosition
• formatOvers
• getFormula
• getHost
• height
• hoverStyle
• ignoreHidden
• isLocked
• isSelected
• isVisible
• legend
• name
• refreshContent
• series
• setFormula
• startColumn
• startColumnOffset
• startRow
• startRowOffset
• switchDataOrientation
• title
• useAnimation
• width
• x
• y

构造方法

constructor

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

图表

参数

属性名	类型	说明
sheet	Worksheet	图表的主表
name	string	图表名称
chartType	ChartType	图表的类型
x	number	图表的 x 位置
y	number	图表的 y 位置
width	number	图表的宽度
height	number	图表的高度
dataRange?	string	图表数据区域的公式字符串
dataOrientation?	RowCol	系列数据的方向

属性

typeName

• typeName: string

支持序列化的类型名称字符串

方法

allowMove

▸ allowMove(value?): any

获取或设置是否禁用移动浮动对象元素

参数

属性名	类型	说明
value?	boolean	是否禁用移动浮动对象元素的设置

返回值

any

如果未设置任何值，则返回是否禁用移动浮动对象元素的设置；否则，返回浮动对象元素

---

allowResize

▸ allowResize(value?): any

获取或设置是否禁用调整浮动对象的大小

参数

属性名	类型	说明
value?	boolean	是否禁用调整浮动对象大小的设置

返回值

any

如果未设置任何值，则返回是否禁用调整浮动对象大小的设置；否则，返回浮动对象

---

alt

▸ alt(value?): any

获取或设置浮动对象的可选文本

参数

属性名	类型	说明
value?	string	浮动对象的可选文本

返回值

any

浮动对象的可选文本

---

axes

▸ axes(value?): any

获取或设置图表的图表轴

参数

属性名	类型	说明
value?	IAxes	图表的图表轴

返回值

any

如果未设置值，返回图表的图表轴；否则，返回图表

majorGridLine和minorGridLine有相同的类型

---

canPrint

▸ canPrint(value?): any

获取或设置此图表是否可打印

参数

属性名	类型	说明
value?	boolean	指示此图表是否可打印

返回值

any

如果未设置值，则返回此图表是否可打印

---

chartArea

▸ chartArea(value?): any

获取或设置图表的图表区域样式

参数

属性名	类型	说明
value?	IChartArea	图表的图表区域样式

返回值

any

如果未设置值，则返回图表的图表区样式；否则，返回图表

---

chartType

▸ chartType(value?): any

获取或设置图表的类型

参数

属性名	类型	说明
value?	ChartType	图表的类型

返回值

any

如果未设置任何值，则返回图表的类型；否则，返回图表

---

cloneContent

▸ cloneContent(): HTMLElement

获取当前实例的内容副本

返回值

HTMLElement

当前实例内容的副本

---

content

▸ content(value?): any

获取或设置自定义浮动对象元素的内容

deprecated 从 17.0.0 版本开始，该方法在图表插件中不可用，要使用该方法，请使用 legacy-charts 插件

参数

属性名	类型	说明
value?	HTMLElement	自定义浮动对象元素的内容

返回值

any

如果未设置任何值，则返回自定义浮动对象元素的内容；否则，返回浮动对象元素

---

dataLabels

▸ dataLabels(value?): any

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

参数

属性名	类型	说明
value?	IDataLabels	The chart data labels style of the chart.

返回值

any

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

---

dataRange

▸ dataRange(value?): any

获取或设置图表的整个数据区域作为公式字符串

参数

属性名	类型	说明
value?	string	图表数据区域的公式字符串

返回值

any

如果未设置任何值，则返回图表整个数据区域的公式字符串；否则，返回图表

---

displayBlanksAs

▸ displayBlanksAs(value?): any

获取或设置图表显示空白数据的方式

参数

属性名	类型	说明
value?	DisplayBlanksAs	图表显示空白数据的方式

返回值

any

如果未设置任何值，则返回图表显示空白数据的方式，否则返回图表

---

displayNaAsBlank

▸ displayNaAsBlank(value?): boolean | Chart

获取或设置是否将＃N / A单元格显示为空白单元格

参数

属性名	类型	说明
value?	boolean	是否将＃N / A单元格显示为空白单元格

返回值

boolean | Chart

如果未设置任何值，则返回是否将＃N / A单元格显示为空白单元格，否则，返回图表

---

dynamicMove

▸ dynamicMove(value?): any

获取或设置对象在隐藏或显示，调整大小或移动行或列时是否移动

参数

属性名	类型	说明
value?	boolean	该值指示对象在隐藏或显示，调整大小或移动行或列时是否移动

返回值

any

如果未设置任何值，则返回此浮动对象元素是否动态移动；否则，返回浮动对象元素

---

dynamicSize

▸ dynamicSize(value?): any

获取或设置在隐藏或显示，调整大小或移动行或列时对象的大小是否改变

参数

属性名	类型	说明
value?	boolean	该值指示在隐藏或显示，调整大小或移动行或列时对象的大小是否改变

返回值

any

如果未设置任何值，则返回此浮动对象元素是否动态更改大小；否则，返回浮动对象元素

---

endColumn

▸ endColumn(value?): any

获取或设置浮动对象元素位置的结束列索引

参数

属性名	类型	说明
value?	number	浮动对象元素位置的结束列索引

返回值

any

如果未设置任何值，则返回浮动对象元素位置的结束列索引；否则，返回浮动对象元素

---

endColumnOffset

▸ endColumnOffset(value?): any

获取或设置相对于浮动对象元素的结束列的偏移量

参数

属性名	类型	说明
value?	number	相对于浮动对象元素的结束列的偏移量

返回值

any

如果未设置任何值，则返回相对于浮动对象元素的结束列的偏移量；否则，返回浮动对象元素

---

endRow

▸ endRow(value?): any

获取或设置浮动对象元素位置的末行索引

参数

属性名	类型	说明
value?	number	浮动对象元素位置的末行索引

返回值

any

如果未设置任何值，则返回浮动对象元素位置的末端行索引；否则，返回浮动对象元素

---

endRowOffset

▸ endRowOffset(value?): any

获取或设置相对于浮动对象元素的最后一行的偏移量

参数

属性名	类型	说明
value?	number	相对于浮动对象元素的最后一行的偏移量

返回值

any

如果未设置任何值，则返回相对于浮动对象元素的最后一行的偏移量；否则，返回浮动对象元素

---

fixedPosition

▸ fixedPosition(value): any

获取或设置浮动对象元素的位置是否固定 当fixedPosition为true时,dynamicMove和dynamicSize被禁用

deprecated 从 17.0.0 版本开始，该方法在图表插件中不可用，要使用该方法，请使用 legacy-charts 插件

参数

属性名	类型	说明
value	boolean	该值指示浮动对象元素的位置是否固定

返回值

any

如果未设置任何值，则返回浮动对象元素的位置是否固定 否则，返回浮动对象元素

---

formatOvers

▸ formatOvers(value?): Chart | IFormatOvers

获取或设置瀑布图不同点收集样式

参数

属性名	类型	说明
value?	IFormatOvers	瀑布图的特定数据点收集样式

返回值

Chart | IFormatOvers

如果未设置值，则返回瀑布图不同点收集样式

---

getFormula

▸ getFormula(path): string

通过路径从图表中获取公式字符串

参数

属性名	类型	说明
path	string	可以接受公式字符串的路径可以是“ x”，“ y”，“ width”，“height”之一

返回值

string

通过路径返回图表中的公式字符串

---

getHost

▸ getHost(): HTMLElement[]

获取自定义内容的dom宿主

deprecated 从 17.0.0 版本开始，该方法在图表插件中不可用，要使用该方法，请使用 legacy-charts 插件

返回值

HTMLElement[]

---

height

▸ height(value?): any

获取或设置浮动对象元素的高度

参数

属性名	类型	说明
value?	number	浮动对象元素的高度

返回值

any

如果未设置任何值，则返回一个浮动对象元素的高度；否则，返回浮动对象元素

---

hoverStyle

▸ hoverStyle(value?): any

获取或设置用户悬停在数据点上时的样式

参数

属性名	类型	说明
value?	IHoverStyle	悬停的数据点的悬停样式

返回值

any

如果未设置值，则返回图表的当前悬停样式；否则，返回图表

---

ignoreHidden

▸ ignoreHidden(value?): boolean | Chart

获取或设置图表显示隐藏的行和列数据的方式

参数

属性名	类型	说明
value?	boolean	图表显示隐藏的行和列数据时的值

返回值

boolean | Chart

如果未设置任何值，则返回如果图表显示隐藏的行和列数据的值，否则返回该图表

---

isLocked

▸ isLocked(value?): any

获取或设置此浮动对象元素是否被锁定

参数

属性名	类型	说明
value?	boolean	该值指示此浮动对象元素是否被锁定

返回值

any

如果未设置任何值，则返回此浮动对象元素是否被锁定；否则，返回浮动对象元素

---

isSelected

▸ isSelected(value?): any

获取或设置是否选择此浮动对象元素

参数

属性名	类型	说明
value?	boolean	该值指示此浮动对象元素是否被选择

返回值

any

如果未设置任何值，则返回是否选择此浮动对象元素；否则，返回浮动对象元素

---

isVisible

▸ isVisible(value?): any

获取或设置此浮动对象元素是否可见

参数

属性名	类型	说明
value?	boolean	该值指示此浮动对象元素是否可见

返回值

any

如果未设置任何值，则返回此浮动对象元素是否可见；否则，返回浮动对象元素

---

legend

▸ legend(value?): any

获取或设置图表的图例

参数

属性名	类型	说明
value?	IChartLegend	图表的图例

返回值

any

如果未设置值，请返回图表的图例；否则，返回图表

---

name

▸ name(value?): any

获取浮动对象元素的名称

参数

属性名	类型	说明
value?	string	浮动对象元素的名称

返回值

any

如果未设置任何值，则返回浮动对象元素的名称；否则，返回浮动对象元素

---

refreshContent

▸ refreshContent(): void

刷新floatObject中的内容用户应重写此方法，以使其内容与floatObject同步

返回值

void

---

series

▸ series(): SeriesCollection

获取图表的系列集合

返回值

SeriesCollection

返回图表的系列集合

---

setFormula

▸ setFormula(path, formula): void

为图表通过路径将公式字符串设置

参数

属性名	类型	说明
path	string	可以接受公式字符串的路径可以是“x”，“y”，“width”，“height”之一
formula	string	公式字符串

返回值

void

---

startColumn

▸ startColumn(value?): any

获取或设置浮动对象元素位置的起始列索引

参数

属性名	类型	说明
value?	number	浮动对象元素位置的起始列索引

返回值

any

如果未设置任何值，则返回浮动对象元素位置的起始列索引；否则，返回浮动对象元素

---

startColumnOffset

▸ startColumnOffset(value?): any

获取或设置相对于浮动对象元素的起始列的偏移量

参数

属性名	类型	说明
value?	number	相对于浮动对象元素的起始列的偏移量

返回值

any

如果未设置任何值，则返回相对于浮动对象元素的起始列的偏移量；否则，返回浮动对象元素

---

startRow

▸ startRow(value?): any

获取或设置浮动对象元素位置的起始行索引

参数

属性名	类型	说明
value?	number	动对象元素位置的起始行索引

返回值

any

如果未设置任何值，则返回浮动对象元素位置的起始行索引；否则，返回浮动对象

---

startRowOffset

▸ startRowOffset(value?): any

获取或设置相对于浮动对象元素的起始行的偏移量

参数

属性名	类型	说明
value?	number	相对于浮动对象元素的起始行的偏移量

返回值

any

如果未设置任何值，则返回相对于浮动对象元素起始行的偏移量；否则，返回浮动对象元素

---

switchDataOrientation

▸ switchDataOrientation(): boolean

在行和列之间切换数据方向

返回值

boolean

当数据方向可以更改并成功切换时，返回true;否则为假

---

title

▸ title(value?): any

获取或设置图表标题

参数

属性名	类型	说明
value?	IChartTitle	图表标题

返回值

any

如果未设置任何值，则返回图表标题；否则，返回图表

---

useAnimation

▸ useAnimation(value?): any

获取或设置是否将动画应用于图表

参数

属性名	类型	说明
value?	boolean	是否将动画应用于图表

返回值

any

如果未设置任何值，则返回是否将动画应用于图表；否则，返回图表

---

width

▸ width(value?): any

获取或设置浮动对象元素的宽度

参数

属性名	类型	说明
value?	number	浮动对象元素的宽度

返回值

any

如果未设置任何值，则返回一个浮动对象元素的宽度；否则，返回浮动对象元素

---

x

▸ x(value?): any

获取或设置浮动对象元素的水平位置

参数

属性名	类型	说明
value?	number	浮动对象元素的水平位置

返回值

any

如果未设置任何值，则返回浮动对象元素的水平位置；否则，返回浮动对象元素

---

y

▸ y(value?): any

获取或设置浮动对象元素的垂直位置

参数

属性名	类型	说明
value?	number	获取或设置浮动对象元素的垂直位置

返回值

any

如果未设置任何值，则返回浮动对象对象的垂直位置；否则，返回浮动对象元素