browser/cool-api.html

<!DOCTYPE html>
<html>
<head>

	<meta charset="utf-8" />


	<meta name="viewport" content="width=device-width, initial-scale=1.0">


	<link rel="shortcut icon" type="image/x-icon" href="docs/images/favicon.ico" />

	<link rel="stylesheet" href="docs/css/normalize.css" />
	<link rel="stylesheet" href="docs/css/main.css" />

	<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,400italic,700,300' rel='stylesheet' type='text/css'>

	<script src="docs/highlight/highlight.pack.js"></script>
	<script src="docs/js/jquery-2.1.4.min.js"></script>
	<link rel="stylesheet" href="docs/highlight/styles/github-gist.css" />

</head>
<body class="api-page">

<div class="container">


<h2>COOL API Reference</h2>

<div id="toc" class="clearfix">
 	<div class="toc-col last-col">
		<h4 style="color:red;">COOL API</h4>
		<ul>
			<li><a href="#cool-initialization">Initialization</a></li>
			<li><a href="#cool-general">General</a></li>
			<li><a href="#cool-toolbar">Toolbar</a></li>
			<li><a href="#cool-page">Page oriented</a></li>
			<li><a href="#cool-part">Part oriented</a></li>
			<li><a href="#cool-events">Events</a></li>
			<li><a href="#cool-object-values">Object values</a></li>
			<li><a href="#cool-uno-commands">Uno commands</a></li>
		</ul>
	</div>
</div>

<!--<a href="#toc" id="back-to-top">&uarr;</a>-->

<hr />
<p>This reference reflects <strong>COOL master</strong>.</p>

<h2 id="cool-cool">COOL</h2>

<h3 id="cool-initialization">Initialization</h3>

<h4>Usage example</h4>

<pre><code class="javascript">
var map = L.map('map', {
    doc: 'file:///path/to/document',
    server: 'wss://localhost',
    documentContainer: 'document-container'
});</code></pre>

<h4 class="left">Creation</h4>

<table data-id='map'>
	<tr>
		<th>Factory</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>L.map</b>(
			<nobr>&lt;HTMLElement|String&gt; <i>id</i>,</nobr>
			<nobr>&lt;<a href="#map-options">Map options</a>&gt; <i>options?</i> )</nobr>
		</code></td>


		<td>Instantiates a map object given a div element (or its id) and optionally an object literal with map options described below.</td>
	</tr>
</table>

<h4>Options</h4>

<h5>These are the options intended to be used for browser, using any additional options from Leaflet might cause some
unexpected behaviour.</h5>

<table data-id='map'>
	<tr>
		<th>Option</th>
		<th>Type</th>
		<th>Default</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>doc</b></code></td>
		<td><code>String</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>Document URL, the server should be able to access the document.</td>
	</tr>
	<tr>
		<td><code><b>server</b></code></td>
		<td><code>String</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>The websocket server hosting coolwsd using the <code>ws:</code> protocol.
		    Example: wss://localhost:9980</td>
	</tr>
	<tr>
		<td><code><b>webserver</b></code></td>
		<td><code>String</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>The webserver access to hosting coolwsd.  Normally it is
		    derived from 'server', but can be overridden with an own
		    value in case of proxying.  Example: http://localhost:9980</td>
	</tr>
	<tr>
		<td><code><b>permission</b></code></td>
		<td><code>String</code></td>
		<td><code><span class="literal">'view'</span></code></td>
        <td>The document's <a href="#documentpermission-values">permission</a>.</td>
	</tr>
	<tr>
		<td><code><b>timestamp</b></code></td>
		<td><code>String</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>A timestamp of the last modification to the document.</td>
	</tr>
	<tr>
		<td><code><b>documentContainer</b></code></td>
		<td><code>String / DOM element</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>An outer div, containing the map div, that is used internally for the creation of the toolbar.</td>
	</tr>
	<tr>
		<td><code><b>toolbarContainer</b></code></td>
		<td><code>String / DOM element</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>A div used by the default toolbar elements (bold, italic, search, etc.) in browser. If you implement
           your own toolbar and use controls that do not require a toolbar (like the dialog or scroll control) you
          can ignore this.</td>
	</tr>
	<tr>
		<td><code><b>renderingOptions</b></code></td>
		<td><code>Object</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>Enables the continuous, web view, of the document, see the UNO commands below for this parameter.</td>
	</tr>
	<tr>
		<td><code><b>print</b></code></td>
		<td><code>Boolean</code></td>
		<td><code><span class="literal">true</span></code></td>
		<td>Whether the print handler is active (for Chrome).</td>
	</tr>
	<tr>
		<td><code><b>autoFitWidth</b></code></td>
		<td><code>Boolean</code></td>
		<td><code><span class="literal">true</span></code></td>
		<td>Whether the document is automatically zoomed so that the width fits the viewing area when
            the window is resized. The document will not be zoomed in more than map.options.zoom.</td>
	</tr>
	<tr>
		<td><code><b>zoom</b></code></td>
		<td><code>Number</code></td>
		<td><code><span class="literal">10</span></code></td>
		<td>Default zoom level in which the document will be loaded.</td>
	</tr>
	<tr>
		<td><code><b>tileWidthTwips</b></code></td>
		<td><code>Number</code></td>
		<td><code><span class="literal">3840</span></code></td>
		<td>Default tile width in twips (how much of the document is covered horizontally in a 256x256 pixels tile).
            Unless you know what you are doing, this should not be modified;
	    this means twips value for 256 pixels at 96dpi.</td>
	</tr>
	<tr>
		<td><code><b>tileHeightTwips</b></code></td>
		<td><code>Number</code></td>
		<td><code><span class="literal">3840</span></code></td>
		<td>Default tile height in twips (how much of the document is covered vertically in a 256x256 pixels tile).
            Unless you know what you are doing, this should not be modified;
	    this means twips value for 256 pixels at 96dpi.</td>
	</tr>
	<tr>
		<td><code><b>defaultZoom</b></code></td>
		<td><code>Number</code></td>
		<td><code><span class="literal">10</span></code></td>
		<td>The zoom level at which the tile size in twips equals the default size (3840 x 3840).
            Unless you know what you are doing, this should not be modified.</td>
	</tr>
    <tr>
		<td><code><b>cursorURL</b></code></td>
		<td><code>String</code></td>
		<td><code><span class="literal">undefined</span></code></td>
		<td>The path (local to the server) where custom cursor files are stored.</td>
	</tr>
</table>

<h3 id="cool-general">General</h3>

<p>General methods for document interaction.</p>

