Merge pull request #600 from finos/vocab_refactor

Clean up API names

examples/git_history/chained.html

@@ -40,8 +40,8 @@
     <script>
         window.addEventListener('WebComponentsReady', async function() {
             var elem = document.getElementById('view1');
-            var worker = perspective.worker(window.location.origin.replace('http', 'ws'));
-            let view = worker.open_view('data_source_one');
+            var client = perspective.websocket();
+            let view = client.open_view('data_source_one');
             let arrow = await view.to_arrow();
             elem.load(perspective.worker().table(arrow));
         });

examples/git_history/index.html

@@ -40,8 +40,8 @@
     <script>
         window.addEventListener('WebComponentsReady', function() {
             var elem = document.getElementById('view1');
-            var worker = perspective.worker(window.location.origin.replace('http', 'ws'));
-            elem.load(worker.open('data_source_one'));
+            var client = perspective.websocket();
+            elem.load(client.open_table('data_source_one'));
         });
     </script>
 

examples/git_history/server.js

@@ -7,7 +7,7 @@
  *
  */
 
-const {WebSocketHost, table} = require("@finos/perspective");
+const {WebSocketServer, table} = require("@finos/perspective");
 const exec = require("child_process").exec;
 
 function execute(command, callback) {
@@ -17,7 +17,7 @@ function execute(command, callback) {
 }
 
 execute(`git log --date=iso --pretty=format:'"%h","%an","%aD","%s","%ae"'`, log => {
-    const host = new WebSocketHost({assets: [__dirname]});
+    const server = new WebSocketServer({assets: [__dirname]});
     const tbl = table("Hash,Name,Date,Message,Email\n" + log);
-    host.host_view("data_source_one", tbl.view());
+    server.host_table("data_source_one", tbl);
 });

examples/remote/index.html

@@ -38,20 +38,17 @@
 
     <script>
 
-
-
         window.addEventListener('WebComponentsReady', async function() {
             var elem = document.getElementById('view1');
-            var client = perspective.worker(window.location.origin.replace('http', 'ws'));
+            var client = perspective.websocket();
             var view = client.open_view('data_source_one');
             var arrow = await view.to_arrow();
+            var tbl = elem.worker.table(arrow, {limit: 10000});
+            view.on_update(x => tbl.update(x), {mode: "row"});
             elem.worker.initialize_profile_thread();
-            elem.load(arrow, {limit: 10000});
-            view.on_update(x => {
-                elem.update(x);
-            }, {mode: "row"});
-
+            elem.load(tbl);
         });
+
     </script>
 
 </body>

examples/remote/server.js

@@ -7,7 +7,7 @@
  *
  */
 
-const {WebSocketHost, table, initialize_profile_thread} = require("@finos/perspective");
+const {WebSocketServer, table, initialize_profile_thread} = require("@finos/perspective");
 
 /******************************************************************************
  *
@@ -55,7 +55,7 @@ async function newArrow() {
     return arrow;
 }
 
-const host = new WebSocketHost({assets: [__dirname]});
+const host = new WebSocketServer({assets: [__dirname]});
 
 async function init() {
     if (CACHE_INPUT) {

examples/simple/server.js

@@ -7,5 +7,5 @@
  *
  */
 
-const {WebSocketHost} = require("@finos/perspective");
-new WebSocketHost({assets: [__dirname]});
+const {WebSocketServer} = require("@finos/perspective");
+new WebSocketServer({assets: [__dirname]});

packages/perspective-bench/src/js/bench.js

@@ -60,7 +60,7 @@ async function run_node_version(args, run_test) {
 function new_host() {
     return new Promise(
         resolve =>
-            new perspective.WebSocketHost({
+            new perspective.WebSocketServer({
                 assets: ["build"],
                 port: 0,
                 on_start: function() {

packages/perspective-cli/src/js/index.js

@@ -7,7 +7,7 @@
  *
  */
 
-const {WebSocketHost, table} = require("@finos/perspective/build/perspective.node.js");
+const {WebSocketServer, table} = require("@finos/perspective/build/perspective.node.js");
 const {read_stdin, open_browser} = require("./utils.js");
 const fs = require("fs");
 const path = require("path");
@@ -70,7 +70,7 @@ async function host(filename, options) {
     if (options.assets) {
         files = [options.assets, ...files];
     }
-    const server = new WebSocketHost({assets: files, port: options.port});
+    const server = new WebSocketServer({assets: files, port: options.port});
     let file;
     if (filename) {
         file = fs.readFileSync(filename).toString();

packages/perspective-viewer/test/js/utils.js

@@ -17,7 +17,7 @@ const cons = require("console");
 const private_console = new cons.Console(process.stdout, process.stderr);
 const cp = require("child_process");
 
-const {WebSocketHost} = require("@finos/perspective");
+const {WebSocketServer} = require("@finos/perspective");
 
 const IS_LOCAL_PUPPETEER = fs.existsSync(path.join(__dirname, "..", "..", "..", "..", "node_modules", "puppeteer"));
 const LOCAL_RESULTS_FILENAME = `results.${process.platform}.json`;
@@ -31,7 +31,7 @@ exports.with_server = function with_server({paths}, body) {
         if (test_root === "") {
             throw "ERROR";
         }
-        server = new WebSocketHost({
+        server = new WebSocketServer({
             assets: paths || [path.join(test_root, "build")],
             port: 0,
             on_start: () => {

packages/perspective/README.md

@@ -13,7 +13,7 @@ The main API module for Perspective.
         * [.to_columns([options])](#module_perspective..view+to_columns) ⇒ <code>Promise.&lt;Array&gt;</code>
         * [.to_json([options])](#module_perspective..view+to_json) ⇒ <code>Promise.&lt;Array&gt;</code>
         * [.to_csv([options])](#module_perspective..view+to_csv) ⇒ <code>Promise.&lt;string&gt;</code>
-        * [.col_to_js_typed_array(column_name)](#module_perspective..view+col_to_js_typed_array) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
+        * [.col_to_js_typed_array(column_name, options)](#module_perspective..view+col_to_js_typed_array) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
         * [.to_arrow([options])](#module_perspective..view+to_arrow) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
         * [.num_rows()](#module_perspective..view+num_rows) ⇒ <code>Promise.&lt;number&gt;</code>
         * [.num_columns()](#module_perspective..view+num_columns) ⇒ <code>Promise.&lt;number&gt;</code>
@@ -39,10 +39,6 @@ The main API module for Perspective.
         * [.add_computed(computed)](#module_perspective..table+add_computed)
         * [.columns(computed)](#module_perspective..table+columns) ⇒ <code>Array.&lt;string&gt;</code>
         * [.column_metadata()](#module_perspective..table+column_metadata) ⇒ <code>Array.&lt;object&gt;</code>
-    * [~WorkerHost](#module_perspective..WorkerHost)
-        * [new WorkerHost(perspective)](#new_module_perspective..WorkerHost_new)
-        * [.post(msg, transfer)](#module_perspective..WorkerHost+post)
-        * [.init(buffer)](#module_perspective..WorkerHost+init)
 
 
 * * *
@@ -60,7 +56,7 @@ The main API module for Perspective.
     * [.to_columns([options])](#module_perspective..view+to_columns) ⇒ <code>Promise.&lt;Array&gt;</code>
     * [.to_json([options])](#module_perspective..view+to_json) ⇒ <code>Promise.&lt;Array&gt;</code>
     * [.to_csv([options])](#module_perspective..view+to_csv) ⇒ <code>Promise.&lt;string&gt;</code>
-    * [.col_to_js_typed_array(column_name)](#module_perspective..view+col_to_js_typed_array) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
+    * [.col_to_js_typed_array(column_name, options)](#module_perspective..view+col_to_js_typed_array) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
     * [.to_arrow([options])](#module_perspective..view+to_arrow) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
     * [.num_rows()](#module_perspective..view+num_rows) ⇒ <code>Promise.&lt;number&gt;</code>
     * [.num_columns()](#module_perspective..view+num_columns) ⇒ <code>Promise.&lt;number&gt;</code>
@@ -219,7 +215,7 @@ config object.
 
 <a name="module_perspective..view+col_to_js_typed_array"></a>
 
-#### view.col\_to\_js\_typed\_array(column_name) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
+#### view.col\_to\_js\_typed\_array(column_name, options) ⇒ <code>Promise.&lt;TypedArray&gt;</code>
 Serializes a view column into a TypedArray.
 
 **Kind**: instance method of [<code>view</code>](#module_perspective..view)  
@@ -233,6 +229,12 @@ integer/float type, the Promise returns undefined.
 **Params**
 
 - column_name <code>string</code> - The name of the column to serialize.
+- options <code>Object</code> - An optional configuration object.
+    - .data_slice <code>\*</code> - A data slice object from which to serialize.
+    - .start_row <code>number</code> - The starting row index from which
+to serialize.
+    - .end_row <code>number</code> - The ending row index from which
+to serialize.
 
 
 * * *
@@ -248,6 +250,7 @@ data from the view.
 **Params**
 
 - [options] <code>Object</code> - An optional configuration object.
+    - .data_slice <code>\*</code> - A data slice object from which to serialize.
     - .start_row <code>number</code> - The starting row index from which
 to serialize.
     - .end_row <code>number</code> - The ending row index from which
@@ -616,55 +619,3 @@ If the column is computed, the `computed` property is an Object containing:
 
 * * *
 
-<a name="module_perspective..WorkerHost"></a>
-
-### perspective~WorkerHost
-**Kind**: inner class of [<code>perspective</code>](#module_perspective)  
-
-* [~WorkerHost](#module_perspective..WorkerHost)
-    * [new WorkerHost(perspective)](#new_module_perspective..WorkerHost_new)
-    * [.post(msg, transfer)](#module_perspective..WorkerHost+post)
-    * [.init(buffer)](#module_perspective..WorkerHost+init)
-
-
-* * *
-
-<a name="new_module_perspective..WorkerHost_new"></a>
-
-#### new WorkerHost(perspective)
-On initialization, listen for messages posted from the client and send it to `Host.process()`.
-
-**Params**
-
-- perspective - a reference to the Perspective module, allowing the `Host` to access Perspective methods.
-
-
-* * *
-
-<a name="module_perspective..WorkerHost+post"></a>
-
-#### workerHost.post(msg, transfer)
-Implements the `Host`'s `post()` method using the Web Worker `postMessage()` API.
-
-**Kind**: instance method of [<code>WorkerHost</code>](#module_perspective..WorkerHost)  
-**Params**
-
-- msg <code>Object</code> - a message to pass to the client
-- transfer <code>\*</code> - a transferable object to pass to the client, if needed
-
-
-* * *
-
-<a name="module_perspective..WorkerHost+init"></a>
-
-#### workerHost.init(buffer)
-When initialized, replace Perspective's internal `__MODULE` variable with the WASM binary.
-
-**Kind**: instance method of [<code>WorkerHost</code>](#module_perspective..WorkerHost)  
-**Params**
-
-- buffer <code>ArrayBuffer</code> - an ArrayBuffer containing the Perspective WASM code
-
-
-* * *
-