Skip to content

Excel chart API update #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ecoteam wants to merge 5 commits into
base: excel
Choose a base branch
from
Open

Excel chart API update #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f56de6d
add new chart api to open spec
May 25, 2017
c87771f
modify chartaxis and chartformatstring
mingwan May 31, 2017
f2da851
add border property to chartseriesformat
mingwan May 31, 2017
e97db63
modify charttitle, charttrendline, charttrendlinecollection
mingwan May 31, 2017
2c893a9
change to charttrendline movingAverage property name
mingwan May 31, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6,130 changes: 6,130 additions & 0 deletions data/ExcelApi_1.7_build.cs
View file
Open in desktop

Large diffs are not rendered by default.

33 changes: 31 additions & 2 deletions markdown/$changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
|Object| What is new| Description|Feedback|
|:----|:----|:----|:----|
|Object| What is new| Description|Feedback|
|:----|:----|:----|:----|
|[chartAxis](../excel/chartaxis.md)|_Property_ > baseUnit|Returns or sets the base unit for the specified category axis. Possible values are: `Days` Specifies the unit of time for chart axes and data series, in days.,`Months` Specifies the unit of time for chart axes and data series, in months.,`Years` Specifies the unit of time for chart axes and data series, in years.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > categoryNames|Returns or sets all the category names for the specified axis, as a text array.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > categoryType|Returns or sets the category axis type. Possible values are: `Automatic` Specifies the type of the category axis. Excel controls the axis type.,`TextAxis` Specifies the type of the category axis. Axis groups data by an arbitrary set of categories.,`DateAxis` Specifies the type of the category axis. Axis groups data on a time scale.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > customDisplayUnit|Represents the custom axis display unit value.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > displayUnit|Represents the axis display unit. Possible values are: `None` Default option. This will reset display unit to the axis, and set unit label invisible.,`Hundreds` This will set the axis in units of hundreds.,`Thousands` This will set the axis in units of thousands.,`TenThousands` This will set the axis in units of tens of thousands.,`HundredThousands` This will set the axis in units of hundreds of thousands.,`Millions` This will set the axis in units of millions.,`TenMillions` This will set the axis in units of tens of millions.,`HundredMillons` This will set the axis in units of hundreds of millions.,`Billions` This will set the axis in units of billions.,`Trillions` This will set the axis in units of trillions.,`Custom` This will set the axis in units of custom value.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > majorUnitScale|Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale. Possible values are: `Days` Specifies the unit of time for chart axes and data series, in days.,`Months` Specifies the unit of time for chart axes and data series, in months.,`Years` Specifies the unit of time for chart axes and data series, in years.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > minorUnitScale|Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale. Possible values are: `Days` Specifies the unit of time for chart axes and data series, in days.,`Months` Specifies the unit of time for chart axes and data series, in months.,`Years` Specifies the unit of time for chart axes and data series, in years.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > showDisplayUnitLabel|Represents whether the axis display unit label is visible.|1.9|
|[chartAxis](../excel/chartaxis.md)|_Property_ > type|Represents the axis type. Read-only. Possible values are: `Category` Specifies the axis type. Axis displays categories.,`Value` Specifies the axis type. Axis displays values.,`SeriesAxis` Specifies the axis type. Axis displays data series.|1.9|
|[chartBorder](../excel/chartborder.md)|_Method_ > [clear()](../excel/chartborder.md#clear)|Clear the border color of a chart element.|1.9|
|[chartBorder](../excel/chartborder.md)|_Method_ > [setSolidColor(color: string)](../excel/chartborder.md#setsolidcolorcolor-string)|Sets the border formatting of a chart element to a uniform color.|1.9|
|[chartFormatString](../excel/chartformatstring.md)|_Relationship_ > font|Represents the font attributes, such as font name, font size, color, etc. of chart characters object. Read-only.|1.9|
|[chartPointFormat](../excel/chartpointformat.md)|_Relationship_ > border|Represents the border format of a chart point, which includes border formating information. Read-only Read-only.|1.9|
|[chartSeries](../excel/chartseries.md)|_Relationship_ > trendlines|Represents a collection of Trendlines in the series. Read-only.|1.9|
|[chartSeries](../excel/chartseries.md)|_Method_ > [delete()](../excel/chartseries.md#delete)|Deletes the chart series.|1.9|
|[chartSeries](../excel/chartseries.md)|_Method_ > [setBubbleSizes(sourceData: Range)](../excel/chartseries.md#setbubblesizessourcedata-range)|Set bubble sizes for a chart series. Only works for bubble charts.|1.9|
|[chartSeries](../excel/chartseries.md)|_Method_ > [setValues(sourceData: Range)](../excel/chartseries.md#setvaluessourcedata-range)|Set values for a chart series. For scatter chart, it means Y axis values.|1.9|
|[chartSeries](../excel/chartseries.md)|_Method_ > [setXAxisValues(sourceData: Range)](../excel/chartseries.md#setxaxisvaluessourcedata-range)|Set values of X axis for a chart series. Only works for scatter charts.|1.9|
|[chartSeriesCollection](../excel/chartseriescollection.md)|_Method_ > [add(name: string, index: number)](../excel/chartseriescollection.md#addname-string-index-number)|Add a new series to the collection.|1.9|
|[chartTitle](../excel/charttitle.md)|_Property_ > horizontalAlignment|Represents the horizontal alignment for chart title. Possible values are: Center, Left, Right, Justify, Distributed.|1.9|
|[chartTitle](../excel/charttitle.md)|_Method_ > [getSubstring(start: number, start: number)](../excel/charttitle.md#getsubstringstart-number-start-number)|Get the characters of a chart title. Line break '\n' also counts one charater.|1.9|
|[chartTrendline](../excel/charttrendline.md)|_Property_ > movingAveragePeriod|Represents the MovingAveragePeriod of a chart trendline, specific for trendline with MovingAverage type.|1.9|
|[chartTrendline](../excel/charttrendline.md)|_Property_ > polynomialOrder|Represents the PolynomialOrder of a chart trendline, specific for trendline with Polynomial type.|1.9|
|[chartTrendline](../excel/charttrendline.md)|_Property_ > type|Represents the Type of a chart trendline. Possible values are: Linear, Expontential, Logarithmic, MovingAvg, Polynomial, Power.|1.9|
|[chartTrendline](../excel/charttrendline.md)|_Relationship_ > format|Represents the formatting of a chart trendline. Read-only.|1.9|
|[chartTrendlineCollection](../excel/charttrendlinecollection.md)|_Property_ > items|A collection of chartTrendline objects. Read-only.|1.9|
|[chartTrendlineCollection](../excel/charttrendlinecollection.md)|_Method_ > [add(type: string)](../excel/charttrendlinecollection.md#addtype-string)|Adds a new trendline to trendline collection.|1.9|
|[chartTrendlineCollection](../excel/charttrendlinecollection.md)|_Method_ > [getCount()](../excel/charttrendlinecollection.md#getcount)|Returns the number of trendlines in the collection.|1.9|
|[chartTrendlineFormat](../excel/charttrendlineformat.md)|_Relationship_ > line|Represents chart line formatting. Read-only.|1.9|
168 changes: 84 additions & 84 deletions markdown/application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,84 +1,84 @@
# Application Object (JavaScript API for Excel)

Represents the Excel application that manages the workbook.

## Properties

| Property | Type |Description| Req. Set|
|:---------------|:--------|:----------|:----|
|calculationMode|string|Returns the calculation mode used in the workbook. Read-only. Possible values are: `Automatic` Excel controls recalculation,`AutomaticExceptTables` Excel controls recalculation but ignores changes in tables.,`Manual` Calculation is done when the user requests it.|[1.1](../requirement-sets/excel-api-requirement-sets.md)|

_See property access [examples.](#property-access-examples)_

## Relationships
None


## Methods

| Method | Return Type |Description| Req. Set|
|:---------------|:--------|:----------|:----|
|[calculate(calculationType: string)](#calculatecalculationtype-string)|void|Recalculate all currently opened workbooks in Excel.|[1.1](../requirement-sets/excel-api-requirement-sets.md)|
|[suspendApiCalculationUntilNextSync()](#suspendapicalculationuntilnextsync)|void|Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.|[1.6](../requirement-sets/excel-api-requirement-sets.md)|

## Method Details


### calculate(calculationType: string)
Recalculate all currently opened workbooks in Excel.

#### Syntax
```js
applicationObject.calculate(calculationType);
```

#### Parameters
| Parameter | Type |Description|
|:---------------|:--------|:----------|
|calculationType|string|Specifies the calculation type to use. Possible values are: `Recalculate` Default-option. Performs normal calculation by calculating all the formulas in the workbook,`Full` Forces a full calculation of the data,`FullRebuild` Forces a full calculation of the data and rebuilds the dependencies.|

#### Returns
void

#### Examples
```js
Excel.run(function (ctx) {
ctx.workbook.application.calculate('Full');
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
```

### suspendApiCalculationUntilNextSync()
Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.

#### Syntax
```js
applicationObject.suspendApiCalculationUntilNextSync();
```

#### Parameters
None

#### Returns
void
### Property access examples
```js
Excel.run(function (ctx) {
var application = ctx.workbook.application;
application.load('calculationMode');
return ctx.sync().then(function() {
console.log(application.calculationMode);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
```

# Application Object (JavaScript API for Excel)
Represents the Excel application that manages the workbook.
## Properties
| Property | Type |Description| Req. Set|
|:---------------|:--------|:----------|:----|
|calculationMode|string|Returns the calculation mode used in the workbook. Read-only. Possible values are: `Automatic` Excel controls recalculation,`AutomaticExceptTables` Excel controls recalculation but ignores changes in tables.,`Manual` Calculation is done when the user requests it.|[1.1](../requirement-sets/excel-api-requirement-sets.md)|
_See property access [examples.](#property-access-examples)_
## Relationships
None
## Methods
| Method | Return Type |Description| Req. Set|
|:---------------|:--------|:----------|:----|
|[calculate(calculationType: string)](#calculatecalculationtype-string)|void|Recalculate all currently opened workbooks in Excel.|[1.1](../requirement-sets/excel-api-requirement-sets.md)|
|[suspendApiCalculationUntilNextSync()](#suspendapicalculationuntilnextsync)|void|Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.|[1.6](../requirement-sets/excel-api-requirement-sets.md)|
## Method Details
### calculate(calculationType: string)
Recalculate all currently opened workbooks in Excel.
#### Syntax
```js
applicationObject.calculate(calculationType);
```
#### Parameters
| Parameter | Type |Description|
|:---------------|:--------|:----------|
|calculationType|string|Specifies the calculation type to use. Possible values are: `Recalculate` Default-option. Performs normal calculation by calculating all the formulas in the workbook,`Full` Forces a full calculation of the data,`FullRebuild` Forces a full calculation of the data and rebuilds the dependencies.|
#### Returns
void
#### Examples
```js
Excel.run(function (ctx) {
ctx.workbook.application.calculate('Full');
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
```
### suspendApiCalculationUntilNextSync()
Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.
#### Syntax
```js
applicationObject.suspendApiCalculationUntilNextSync();
```
#### Parameters
None
#### Returns
void
### Property access examples
```js
Excel.run(function (ctx) {
var application = ctx.workbook.application;
application.load('calculationMode');
return ctx.sync().then(function() {
console.log(application.calculationMode);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
```
Loading