<table data-id='map'>
	<tr>
		<th>Method</th>
		<th>Returns</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>search</b>(
			<nobr>&lt;String&gt; <i>phrase</i>,</nobr>
			<nobr>&lt;Boolean&gt; <i>backward?</i> )</nobr>
		</code></td>
		<td><code>undefined</code></td>
		<td>Searches for the given phrase downward from the current top border of the viewing area.
        Or backwards if specified.</td>
	</tr>
	<tr>
		<td><code><b>highlightAll</b>(
			<nobr>&lt;String&gt; <i>phrase</i>,</nobr>
		</code></td>
		<td><code>undefined</code></td>
		<td>Highlights all the occurrences of the given phrase. Please note that
			this adds an extra layer for the highlights, so it is possible to
			see both all the highlighted phrase, and the current selection at
			the same time.</td>
	</tr>
	<tr>
		<td><code><b>setPermission</b>(
			<nobr>&lt;<a href="#documentpermission-values">DocumentPermissionValues</a>&gt; <i>documenPermission</i>)</nobr>
		</code></td>
		<td><code>undefined</code></td>
		<td>Sets the permission of the document.</td>
	</tr>
	<tr>
        <td><code><b>getDocSize</b>()</code></td>
		<td><code><a href="#point">Point</a></code></td>
		<td>Returns the document size.</td>
	</tr>
	<tr>
        <td><code><b>getDocType</b>()</code></td>
		<td><code><nobr><a href="#documenttype-values">DocumentTypeValues</a></nobr></code></td>
		<td>Returns the document type.</td>
	</tr>
	<tr>
        <td><code><b>getPageSizes</b>()</code></td>
        <td><code><nobr>{twips: <a href="#bounds">[Bounds]</a>,<br>
                pixels: <a href="#bounds">[Bounds]</a>}</nobr></code></td>
		<td>Returns an object describing the size of each page in twips and pixels.</td>
	</tr>
	<tr>
        <td><code><b>scroll</b>(
			<nobr>&lt;Number&gt;<i>x</i>,</nobr>
			<nobr>&lt;Number&gt;<i>y</i>,</nobr>
			<nobr>&lt;<a href="#scroll-options">ScrollOptions</a>&gt;<i>Options</i>)</nobr>
        </code></td>
		<td><code><nobr>undefined</nobr></code></td>
		<td>Scroll right by 'x' and down by 'y' (or left and up if negative).</td>
	</tr>
	<tr>
        <td><code><b>scrollDown</b>(
			<nobr>&lt;Number&gt;<i>y</i>,</nobr>
			<nobr>&lt;<a href="#scroll-options">ScrollOptions</a>&gt;<i>Options</i>)</nobr>
        </code></td>
		<td><code><nobr>undefined</nobr></code></td>
		<td>Scroll down by 'y' (or up if negative).</td>
	</tr>
	<tr>
        <td><code><b>scrollRight</b>(
			<nobr>&lt;Number&gt;<i>x</i>,</nobr>
			<nobr>&lt;<a href="#scroll-options">ScrollOptions</a>&gt;<i>Options</i>)</nobr>
        </code></td>
		<td><code><nobr>undefined</nobr></code></td>
		<td>Scroll right by 'x' (or left if negative).</td>
	</tr>
	<tr>
        <td><code><b>scrollTop</b>(
			<nobr>&lt;Number&gt;<i>y</i>,</nobr>
			<nobr>&lt;<a href="#scroll-options">ScrollOptions</a>&gt;<i>Options</i>)</nobr>
        </code></td>
		<td><code><nobr>undefined</nobr></code></td>
		<td>Scroll to 'y' offset relative to the beginning of the document.</td>
	</tr>
	<tr>
        <td><code><b>scrollLeft</b>(
			<nobr>&lt;Number&gt;<i>x</i>,</nobr>
			<nobr>&lt;<a href="#scroll-options">ScrollOptions</a>&gt;<i>Options</i>)</nobr>
        </code></td>
		<td><code><nobr>undefined</nobr></code></td>
		<td>Scroll to 'x' offset relative to the beginning of the document.</td>
	</tr>
	<tr>
        <td><code><b>scrollOffset</b>()</code></td>
		<td><code><nobr><a href="#point">Point</a></nobr></code></td>
		<td>Returns the scroll offset relative to the beginning of the document.</td>
	</tr>
	<tr>
        <td><code><b>getPreview</b>(
            &lt;Object&gt;<i>id</i>,<br>
			&lt;Number&gt;<i>index</i>,<br>
			&lt;Number&gt;<i>maxWidth</i>,<br>
			&lt;Number&gt;<i>maxHeight</i>,<br>
            <nobr>&lt;<a href="#getpreview-options">PreviewOptions</a>&gt;<i>options?</i>)</nobr>
		</code></td>
		<td><code>undefined</code></td>
		<td>Triggers the creation of a preview with the given id, of maximum maxWidth X maxHeight size, of the
            page / part with number 'index', keeping the original ratio.</td>
	</tr>
	<tr>
		<td><code><b>getCustomPreview</b>(
            &lt;Object&gt;<i>id</i>,<br>
			&lt;Number&gt;<i>part</i>,<br>
			&lt;Number&gt;<i>width</i>,<br>
			&lt;Number&gt;<i>height</i>,<br>
			&lt;Twips&gt;<i>tilePosX</i>,<br>
			&lt;Twips&gt;<i>tilePosY</i>,<br>
			&lt;Twips&gt;<i>tileWidth</i>,<br>
			&lt;Twips&gt;<i>tileHeight</i>,<br>
            <nobr>&lt;<a href="#getpreview-options">PreviewOptions</a>&gt;<i>options?</i>)</nobr>
		</code></td>
		<td><code>undefined</code></td>
		<td>Triggers the creation of a preview with the given id, of width X height size, of the
            [(tilePosX,tilePosY), (tilePosX + tileWidth, tilePosY + tileHeight)] section of the document.</td>
	</tr>
	<tr>
		<td><code><b>removePreviewUpdate</b>(
			<nobr>&lt;Object&gt;<i>id</i>)</nobr>
        </code></td>
		<td><code>undefined</code></td>
		<td>Cancels the automatic update for the preview defined by 'id'.</td>
	</tr>
	<tr>
		<td><code><b>fitWidthZoom</b>(
			<nobr>&lt;Number&gt;<i>maxZoom</i>)</nobr>
        </code></td>
		<td><code>undefined</code></td>
		<td>Zooms in or out so that the document's width fits the viewing area. The document will not zoom in more
            than `maxZoom` if the parameter is provided.</td>
	</tr>
</table>

<h4 id="scroll-options">ScrollOptions</h4>

<table data-id='values'>
	<tr>
		<th class="width100">property</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>update</b></code></td>
		<td><code>Boolean</code></td>
        <td>Whether the <a href="#updatescrolloffset-event">update-scroll-offset</a> event is fired.</td>
	</tr>
</table>

<h4 id="getpreview-options">PreviewOptions</h4>

<table data-id='values'>
	<tr>
		<th class="width100">property</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>autoUpdate</b></code></td>
		<td><code>Boolean</code></td>
        <td>Whether a new preview is generated automatically when it becomes
        invalid.</td>
	</tr>
	<tr>
	  <td><code><b>broadcast</b></code></td>
	  <td><code>Boolean</code></td>
          <td>Whether new preview should be broadcasted to other clients of same
            document.</td>
	</tr>
</table>

<h3 id="cool-toolbar">Toolbar</h3>

<p>Toolbar methods.</p>

<table data-id='map'>
	<tr>
		<th>Method</th>
		<th>Returns</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>getToolbarCommandValues</b>(
			<nobr>&lt;<a href="#toolbarcommand-values">ToolbarCommandValues</a>&gt; <i>unoCommand</i>)</nobr>
		</code></td>
		<td><code>Object</code></td>
		<td>Returns a JSON mapping of the possible values.</td>
	</tr>
	<tr>
		<td><code><b>toggleCommandState</b>(
			<nobr>&lt;<a href="#commandstatechanged-values">CommandValues</a>&gt; <i>unoCommand</i>)</nobr>
		</code></td>
		<td><code>undefined</code></td>
		<td>Toggles the state for the given UNO command.</td>
	</tr>
	<tr>
		<td><code><b>saveAs</b>(
			<nobr>&lt;String&gt;<i>url</i>,</nobr>
            <nobr>&lt;String&gt;<i>format?</i>,</nobr>
			<nobr>&lt;String&gt;<i>options?</i>)</nobr>
		</code></td>
		<td><code>undefined</code></td>
        <td>Save the document as "format" at the given URL by applying the filter options.</td>
	</tr>
	<tr>
		<td><code><b>downloadAs</b>(
			<nobr>&lt;String&gt;<i>name</i>,</nobr>
			<nobr>&lt;String&gt;<i>format?</i>,</nobr>
            <nobr>&lt;String&gt;<i>options?</i>)</nobr>
		</code></td>
		<td><code>undefined</code></td>
        <td>Download the document as "format" with the name "name" by applying the filter options.</td>
	</tr>
	<tr>
		<td><code><b>print</b>()</code></td>
		<td><code>undefined</code></td>
        <td>Opens the browser's print dialog or prompts the user to download a PDF version of the document.</td>
	</tr>
	<tr>
		<td><code><b>cellEnterString</b>(
            <nobr>&lt;String&gt;<i>formula</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Enters a string of text in the selected cell.</td>
	</tr>
	<tr>
		<td><code><b>insertFile</b>(
            <nobr>&lt;File&gt;<i>file</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Insert a file (graphic) in the document.</td>
	</tr>
	<tr>
		<td><code><b>applyFont</b>(
            <nobr>&lt;String&gt;<i>fontName</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Applies a font.</td>
	</tr>
	<tr>
		<td><code><b>applyFontSize</b>(
            <nobr>&lt;Number&gt;<i>fontSize</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Applies a font size.</td>
	</tr>
	<tr>
		<td><code><b>applyStyle</b>(
            <nobr>&lt;String&gt;<i>style</i>,</nobr>
            <nobr>&lt;String&gt;<i>styleFamily</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Applies a style from a style family.</td>
	</tr>
	<tr>
		<td><code><b>renderFont</b>(
            <nobr>&lt;String&gt;<i>fontName</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Renders the given font in the smallest rectangle it can fit in.</td>
	</tr>
	<tr>
		<td><code><b>sendUnoCommand</b>(
			<nobr>&lt;<a href="#cool-uno-commands">String</a>&gt; <i>unoCommand</i>,</nobr>
			<nobr>&lt;<a href="#cool-uno-commands">Object</a>&gt; <i>param</i>)</nobr></code></td>
		<td><code>undefined</code></td>
        <td>Sends a <a href="#cool-uno-commands">uno command</a> with the given parameter to LOKit.</td>
	</tr>
</table>

<h3 id="cool-page">Page oriented</h3>

<p>Methods for page oriented documents.</p>

<table data-id='map'>
	<tr>
		<th>Method</th>
		<th>Returns</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>getCurrentPageNumber</b>()</code></td>
		<td><code>Number</code></td>
		<td>Number of the current page.</td>
	</tr>
	<tr>
		<td><code><b>getNumberOfPages</b>()</code></td>
		<td><code>Number</code></td>
		<td>Total number of pages.</td>
	</tr>
	<tr>
		<td><code><b>goToPage</b>(
			<nobr>&lt;Number&gt;<i>pageNumber</i>)</nobr>
        </code></td>
		<td><code>undefined</code></td>
		<td>Scrolls to the beginning of the given page.</td>
	</tr>
</table>

<h3 id="cool-part">Part oriented</h3>

<p>Methods for page oriented documents.</p>

<table data-id='map'>
	<tr>
		<th>Method</th>
		<th>Returns</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>getCurrentPartNumber</b>()</code></td>
		<td><code>Number</code></td>
		<td>Number of the current part.</td>
	</tr>
	<tr>
		<td><code><b>getNumberOfParts</b>()</code></td>
		<td><code>Number</code></td>
		<td>Total number of parts.</td>
	</tr>
	<tr>
		<td><code><b>setPart</b>(
			<nobr>&lt;Number&gt;<i>partNumber</i>)</nobr>
        </code></td>
		<td><code>undefined</code></td>
		<td>Select a specific part.</td>
	</tr>
</table>

<h3 id="cool-events">Events</h3>

<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>

<table data-id='map'>
	<tr>
		<th>Event</th>
		<th>Data</th>
		<th>Description</th>
	</tr>
	<tr>
		<td><code><b>cellformula</b></code></td>
		<td><code><a href="#cellformula-event">CellFormulaEvent</a></code></td>
		<td>Fired when the content of the selected cell changes.</td>
	</tr>
	<tr>
		<td><code><b>commandresult</b></code></td>
		<td><code><a href="#commandresult-event">CommandResultEvent</a></code></td>
		<td>Fired when a dispatched uno command or the 'saveas' command has finished.</td>
	</tr>
	<tr>
		<td><code><b>commandstatechanged</b></code></td>
		<td><code><a href="#commandstatechanged-event">CommandStateChangedEvent</a></code></td>
		<td>Fired when the state of a command such as .uno:Bold changes.</td>
	</tr>
	<tr>
		<td><code><b>locontextmenu</b></code></td>
		<td><code><a href="#locontextmenu-event">LOContextMenuEvent</a></code></td>
		<td>Fired when the user's action invoked a context menu (via a
		    right-click).  It contains the structure of the menu.</td>
	</tr>
	<tr>
		<td><code><b>docsize</b></code></td>
		<td><code><a href="#docsize-event">DocumentSizeEvent</a></code></td>
		<td>Fired when the document size changes.</td>
	</tr>
	<tr>
		<td><code><b>error</b></code></td>
		<td><code><a href="#error-event">ErrorEvent</a></code></td>
		<td>Fired on server or client error.</td>
	</tr>
	<tr>
		<td><code><b>hyperlinkclicked</b></code></td>
		<td><code><a href="#hyperlinkclicked-event">HyperlinkClickedEvent</a></code></td>
		<td>Fired when the user clicks a hyperlink in the document.</td>
	</tr>
	<tr>
		<td><code><b>pagenumberchanged</b></code></td>
		<td><code><a href="#pagenumberchanged-event">PageNumberChangedEvent</a></code></td>
		<td>Fired when the number of pages changes.</td>
	</tr>
	<tr>
		<td><code><b>print</b></code></td>
		<td><code><a href="#print-event">PrintEvent</a></code></td>
		<td>Fired when the URL for the PDF export is ready.</td>
	</tr>
	<tr>
		<td><code><b>renderfont</b></code></td>
		<td><code><a href="#renderfont-event">RenderFontEvent</a></code></td>
		<td>Fired when the font rendering is ready.</td>
	</tr>
	<tr>
		<td><code><b>search</b></code></td>
		<td><code><a href="#search-event">SearchEvent</a></code></td>
		<td>Fired when the search result is ready.</td>
	</tr>
	<tr>
		<td><code><b>scrollby</b></code></td>
		<td><code><a href="#scrollby-event">ScrollByEvent</a></code></td>
		<td>Fired when the document is panned with the keyboard.</td>
	</tr>
	<tr>
		<td><code><b>scrollto</b></code></td>
		<td><code><a href="#scrollto-event">ScrollToEvent</a></code></td>
		<td>Fired when the cursor goes out of the viewing area.</td>
	</tr>
	<tr>
		<td><code><b>statusindicator</b></code></td>
		<td><code><a href="#statusindicator-event">StatusIndicator</a></code></td>
		<td>Fired when leaflet is initialized, during document loading or on reconnection.</td>
	</tr>
	<tr>
		<td><code><b>tilepreview</b></code></td>
		<td><code><a href="#tilepreview-event">TilePreviewEvent</a></code></td>
		<td>Fired when the rendering of a requested preview is ready.</td>
	</tr>
	<tr>
		<td><code><b>updateparts</b></code></td>
		<td><code><a href="#updateparts-event">UpdatePartsEvent</a></code></td>
		<td>Fired when a new part has been selected.</td>
	</tr>
	<tr>
		<td><code><b>updatepermission</b></code></td>
		<td><code><a href="#permission-event">PermissionEvent</a></code></td>
		<td>Fired when the document permission changes.</td>
	</tr>
	<tr>
		<td><code><b>updatescrolloffset</b></code></td>
		<td><code><a href="#updatescrolloffset-event">UpdateScrollOffsetEvent</a></code></td>
		<td>Fired when the document is panned and the scrollbars should be moved along with the document.</td>
	</tr>
	<tr>
		<td><code><b>updatetoolbarcommandvalues</b></code></td>
		<td><code><a href="#updatetoolbarcommandvalues-event">UpdateToolbarCommandValuesEvent</a></code></td>
		<td>Fired when the document is loaded and contains the available command values for Font, FontSize, Style, etc.</td>
	</tr>
</table>

<h4 id="cellformula-event">CellFormulaEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>formula</b></code></td>
		<td><code>String</code></td>
		<td>The formula from the selected cell.</td>
	</tr>
</table>

<h4 id="commandresult-event">CommandResult</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>commandName</b></code></td>
		<td><code><a href="#commandstatechanged-values">CommandStateChangedValues</a></code></td>
		<td>UNO command or 'saveas'.</td>
	</tr>
	<tr>
		<td><code><b>success</b></code></td>
		<td><code>Boolean or undefined</code></td>
		<td>Returns the status code of the command execution, or
		    undefined if the result is not provided, and the command
		    only indicates that the operation has finished.</td>
	</tr>
</table>

<h4 id="commandstatechanged-event">CommandStateChangedEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>commandName</b></code></td>
		<td><code><a href="#commandstatechanged-values">CommandStateChangedValues</a></code></td>
		<td>UNO command.</td>
	</tr>
	<tr>
		<td><code><b>state</b></code></td>
		<td><code><a href="#commandstate-values">CommandStateValues</a></code></td>
		<td>UNO command state.</td>
	</tr>
</table>

<h4 id="locontextmenu-event">LOContextMenuEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>menu</b></code></td>
		<td><code>String</code></td>
		<td>List of the menu entries.  The structure looks like:<br/>
<code>
{ "text": "label text1", "type": "command", "command": ".uno:Something1", "enabled": "true" },
{ "text": "label text2", "type": "command", "command": ".uno:Something2", "enabled": "false" },
{ "type": "separator" },
{ "text": "label text2", "type": "menu", "menu": [ { ... }, { ... }, ... ] },
...
</code>
		</td>
	</tr>
</table>

<h4 id="docsize-event">DocumentSizeEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>x</b></code></td>
		<td><code>Number</code></td>
		<td>Document width in pixels.</td>
	</tr>
	<tr>
		<td><code><b>y</b></code></td>
		<td><code>Number</code></td>
		<td>Document height in pixels.</td>
	</tr>
</table>

<h4 id="error-event">ErrorEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>id</b></code></td>
		<td><code>Number</code></td>
		<td>Identificator of the error that can be used as indication
		of error message to present to the user.</td>
	</tr>
	<tr>
		<td><code><b>msg</b></code></td>
		<td><code>String</code></td>
		<td>If present, the error message.</td>
	</tr>
	<tr>
		<td><code><b>cmd</b></code></td>
		<td><code>String</code></td>
		<td>If present, the server command that caused the error.</td>
	</tr>
	<tr>
		<td><code><b>kind</b></code></td>
		<td><code>String</code></td>
		<td>If present, the kind of error associated with the command.</td>
	</tr>
</table>

The <code>id</code> property of ErrorEvent can have the following values:

<table data-id='events'>
	<tr>
		<th>value</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>1</b></code></td>
		<td>Internal error. Things still may work to some extent, but
		the session becomes unreliable.</td>
	</tr>
	<tr>
		<td><code><b>2</b></code></td>
		<td>Document couldn't be loaded.</td>
	</tr>
	<tr>
		<td><code><b>3</b></code></td>
		<td>Socket connection error.</td>
	</tr>
	<tr>
		<td><code><b>4</b></code></td>
		<td>Socket connection was closed.</td>
	</tr>
	<tr>
		<td><code><b>5</b></code></td>
		<td>Document couldn't be saved.</td>
	</tr>
</table>

<h4 id="hyperlinkclicked-event">HyperlinkClickedEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>url</b></code></td>
		<td><code>String</code></td>
		<td>Target URL of the hyperlink that the user clicked in the
		    document.</td>
	</tr>
</table>

<h4 id="pagenumberchanged-event">PageNumberChangedEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>currentPage</b></code></td>
		<td><code>Number</code></td>
		<td>The current page in the document.</td>
	</tr>
	<tr>
		<td><code><b>pages</b></code></td>
		<td><code>Number</code></td>
		<td>The number of pages.</td>
	</tr>
	<tr>
		<td><code><b>docType</b></code></td>
		<td><code><a href="#documenttype-values">DocumentTypeValues</a></code></td>
		<td>The document type.</td>
	</tr>
</table>

<h4 id="print-event">PrintEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>url</b></code></td>
        <td><code>String</code></td>
		<td>An URL for the PDF exported document.</td>
	</tr>
</table>

<h4 id="renderfont-event">RenderFontEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>font</b></code></td>
        <td><code>String</code></td>
		<td>Font name.</td>
	</tr>
	<tr>
		<td><code><b>img</b></code></td>
        <td><code>String</code></td>
		<td>The image data URL.</td>
	</tr>
</table>

<h4 id="search-event">SearchEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>originalPhrase</b></code></td>
		<td><code>String</code></td>
		<td>The phrase that has been searched for</td>
	</tr>
	<tr>
		<td><code><b>count</b></code></td>
		<td><code>Number</code></td>
		<td>Number of search results</td>
	</tr>
	<tr>
		<td><code><b>results</b></code></td>
		<td><code><a href="#search-result">SearchResult[]</a></code></td>
		<td>An array representing the selections of the search results in the document.</td>
	</tr>
</table>

<h4 id="scrollby-event">ScrollByEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>x</b></code></td>
		<td><code>Number</code></td>
		<td>Scroll right by x pixels, or left if negative.</td>
	</tr>
	<tr>
		<td><code><b>y</b></code></td>
		<td><code>Number</code></td>
		<td>Scroll down by y pixels, or up if negative.</td>
	</tr>
</table>

<h4 id="scrollto-event">ScrollToEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>x</b></code></td>
		<td><code>Number</code></td>
		<td>View's left border position in pixels.</td>
	</tr>
	<tr>
		<td><code><b>y</b></code></td>
		<td><code>Number</code></td>
		<td>View's top border position in pixels.</td>
	</tr>
</table>

<h4 id="statusindicator-event">StatusIndicatorEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>statusType</b></code></td>
		<td><code><a href="#statusindicator-values">StatusIndicatorValues</a></code></td>
		<td>Status type.</td>
	</tr>
	<tr>
		<td><code><b>value</b></code></td>
		<td><code>Number</code></td>
		<td>If present, a number for 0 to 100 representing the loading status.</td>
	</tr>
</table>

<h4 id="tilepreview-event">TilePreviewEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>tile</b></code></td>
		<td><code>Image</code></td>
		<td>The actual preview.</td>
	</tr>
	<tr>
		<td><code><b>id</b></code></td>
		<td><code>Object</code></td>
		<td>Preview id.</td>
	</tr>
	<tr>
		<td><code><b>width</b></code></td>
		<td><code>Number</code></td>
		<td>Image width.</td>
	</tr>
	<tr>
		<td><code><b>height</b></code></td>
		<td><code>Number</code></td>
		<td>Image height.</td>
	</tr>
	<tr>
		<td><code><b>docType</b></code></td>
		<td><code><a href="#documenttype-values">DocumentTypeValues</a></code></td>
		<td>The document type.</td>
	</tr>
	<tr>
		<td><code><b>part</b></code></td>
		<td><code>Number</code></td>
		<td>If the preview is for a whole part.</td>
	</tr>
</table>

<h4 id="updateparts-event">UpdatePartsEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>selectedPart</b></code></td>
		<td><code>Number</code></td>
		<td>The currently selected part.</td>
	</tr>
	<tr>
		<td><code><b>parts</b></code></td>
		<td><code>Number</code></td>
		<td>The number of parts in the document.</td>
	</tr>
	<tr>
		<td><code><b>docType</b></code></td>
		<td><code><a href="#documenttype-values">DocumentTypeValues</a></code></td>
		<td>The document type.</td>
	</tr>
	<tr>
		<td><code><b>partNames</b></code></td>
		<td><code>String[]</code></td>
		<td>If present, an array containing slides' / spreadsheets' names.</td>
	</tr>
</table>

<h4 id="permission-event">PermissionEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>perm</b></code></td>
		<td><code><a href="#documentpermission-values">DocumentPermission</a></code></td>
		<td>Document permission.</td>
	</tr>
</table>

<h4 id="updatescrolloffset-event">UpdateScrollOffsetEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>x</b></code></td>
		<td><code>Number</code></td>
		<td>Difference in pixels between the document's left border and view's left border.</td>
	</tr>
	<tr>
		<td><code><b>y</b></code></td>
		<td><code>Number</code></td>
		<td>Difference in pixels between the document's top border and view's top border.</td>
	</tr>
</table>

<h4 id="updatetoolbarcommandvalues-event">UpdateToolbarCommandValuesEvent</h4>

<table data-id='events'>
	<tr>
		<th class="width100">property</th>
		<th>type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>commandName</b></code></td>
		<td><code><a href="#toolbarcommand-values">ToolbarCommandValues</a></code></td>
		<td>UNO command.</td>
	</tr>
	<tr>
		<td><code><b>commandValues</b></code></td>
		<td><code>Object</code></td>
		<td>JSON mapping of the possible values.</td>
	</tr>
</table>

<h3 id="cool-object-values">Object values</h3>

<p>A list of possible values for different event object properties.</p>

<h4 id="search-result">SearchResult</h4>

<table data-id='values'>
	<tr>
		<th class="width100">property</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>part</b></code></td>
		<td><code>Number</code></td>
        <td>The part in which the selection lies.</td>
	</tr>
	<tr>
		<td><code><b>rectangles</b></code></td>
        <td><code><a href="#bounds">Bounds[]</a></code></td>
        <td>Selection bounds in pixels.</td>
	</tr>
</table>

<h4 id="documentpermission-values">DocumentPermissionValues</h4>

<table data-id='values'>
	<tr>
		<th class="width100">value</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>'edit'</b></code></td>
		<td><code>String</code></td>
		<td>The document can be edited, dragging is disabled and mouse selection is active.</td>
	</tr>
	<tr>
		<td><code><b>'view'</b></code></td>
		<td><code>String</code></td>
		<td>The document is in viewing mode, dragging is enabled by default and by clicking in it, editing mode is entered.</td>
	</tr>
    <tr>
		<td><code><b>'readonly'</b></code></td>
		<td><code>String</code></td>
		<td>The document is in read-only mode, dragging is enabled by default.</td>
	</tr>
</table>

<h4 id="commandstatechanged-values">CommandStateChangedValues</h4>

<table data-id='values'>
	<tr>
		<th class="width100">value</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>'.uno:Bold'</b></code></td>
		<td><code>String</code></td>
		<td>Bold.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:Italic'</b></code></td>
		<td><code>String</code></td>
		<td>Italic.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:Underline'</b></code></td>
		<td><code>String</code></td>
		<td>Underline.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:Strikeout'</b></code></td>
		<td><code>String</code></td>
		<td>Strikeout.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:LeftPara'</b></code></td>
		<td><code>String</code></td>
		<td>Align left.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:CenterPara'</b></code></td>
		<td><code>String</code></td>
		<td>Center horizontally.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:RightPara'</b></code></td>
		<td><code>String</code></td>
		<td>Align right.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:JustifyPara'</b></code></td>
		<td><code>String</code></td>
		<td>Justified.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:IncrementIndent'</b></code></td>
		<td><code>String</code></td>
		<td>Increment indent.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:DecrementIndent'</b></code></td>
		<td><code>String</code></td>
		<td>Decrement indent.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:StyleApply'</b></code></td>
		<td><code>String</code></td>
		<td>Style related uno command.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:CharFontName'</b></code></td>
		<td><code>String</code></td>
		<td>Font related uno command.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:FontHeight'</b></code></td>
		<td><code>String</code></td>
		<td>Font size related uno command.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:ModifiedStatus'</b></code></td>
		<td><code>String</code></td>
		<td>If the document is now marked as modified. The value is
			'true' when the document is marked as modified, and
			'false' the user e.g. undoes all the changes or
			saves the document.</td>
	</tr>
</table>

<h4 id="commandstate-values">CommandStateValues</h4>

<table data-id='values'>
	<tr>
		<th class="width100">value</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>'true'</b></code></td>
		<td><code>String</code></td>
		<td>For '.uno:Bold', '.uno:Italic', etc.</td>
	</tr>
	<tr>
		<td><code><b>'false'</b></code></td>
		<td><code>String</code></td>
		<td>For '.uno:Bold', '.uno:Italic', etc.</td>
	</tr>
	<tr>
		<td><code><b>styleName</b></code></td>
		<td><code>String</code></td>
		<td>For '.uno:StyleApply'.</td>
	</tr>
	<tr>
		<td><code><b>fontName</b></code></td>
		<td><code>String</code></td>
		<td>For '.uno:CharFontName'.</td>
	</tr>
	<tr>
		<td><code><b>fontSize</b></code></td>
		<td><code>String</code></td>
		<td>For '.uno:FontHeight'.</td>
	</tr>
</table>

<h4 id="documenttype-values">DocumentTypeValues</h4>

<table data-id='values'>
	<tr>
		<th class="width100">value</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>'text'</b></code></td>
		<td><code>String</code></td>
		<td>Text document, usually handled by Writer.</td>
	</tr>
	<tr>
		<td><code><b>'presentation'</b></code></td>
		<td><code>String</code></td>
		<td>Text document, usually handled by Impress.</td>
	</tr>
	<tr>
		<td><code><b>'spreadsheet'</b></code></td>
		<td><code>String</code></td>
		<td>Text document, usually handled by Calc.</td>
	</tr>
	<tr>
		<td><code><b>'drawing'</b></code></td>
		<td><code>String</code></td>
		<td>Text document, usually handled by Draw.</td>
	</tr>
	<tr>
		<td><code><b>'other'</b></code></td>
		<td><code>String</code></td>
		<td>Other document type.</td>
	</tr>
</table>

<h4 id="statusindicator-values">StatusIndicatorValues</h4>

<table data-id='values'>
	<tr>
		<th class="width100">value</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>'start'</b></code></td>
		<td><code>String</code></td>
		<td>Fired when the progress broadcast is being started.</td>
	</tr>
	<tr>
		<td><code><b>'setvalue'</b></code></td>
		<td><code>String</code></td>
		<td>Set a value between 0 and 100.</td>
	</tr>
	<tr>
		<td><code><b>'finish'</b></code></td>
		<td><code>String</code></td>
		<td>The progress is at 100%.</td>
	</tr>
	<tr>
		<td><code><b>'coolloaded'</b></code></td>
		<td><code>String</code></td>
		<td>Fired when the code has been initialized.</td>
	</tr>
	<tr>
		<td><code><b>'alltilesloaded'</b></code></td>
		<td><code>String</code></td>
		<td>Fired when all empty tiles have been loaded (fired several times).</td>
	</tr>
	<tr>
		<td><code><b>'initializationcomplete'</b></code></td>
		<td><code>String</code></td>
		<td>Fired when everything that is needed for operating on the
		    document is ready: this._docLayer is defined,
		    statusindicatorfinish was received, .uno:StyleApply was
		    received, .uno:CharFontName was received, and
		    updatepermission was received.</td>
	</tr>
</table>

<h4 id="toolbarcommand-values">ToolbarCommandValues</h4>

<table data-id='values'>
	<tr>
		<th class="width100">value</th>
		<th class="width100">type</th>
		<th>description</th>
	</tr>
	<tr>
		<td><code><b>'.uno:StyleApply'</b></code></td>
		<td><code>String</code></td>
		<td>Style related uno command.</td>
	</tr>
	<tr>
		<td><code><b>'.uno:CharFontName'</b></code></td>
		<td><code>String</code></td>
		<td>Font related uno command.</td>
	</tr>
</table>

<h3 id="cool-uno-commands">Uno command</h3>

<p>A list of common uno commands with their additional parameters.</p>
<pre><code class="javascript">map.sendUnoCommand('.uno:Bold')</code></pre>
<pre><code class="javascript">map.sendUnoCommand('.uno:Color',
{
  "Color": {
    "type": "long",
    "value": 16750848
  }
})</code></pre>

<table data-id='values' id='uno-commands-table'>
	<tr>
		<th class="width100">command</th>
		<th class="width100">parameter</th>
		<th>description</th>
	</tr>
</table>


</div>
<script>
	hljs.configure({tabReplace: '    '});
	hljs.initHighlighting();

	(function () {
		if (document.body.className.indexOf('api-page') !== -1) {
			var headers = document.getElementsByTagName('h2');

			for (var i = 0, len = headers.length; i < len; i++) {
				if (headers[i].id) {
					headers[i].onclick = function(e) {
						if (e.offsetX < 0) {
							window.location.hash = '#' + this.id;
						}
					};
				}
			}
		}
	})();
</script>

<script>
var unoCommands = [
{
    header: 'Global operations',
},

{
    uno: '.uno:Redo',
    parameter: null,
    description: 'Redo.'
},

{
    uno: '.uno:Save',
    parameter: null,
    description: 'Save the document.'
},

{
    uno: '.uno:Undo',
    parameter: null,
    description: 'Undo.'
},

{
    header: 'Text formatting',
},

{
    uno: '.uno:BackColor',
    parameter: {
        'BackColor': {
            type: 'long',
            value: 16750848
        }
    },
    description: 'Apply a highlighting color for a text document (the value can be obtained by converting the base 16 color to base 10).'
},

{
    uno: '.uno:CharBackgroundExt',
    parameter: null,
    description: '.uno:CharBackgroundExt is supplementary to .uno:BackColor. When .uno:BackColor is set, Writer turns into a "watercan" mode, where the user directly marks parts of the text with the wanted background color. ' +
                 '.uno:CharBackgroundExt then controls this watercan mode - dispatching it toggles the watercan mode on/off, and also the StateChanged events reflect the on/off mode accordingly.'
},

{
    uno: '.uno:BackgroundColor',
    parameter: {
        'BackgroundColor': {
            type: 'long',
            value: 16750848
        }
    },
    description: 'Apply a highlighting color for a spreadsheet document (the value can be obtained by converting the base 16 color to base 10).'
},

{
    uno: '.uno:Bold',
    parameter: null,
    description: 'Bold.'
},

{
    uno: '.uno:CharBackColor',
    parameter: {
        'CharBackColor': {
            type: 'long',
            value: 16750848
        }
    },
    description: 'Apply a font color for a presentation document (the value can be obtained by converting the base 16 color to base 10).'
},

{
    uno: '.uno:CharFontName',
    parameter: {
        'CharFontName.FamilyName': {
            type: 'string',
            value: 'Arial'
        }
    },
    description: 'Apply font.'
},

{
    uno: '.uno:Color',
    parameter: {
        'Color': {
            type: 'long',
            value: 16750848
        }
    },
    description: 'Apply a font color for a non-text document, like a spreadsheet, presentation, etc (the value can be obtained by converting the base 16 color to base 10).'
},

{
    uno: '.uno:FontColor',
    parameter: {
        'FontColor': {
            type: 'long',
            value: 16750848
        }
    },
    description: 'Apply a font color for a text document (the value can be obtained by converting the base 16 color to base 10).'
},

{
    uno: '.uno:FontHeight',
    parameter: {
        'FontHeight.Height': {
            type: 'float',
            value: '11.5'
        }
    },
    description: 'Apply font size.'
},

{
    uno: '.uno:Italic',
    parameter: null,
    description: 'Italic.'
},

{
    uno: '.uno:OutlineFont',
    parameter: null,
    description: 'Outline.'
},

{
    uno: '.uno:Shadowed',
    parameter: null,
    description: 'Shadowed.'
},

{
    uno: '.uno:SubScript',
    parameter: null,
    description: 'Subscript.'
},

{
    uno: '.uno:SuperScript',
    parameter: null,
    description: 'Superscript.'
},

{
    uno: '.uno:Strikeout',
    parameter: null,
    description: 'Strikeout / strike-through.'
},

{
    uno: '.uno:Underline',
    parameter: null,
    description: 'Underline.'
},

{
    header: 'Paragraph formatting',
},

{
    uno: '.uno:CenterPara',
    parameter: null,
    description: 'Center horizontally.'
},

{
    uno: '.uno:DecrementIndent',
    parameter: null,
    description: 'Decrement paragraph indentation.'
},

{
    uno: '.uno:DefaultBullet',
    parameter: null,
    description: 'Bullets ON/OFF.'
},

{
    uno: '.uno:DefaultNumbering',
    parameter: null,
    description: 'Numbering ON/OFF.'
},

{
    uno: '.uno:IncrementIndent',
    parameter: null,
    description: 'Increment paragraph indentation.'
},

{
    uno: '.uno:JustifyPara',
    parameter: null,
    description: 'Justified.'
},

{
    uno: '.uno:LeftPara',
    parameter: null,
    description: 'Align left.'
},

{
    uno: '.uno:RightPara',
    parameter: null,
    description: 'Align right.'
},

{
    uno: '.uno:SetHyperlink',
    parameter: {
        'Hyperlink.Text': {
            type: 'string',
            value: 'some text'
        },
        'Hyperlink.URL': {
            type: 'string',
            value: 'url'
        }
    },
    description: 'Creates a hyperlink. If Hyperlink.Text is not specified, the hyperlink will be set for the current ' +
                     'selection. Hyperlink.URL can be a web URL or a bookmark from the document.'
},

{
    header: 'Comments',
},

{
    uno: '.uno:DeleteComment',
    parameter: null,
    description: 'Delete comment.'
},

{
    uno: '.uno:InsertAnnotation',
    parameter: {
        'Author': {
            type: 'string',
            value: 'A U Thor'
        }
    },
    description: 'Insert comment.'
},

{
    header: 'Fields',
},

{
    uno: '.uno:InsertPageNumberField',
    parameter: null,
    description: 'Insert Page Number field.'
},

{
    uno: '.uno:InsertPageCountField',
    parameter: null,
    description: 'Insert Page Count field.'
},

{
    uno: '.uno:DateField',
    parameter: null,
    description: 'Insert Date field.'
},

{
    uno: '.uno:TimeField',
    parameter: null,
    description: 'Insert Time field.'
},

{
    uno: '.uno:TitleField',
    parameter: null,
    description: 'Insert Title field.'
},

{
    uno: '.uno:AuthorField',
    parameter: null,
    description: 'Insert Author field.'
},

{
    uno: '.uno:TopicField',
    parameter: null,
    description: 'Insert Topic field.'
},

{
    header: 'Styles',
},

{
    uno: '.uno:DeleteStyle',
    parameter: null,
    description: 'Delete the current style.'
},

{
    uno: '.uno:FormatPaintbrush',
    parameter: null,
    description: 'Copy format of the selected text to another text.'
},

{
    uno: '.uno:ResetAttributes',
    parameter: null,
    description: 'Clear direct formatting.'
},

{
    uno: '.uno:StyleApply',
    parameter: {
        'Style': {
            type: 'string',
            value: 'Title'
        },
        'FamilyName': {
            type: 'string',
            value: 'ParagraphStyles'
        }
    },
    description: 'Apply style from style family.'
},

{
    uno: '.uno:StyleUpdateByExample',
    parameter: null,
    description: 'Update the current style to match the selected text.'
},

{
    header: 'Tables (in a text document)',
},

{
    uno: '.uno:InsertColumnsAfter',
    parameter: null,
    description: 'Insert column after the current cursor position.',
},

{
    uno: '.uno:InsertColumnsBefore',
    parameter: null,
    description: 'Insert column before the current cursor position.',
},

{
    uno: '.uno:InsertRowsAfter',
    parameter: null,
    description: 'Insert row after the current cursor position.',
},

{
    uno: '.uno:InsertRowsBefore',
    parameter: null,
    description: 'Insert row before the current cursor position.',
},

{
    uno: '.uno:InsertTable',
    parameter: {
	'Columns': {
		'type': 'long',
		'value': 6
	},
	'Rows': {
		'type': "long",
		'value': 10
	}
    },
    description: 'Insert table with the given dimensions.'
},

{
    uno: '.uno:DeleteTable',
    parameter: null,
    description: 'Delete table at the current cursor position.'
},

{
    uno: '.uno:DeleteColumns',
    parameter: null,
    description: 'Delete the current column.'
},

{
    uno: '.uno:DeleteRows',
    parameter: null,
    description: 'Delete the current row.'
},

{
    header: 'Tables (in presentations)',
},

{
    uno: '.uno:InsertColumns',
    parameter: null,
    description: 'Insert column after the current cursor position.',
},

{
    uno: '.uno:InsertRows',
    parameter: null,
    description: 'Insert row after the current cursor position.',
},

{
    uno: '.uno:InsertTable',
    parameter: {
	'Columns': {
		'type': 'long',
		'value': 6
	},
	'Rows': {
		'type': "long",
		'value': 10
	}
    },
    description: 'Insert table with the given dimensions.'
},

{
    uno: '.uno:DeleteColumns',
    parameter: null,
    description: 'Delete the current column.'
},

{
    uno: '.uno:DeleteRows',
    parameter: null,
    description: 'Delete the current row.'
},

{
    header: 'Text document-related',
},

{
    uno: '.uno:UpdateAllIndexes',
    parameter: null,
    description: 'Update all Table of X (Content etc.)  Useful for general menus / toolbars.'
},

{
    uno: '.uno:UpdateCurIndex',
    parameter: null,
    description: 'Update the current Table of X (Content etc.)  "Current" means the one in where the cursor is located, useful for context menus.'
},

{
    header: 'Spreadsheet-related',
},

{
    uno: '.uno:DeleteColumns',
    parameter: null,
    description: 'Delete the current column.'
},

{
    uno: '.uno:DeleteRows',
    parameter: null,
    description: 'Delete the current row.'
},

{
    uno: '.uno:EnterString',
    parameter: {
        'StringName': {
            type: 'string',
            value: '=SUM()'
        }
    },
    description: 'Enters the string in the selected cell.'
},

{
    uno: '.uno:Insert',
    parameter: {
        'Name': {
            'type': 'string',
            'value': 'Sheet Name'
        },
        'Index': {
            'type': 'long',
            'value': 0
        }
    },
    description: 'Inserts a new sheet to the spreadsheet. The "Name" parameter can be left as empty string, in that case the sheet name will be generated. The "Index" parameter means the position where it should be inserted - "1" means adding as the 1st sheet, etc. 0 is special, and means adding as the last sheet.'
},

{
    uno: '.uno:InsertColumns',
    parameter: null,
    description: 'Insert column after the current cursor position.',
},

{
    uno: '.uno:InsertRows',
    parameter: null,
    description: 'Insert row before the current cursor position.',
},

{
    uno: '.uno:Name',
    parameter: {
        'Name': {
            'type': 'string',
            'value': 'Sheet Name'
        },
        'Index': {
            'type': 'long',
            'value': 1
        }
    },
    description: 'Rename the given sheet in the spreadsheet. The "Index" parameter means the position of the sheet - "1" means the 1st sheet, etc.'
},

{
    uno: '.uno:Remove',
    parameter: {
        'Index': {
            'type': 'long',
            'value': 5
        }
    },
    description: 'Remove the given sheet from the spreadsheet. The "Index" parameter means the position - "1" means the 1st sheet, etc.'
},

{
    uno: '.uno:SortAscending',
    parameter: null,
    description: 'Sort the current selection ascending.'
},

{
    uno: '.uno:SortDescending',
    parameter: null,
    description: 'Sort the current selection descending.'
},

{
    header: 'Presentation-related',
},

{
    uno: '.uno:AssignLayout',
    parameter: {
        'WhatLayout': {
            'type': 'long',
            'value': 19
        }
    },
    description: 'Changes the layout of the current slide.  Possible values of "WhatLayout" are: <ul>' +
	'<li>20 - Blank</li>' +
	'<li>19 - Title</li>' +
	'<li>0 - Title, Text</li>' +
	'<li>1 - Title, Content</li>' +
	'<li>32 - Centered Text</li>' +
	'<li>3 - Title, 2 Content</li>' +
	'<li>12 - Title, Content and 2 Content on Right</li>' +
	'<li>15 - Title, 2 Content on Left and Content</li>' +
	'<li>14 - Title, Content above Content</li>' +
	'<li>16 - Title, 2 Content above Content</li>' +
	'<li>18 - Title, 4 Content</li>' +
	'<li>34 - Title, 6 Content</li>' +
	'<li>28 - Title, Content (Vertical)</li>' +
	'<li>27 - Title, Content over Content (Vertical)</li>' +
	'<li>29 - Title, Vertical Content</li>' +
	'<li>30 - Title, 2 Vertical Content</li></ul>'
},

{
    header: 'Appearance options',
},

{
    uno: '.uno:HideWhitespace',
    parameter: {
        'type': 'boolean',
        'value': 'false'
    },
    description: 'Continuous web view of the document.'
},

{
    uno: '.uno:ShowBorderShadow',
    parameter: {
        'type': 'boolean',
        'value': 'true'
    },
    description: 'Paint a shadow around Write page / Impress slide border.'
},

{
    header: 'Calling Python scripts',
},

{
    uno: 'vnd.sun.star.script:&lt;filename&gt;$&lt;function&gt;?language=Python&location=share',
    parameter: {
                                                               'sheet': {'type': 'string', 'value': 'Sheet1'},
								'x0': {'type': 'long', 'value': 1},
								'y0': {'type': 'long', 'value': 2},
								'width': {'type': 'long', 'value': 3},
								'height': {'type': 'long', 'value': 4},
								'name': {'type': 'string', 'value': 'Alice'}
    },
    description: 'Calls a Python script. The parameter example here are those taken by the DefineNamedRange function in the NamedRanges.py file.'
},

];
$(document).ready(function() {
    var table = $('#uno-commands-table');
    unoCommands.forEach(function (unoCommand) {
	if ('header' in unoCommand) {

            table.append(
                '<tr>' +
                '	<td colspan="3"><b>' + unoCommand.header + '</b></td>' +
                '</tr>');
	}
	else {
            table.append(
                '<tr>' +
                '	<td><code><b>' + unoCommand.uno + '</b></code></td>' +
                '	<td><code><pre>' + JSON.stringify(unoCommand.parameter, null, 2) + '</pre></code></td>' +
                '	<td>' + unoCommand.description + '</td>' +
                '</tr>');
	}
    });
});
</script>

<script type="text/javascript" src="docs/js/docs.js"></script>
</body>
</html>