Dart Documentationchrome.devtoolsExtensionSidebarPane

ExtensionSidebarPane class

A sidebar created by the extension.

class ExtensionSidebarPane extends ChromeObject {
 ExtensionSidebarPane();
 ExtensionSidebarPane.fromProxy(JsObject jsProxy): super.fromProxy(jsProxy);

 /**
  * Sets the height of the sidebar.
  * 
  * [height] A CSS-like size specification, such as `'100px'` or `'12ex'`.
  */
 void setHeight(String height) {
   jsProxy.callMethod('setHeight', [height]);
 }

 /**
  * Sets an expression that is evaluated within the inspected page. The result
  * is displayed in the sidebar pane.
  * 
  * [expression] 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.
  * 
  * [rootTitle] An optional title for the root of the expression tree.
  */
 Future setExpression(String expression, [String rootTitle]) {
   var completer = new ChromeCompleter.noArgs();
   jsProxy.callMethod('setExpression', [expression, rootTitle, completer.callback]);
   return completer.future;
 }

 /**
  * Sets a JSON-compliant object to be displayed in the sidebar pane.
  * 
  * [jsonObject] An object to be displayed in context of the inspected page.
  * Evaluated in the context of the caller (API client).
  * 
  * [rootTitle] An optional title for the root of the expression tree.
  */
 Future setObject(String jsonObject, [String rootTitle]) {
   var completer = new ChromeCompleter.noArgs();
   jsProxy.callMethod('setObject', [jsonObject, rootTitle, completer.callback]);
   return completer.future;
 }

 /**
  * Sets an HTML page to be displayed in the sidebar pane.
  * 
  * [path] Relative path of an extension page to display within the sidebar.
  */
 void setPage(String path) {
   jsProxy.callMethod('setPage', [path]);
 }
}

Extends

ChromeObject > ExtensionSidebarPane

Constructors

new ExtensionSidebarPane() #

Create a new instance of a ChromeObject, which creates and delegates to a JsObject proxy.

docs inherited from ChromeObject
ExtensionSidebarPane();

new ExtensionSidebarPane.fromProxy(JsObject jsProxy) #

Create a new instance of a ChromeObject, which delegates to the given JsObject proxy.

docs inherited from ChromeObject
ExtensionSidebarPane.fromProxy(JsObject jsProxy): super.fromProxy(jsProxy);

Properties

final jsProxy #

inherited from ChromeObject
final dynamic jsProxy

Methods

Future setExpression(String expression, [String rootTitle]) #

Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.

expression 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.

rootTitle An optional title for the root of the expression tree.

Future setExpression(String expression, [String rootTitle]) {
 var completer = new ChromeCompleter.noArgs();
 jsProxy.callMethod('setExpression', [expression, rootTitle, completer.callback]);
 return completer.future;
}

void setHeight(String height) #

Sets the height of the sidebar.

height A CSS-like size specification, such as '100px' or '12ex'.

void setHeight(String height) {
 jsProxy.callMethod('setHeight', [height]);
}

Future setObject(String jsonObject, [String rootTitle]) #

Sets a JSON-compliant object to be displayed in the sidebar pane.

jsonObject An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).

rootTitle An optional title for the root of the expression tree.

Future setObject(String jsonObject, [String rootTitle]) {
 var completer = new ChromeCompleter.noArgs();
 jsProxy.callMethod('setObject', [jsonObject, rootTitle, completer.callback]);
 return completer.future;
}

void setPage(String path) #

Sets an HTML page to be displayed in the sidebar pane.

path Relative path of an extension page to display within the sidebar.

void setPage(String path) {
 jsProxy.callMethod('setPage', [path]);
}

JsObject toJs() #

inherited from ChromeObject
JsObject toJs() => jsProxy;

String toString() #

inherited from ChromeObject

Returns a string representation of this object.

docs inherited from Object
String toString() => jsProxy.toString();