-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.chartfill.yml
122 lines (108 loc) · 4.01 KB
/
excel.chartfill.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
### YamlMime:TSType
name: Excel.ChartFill
uid: 'excel!Excel.ChartFill:class'
package: excel!
fullName: Excel.ChartFill
summary: Represents the fill formatting for a chart element.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.ChartFill#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
methods:
- name: clear()
uid: 'excel!Excel.ChartFill#clear:member(1)'
package: excel!
fullName: clear()
summary: Clears the fill color of a chart element.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Clear the line format of the major gridlines on the value axis of the chart named "Chart1".
await Excel.run(async (context) => {
const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
gridlines.format.line.clear();
await context.sync();
console.log("Chart Major Gridlines Format Cleared");
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'clear(): void;'
return:
type: void
description: ''
- name: setSolidColor(color)
uid: 'excel!Excel.ChartFill#setSolidColor:member(1)'
package: excel!
fullName: setSolidColor(color)
summary: Sets the fill formatting of a chart element to a uniform color.
remarks: >-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-point.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
let pointsCollection = sheet.charts.getItemAt(0).series.getItemAt(0).points;
let point = pointsCollection.getItemAt(2);
// Set color for chart point.
point.format.fill.setSolidColor('red');
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'setSolidColor(color: string): void;'
parameters:
- id: color
description: >-
HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500") or as a
named HTML color (e.g., "orange").
type: string
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.ChartFill#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Excel.ChartFill object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.ChartFillData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
toJSON(): {
[key: string]: string;
};
return:
type: |-
{
[key: string]: string;
}
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'