-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.interfaces.rangeareasdata.yml
152 lines (152 loc) · 6.27 KB
/
excel.interfaces.rangeareasdata.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
### YamlMime:TSType
name: Excel.Interfaces.RangeAreasData
uid: 'excel!Excel.Interfaces.RangeAreasData:interface'
package: excel!
fullName: Excel.Interfaces.RangeAreasData
summary: An interface describing the data returned by calling `rangeAreas.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: address
uid: 'excel!Excel.Interfaces.RangeAreasData#address:member'
package: excel!
fullName: address
summary: >-
Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular
block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4").
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'address?: string;'
return:
type: string
- name: addressLocal
uid: 'excel!Excel.Interfaces.RangeAreasData#addressLocal:member'
package: excel!
fullName: addressLocal
summary: Returns the `RangeAreas` reference in the user locale.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'addressLocal?: string;'
return:
type: string
- name: areaCount
uid: 'excel!Excel.Interfaces.RangeAreasData#areaCount:member'
package: excel!
fullName: areaCount
summary: Returns the number of rectangular ranges that comprise this `RangeAreas` object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'areaCount?: number;'
return:
type: number
- name: areas
uid: 'excel!Excel.Interfaces.RangeAreasData#areas:member'
package: excel!
fullName: areas
summary: Returns a collection of rectangular ranges that comprise this `RangeAreas` object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'areas?: Excel.Interfaces.RangeData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeData:interface" />[]'
- name: cellCount
uid: 'excel!Excel.Interfaces.RangeAreasData#cellCount:member'
package: excel!
fullName: cellCount
summary: >-
Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual
rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647).
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'cellCount?: number;'
return:
type: number
- name: conditionalFormats
uid: 'excel!Excel.Interfaces.RangeAreasData#conditionalFormats:member'
package: excel!
fullName: conditionalFormats
summary: Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.ConditionalFormatData:interface" />[]'
- name: dataValidation
uid: 'excel!Excel.Interfaces.RangeAreasData#dataValidation:member'
package: excel!
fullName: dataValidation
summary: Returns a data validation object for all ranges in the `RangeAreas`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'dataValidation?: Excel.Interfaces.DataValidationData;'
return:
type: '<xref uid="excel!Excel.Interfaces.DataValidationData:interface" />'
- name: format
uid: 'excel!Excel.Interfaces.RangeAreasData#format:member'
package: excel!
fullName: format
summary: >-
Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all
ranges in the `RangeAreas` object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'format?: Excel.Interfaces.RangeFormatData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFormatData:interface" />'
- name: isEntireColumn
uid: 'excel!Excel.Interfaces.RangeAreasData#isEntireColumn:member'
package: excel!
fullName: isEntireColumn
summary: 'Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isEntireColumn?: boolean;'
return:
type: boolean
- name: isEntireRow
uid: 'excel!Excel.Interfaces.RangeAreasData#isEntireRow:member'
package: excel!
fullName: isEntireRow
summary: 'Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isEntireRow?: boolean;'
return:
type: boolean
- name: style
uid: 'excel!Excel.Interfaces.RangeAreasData#style:member'
package: excel!
fullName: style
summary: >-
Represents the style for all ranges in this `RangeAreas` object. If the styles of the cells are inconsistent,
`null` will be returned. For custom styles, the style name will be returned. For built-in styles, a string
representing a value in the `BuiltInStyle` enum will be returned.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'style?: string;'
return:
type: string