Class: Chart

Sheets.Charts.Chart

Hierarchy

• FloatingObject

  ↳ Chart

Table of contents

Constructors

• constructor

Properties

• typeName

Methods

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

Constructors

constructor

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

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	The formula string of data range for the chart.
dataOrientation?	RowCol	The orientation of data for series.

Overrides

FloatingObject.constructor

Properties

typeName

• typeName: string

Represents the type name string used for supporting serialization.

Inherited from

FloatingObject.typeName

Methods

allowMove

▸ allowMove(value?): any

Gets or sets whether to disable moving the floating object.

example

//This example prevents you from moving or resizing the floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.allowResize(false);
customFloatingObject.allowMove(false);
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.allowMove

---

allowResize

▸ allowResize(value?): any

Gets or sets whether to disable resizing the floating object.

example

//This example prevents you from moving or resizing the floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.allowResize(false);
customFloatingObject.allowMove(false);
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.allowResize

---

alt

▸ alt(value?): any

Gets or sets the alternative text of the floating object for screen readers.

Parameters

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

Returns

any

The alternative text of the floating object.

Inherited from

FloatingObject.alt

---

axes

▸ axes(value?): any

Gets or sets the chart axes of the chart.

Parameters

Name	Type	Description
value?	IAxes	The chart axes of the chart.

Returns

any

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

The majorGridLine and minorGridLine have same type.

---

chartArea

▸ chartArea(value?): any

Gets or sets the chart area style of the chart.

Parameters

Name	Type	Description
value?	IChartArea	The chart area style of the chart.

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	Description
value?	ChartType	The type of the chart.

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.

Returns

HTMLElement

A copy of the current content of the instance.

Inherited from

FloatingObject.cloneContent

---

content

▸ content(value?): any

Gets or sets the content of the custom floating object.

Parameters

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

Returns

any

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

Inherited from

FloatingObject.content

---

dataLabels

▸ dataLabels(value?): any

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

Parameters

Name	Type	Description
value?	IDataLabels	The chart data labels style of the chart.

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	Description
value?	string	The formula string of the data range for the chart.

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	Description
value?	DisplayBlanksAs	the way that the chart display blank data.

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.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

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 floating object dynamically moves; otherwise, returns the floating object.

Inherited from

FloatingObject.dynamicMove

---

dynamicSize

▸ dynamicSize(value?): any

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

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

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 floating object dynamically changes size; otherwise, returns the floating object.

Inherited from

FloatingObject.dynamicSize

---

endColumn

▸ endColumn(value?): any

Gets or sets the end column index of the floating object position.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.endColumn

---

endColumnOffset

▸ endColumnOffset(value?): any

Gets or sets the offset relative to the end column of the floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.endColumnOffset

---

endRow

▸ endRow(value?): any

Gets or sets the end row index of the floating object position.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.endRow

---

endRowOffset

▸ endRowOffset(value?): any

Gets or sets the offset relative to the end row of the floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.endRowOffset

---

fixedPosition

▸ fixedPosition(value): any

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

example

//This example sets the position of the object to fixed.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.fixedPosition(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name	Type	Description
value	boolean	The value indicates whether the position of the floating object is fixed.

Returns

any

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

Inherited from

FloatingObject.fixedPosition

---

getHost

▸ getHost(): HTMLElement[]

Gets the dom host of the custom content.

Returns

HTMLElement[]

Inherited from

FloatingObject.getHost

---

height

▸ height(value?): any

Gets or sets the height of a floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name	Type	Description
value?	number	The height of a floating object.

Returns

any

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

Inherited from

FloatingObject.height

---

hoverStyle

▸ hoverStyle(value?): any

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

Parameters

Name	Type	Description
value?	IHoverStyle	The hover style of the dataPoint been hovered.

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 floating object is locked.

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
customFloatingObject.isLocked(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.options.isProtected = true;

Parameters

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

Returns

any

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

Inherited from

FloatingObject.isLocked

---

isSelected

▸ isSelected(value?): any

Gets or sets whether this floating object is selected.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isSelected(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.isSelected

---

isVisible

▸ isVisible(value?): any

Gets or sets whether this floating object is visible.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.isVisible

---

legend

▸ legend(value?): any

Gets or sets the legend of the chart.

Parameters

Name	Type	Description
value?	IChartLegend	The legend of the chart.

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 floating object.

example

//This example uses the name method.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject();
customFloatingObject.name("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name	Type	Description
value?	string	The name of the floating object.

Returns

any

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

Inherited from

FloatingObject.name

---

refreshContent

▸ refreshContent(): void

Refresh the content in floatingObject.The user should override this method to make their content synchronize with the floatingObject.

Returns

void

Inherited from

FloatingObject.refreshContent

---

series

▸ series(): SeriesCollection

Gets the series collection of the chart.

Returns

SeriesCollection

Returns the series collection of the chart.

---

startColumn

▸ startColumn(value?): any

Gets or sets the starting column index of the floating object position.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.startColumn

---

startColumnOffset

▸ startColumnOffset(value?): any

Gets or sets the offset relative to the start column of the floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.startColumnOffset

---

startRow

▸ startRow(value?): any

Gets or sets the starting row index of the floating object position.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.startRow

---

startRowOffset

▸ startRowOffset(value?): any

Gets or sets the offset relative to the start row of the floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//takes effect when added into the sheet.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.startRowOffset

---

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	Description
value?	IChartTitle	The title of the chart.

Returns

any

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

---

useAnimation

▸ useAnimation(value?): any

Gets or sets whether apply animation to the chart.

Parameters

Name	Type	Description
value?	boolean	whether apply animation to the chart.

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 floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name	Type	Description
value?	number	The width of a floating object.

Returns

any

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

Inherited from

FloatingObject.width

---

x

▸ x(value?): any

Gets or sets the horizontal location of the floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.x

---

y

▸ y(value?): any

Gets or sets the vertical location of the floating object.

example

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

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

Returns

any

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

Inherited from

FloatingObject.y