| blob | 9873bfc4e6aa670988dcd0d76605517209834ece |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 [
6 {
7 "namespace": "devtools.panels",
8 "description": "Use the <code>chrome.devtools.panels</code> API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars.",
9 "nocompile": true,
10 "types": [
11 {
12 "id": "ElementsPanel",
13 "type": "object",
14 "description": "Represents the Elements panel.",
15 "events": [
16 {
17 "name": "onSelectionChanged",
18 "description": "Fired when an object is selected in the panel."
19 }
20 ],
21 "functions": [
22 {
23 "name": "createSidebarPane",
24 "type": "function",
25 "description": "Creates a pane within panel's sidebar.",
26 "parameters": [
27 {
28 "name": "title",
29 "type": "string",
30 "description": "Text that is displayed in sidebar caption."
31 },
32 {
33 "name": "callback",
34 "type": "function",
35 "description": "A callback invoked when the sidebar is created.",
36 "optional": true,
37 "parameters": [
38 {
39 "name": "result",
40 "description": "An ExtensionSidebarPane object for created sidebar pane.",
41 "$ref": "ExtensionSidebarPane"
42 }
43 ]
44 }
45 ]
46 }
47 ]
48 },
49 {
50 "id": "SourcesPanel",
51 "type": "object",
52 "description": "Represents the Sources panel.",
53 "events": [
54 {
55 "name": "onSelectionChanged",
56 "description": "Fired when an object is selected in the panel."
57 }
58 ],
59 "functions": [
60 {
61 "name": "createSidebarPane",
62 "type": "function",
63 "description": "Creates a pane within panel's sidebar.",
64 "parameters": [
65 {
66 "name": "title",
67 "type": "string",
68 "description": "Text that is displayed in sidebar caption."
69 },
70 {
71 "name": "callback",
72 "type": "function",
73 "description": "A callback invoked when the sidebar is created.",
74 "optional": true,
75 "parameters": [
76 {
77 "name": "result",
78 "description": "An ExtensionSidebarPane object for created sidebar pane.",
79 "$ref": "ExtensionSidebarPane"
80 }
81 ]
82 }
83 ]
84 }
85 ]
86 },
87 {
88 "id": "ExtensionPanel",
89 "type": "object",
90 "description": "Represents a panel created by extension.",
91 "functions": [
92 {
93 "name": "createStatusBarButton",
94 "description": "Appends a button to the status bar of the panel.",
95 "parameters": [
96 {
97 "name": "iconPath",
98 "type": "string",
99 "description": "Path to the icon of the button. The file should contain a 64x24-pixel image composed of two 32x24 icons. The left icon is used when the button is inactive; the right icon is displayed when the button is pressed."
100 },
101 {
102 "name": "tooltipText",
103 "type": "string",
104 "description": "Text shown as a tooltip when user hovers the mouse over the button."
105 },
106 {
107 "name": "disabled",
108 "type": "boolean",
109 "description": "Whether the button is disabled."
110 }
111 ],
112 "returns": { "$ref": "Button" }
113 }
114 ],
115 "events": [
116 {
117 "name": "onSearch",
118 "description": "Fired upon a search action (start of a new search, search result navigation, or search being canceled).",
119 "parameters": [
120 {
121 "name": "action",
122 "type": "string",
123 "description": "Type of search action being performed."
124 },
125 {
126 "name": "queryString",
127 "type": "string",
128 "optional": true,
129 "description": "Query string (only for 'performSearch')."
130 }
131 ]
132 },
133 {
134 "name": "onShown",
135 "type": "function",
136 "description": "Fired when the user switches to the panel.",
137 "parameters": [
138 {
139 "name": "window",
140 "type": "object",
141 "isInstanceOf": "global",
142 "additionalProperties": { "type": "any" },
143 "description": "The JavaScript <code>window</code> object of panel's page."
144 }
145 ]
146 },
147 {
148 "name": "onHidden",
149 "type": "function",
150 "description": "Fired when the user switches away from the panel."
151 }
152 ]
153 },
154 {
155 "id": "ExtensionSidebarPane",
156 "type": "object",
157 "description": "A sidebar created by the extension.",
158 "functions": [
159 {
160 "name": "setHeight",
161 "type": "function",
162 "description": "Sets the height of the sidebar.",
163 "parameters": [
164 {
165 "name": "height",
166 "type": "string",
167 "description": "A CSS-like size specification, such as <code>'100px'</code> or <code>'12ex'</code>."
168 }
169 ]
170 },
171 {
172 "name": "setExpression",
173 "type": "function",
174 "description": "Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.",
175 "parameters": [
176 {
177 "name": "expression",
178 "type": "string",
179 "description": "An expression to be evaluated in context of the inspected page. JavaScript objects and DOM nodes are displayed in an expandable tree similar to the console/watch."
180 },
181 {
182 "name": "rootTitle",
183 "type": "string",
184 "optional": true,
185 "description": "An optional title for the root of the expression tree."
186 },
187 {
188 "name": "callback",
189 "type": "function",
190 "optional": true,
191 "description": "A callback invoked after the sidebar pane is updated with the expression evaluation results."
192 }
193 ]
194 },
195 {
196 "name": "setObject",
197 "type": "function",
198 "description": "Sets a JSON-compliant object to be displayed in the sidebar pane.",
199 "parameters": [
200 {
201 "name": "jsonObject",
202 "type": "string",
203 "description": "An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client)."
204 },
205 {
206 "name": "rootTitle",
207 "type": "string",
208 "optional": true,
209 "description": "An optional title for the root of the expression tree."
210 },
211 {
212 "name": "callback",
213 "type": "function",
214 "optional": true,
215 "description": "A callback invoked after the sidebar is updated with the object."
216 }
217 ]
218 },
219 {
220 "name": "setPage",
221 "type": "function",
222 "description": "Sets an HTML page to be displayed in the sidebar pane.",
223 "parameters": [
224 {
225 "name": "path",
226 "type": "string",
227 "description": "Relative path of an extension page to display within the sidebar."
228 }
229 ]
230 }
231 ],
232 "events": [
233 {
234 "name": "onShown",
235 "type": "function",
236 "description": "Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.",
237 "parameters": [
238 {
239 "name": "window",
240 "type": "object",
241 "isInstanceOf": "global",
242 "additionalProperties": { "type": "any" },
243 "description": "The JavaScript <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method."
244 }
245 ]
246 },
247 {
248 "name": "onHidden",
249 "type": "function",
250 "description": "Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane."
251 }
252 ]
253 },
254 {
255 "id": "Button",
256 "type": "object",
257 "description": "A button created by the extension.",
258 "functions": [
259 {
260 "name": "update",
261 "description": "Updates the attributes of the button. If some of the arguments are omitted or <code>null</code>, the corresponding attributes are not updated.",
262 "parameters": [
263 {
264 "name": "iconPath",
265 "type": "string",
266 "optional": true,
267 "description": "Path to the new icon of the button."
268 },
269 {
270 "name": "tooltipText",
271 "type": "string",
272 "optional": true,
273 "description": "Text shown as a tooltip when user hovers the mouse over the button."
274 },
275 {
276 "name": "disabled",
277 "type": "boolean",
278 "optional": true,
279 "description": "Whether the button is disabled."
280 }
281 ]
282 }
283 ],
284 "events": [
285 {
286 "name": "onClicked",
287 "type": "function",
288 "description": "Fired when the button is clicked."
289 }
290 ]
291 }
292 ],
293 "properties": {
294 "elements": {
295 "$ref": "ElementsPanel",
296 "description": "Elements panel."
297 },
298 "sources": {
299 "$ref": "SourcesPanel",
300 "description": "Sources panel."
301 }
302 },
303 "functions": [
304 {
305 "name": "create",
306 "type": "function",
307 "description": "Creates an extension panel.",
308 "parameters": [
309 {
310 "name": "title",
311 "type": "string",
312 "description": "Title that is displayed next to the extension icon in the Developer Tools toolbar."
313 },
314 {
315 "name": "iconPath",
316 "type": "string",
317 "description": "Path of the panel's icon relative to the extension directory."
318 },
319 {
320 "name": "pagePath",
321 "type": "string",
322 "description": "Path of the panel's HTML page relative to the extension directory."
323 },
324 {
325 "name": "callback",
326 "type": "function",
327 "optional": true,
328 "description": "A function that is called when the panel is created.",
329 "parameters": [
330 {
331 "name": "panel",
332 "description": "An ExtensionPanel object representing the created panel.",
333 "$ref": "ExtensionPanel"
334 }
335 ]
336 }
337 ]
338 },
339 {
340 "name": "setOpenResourceHandler",
341 "type": "function",
342 "description": "Specifies the function to be called when the user clicks a resource link in the Developer Tools window. To unset the handler, either call the method with no parameters or pass null as the parameter.",
343 "parameters": [
344 {
345 "name": "callback",
346 "type": "function",
347 "optional": true,
348 "description": "A function that is called when the user clicks on a valid resource link in Developer Tools window. Note that if the user clicks an invalid URL or an XHR, this function is not called.",
349 "parameters": [
350 {
351 "name": "resource",
352 "$ref": "devtools.inspectedWindow.Resource",
353 "description": "A $(ref:devtools.inspectedWindow.Resource) object for the resource that was clicked."
354 }
355 ]
356 }
357 ]
358 },
359 {
360 "name": "openResource",
361 "type": "function",
362 "description": "Requests DevTools to open a URL in a Developer Tools panel.",
363 "parameters": [
364 {
365 "name": "url",
366 "type": "string",
367 "description": "The URL of the resource to open."
368 },
369 {
370 "name": "lineNumber",
371 "type": "integer",
372 "description": "Specifies the line number to scroll to when the resource is loaded."
373 },
374 {
375 "name": "callback",
376 "type": "function",
377 "optional": true,
378 "description": "A function that is called when the resource has been successfully loaded."
379 }
380 ]
381 }
382 ]
383 }
384 ]