You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -9,50 +9,51 @@ query (or query template) as a table.
9
9
10
10
You can configure a plugin via the [Linkurious Configuration](https://doc.linkurio.us/admin-manual/latest/configure/).
11
11
12
-
Configuration keys supported by all the plugins:
13
-
| Key | Type | Description | Example |
14
-
| :-- | :-- | :-- | :-- |
15
-
|`basePath`| string (**optional**) | A base path on which the plugin will be mounted. Defaults to [the manifest name](https://github.com/Linkurious/lke-plugin-data-table/blob/master/manifest.json#L2). |`"table"`|
16
-
|`debugPort`| number (**optional**) | A debug port on which to attach a debugger for the plugin NodeJS process. If not specfified, the plugin won't be started in debug mode. |`9230`|
12
+
Configuration keys that are supported by all the plugins:
17
13
18
-
Configuration keys supported only by the data-table plugin:
|`basePath`|`string` (**optional**) | A base path on which the plugin will be mounted. Defaults to [the manifest name](https://github.com/Linkurious/lke-plugin-data-table/blob/master/manifest.json#L2). |`"table"`|
17
+
|`debugPort`|`number` (**optional**) | A debug port on which to attach a debugger for the plugin Node.js process. If not specified, the plugin won't be started in debug mode. |`9230`|
19
18
20
-
| Key | Type | Description | Example |
21
-
| :-- | :-- | :-- | :-- |
22
-
|`entityType`| "edge" \| "node" (**required**) | Whether to display nodes or edges in the table. |`"node"`|
23
-
|`itemType`| string (**required**) | Name of the node category or edge type to display in the table. |`"Company"`|
24
-
|`delimiter`| string (**optional**) | The delimiter used for csv files downloads. Only one character is allowed. By default "," is used |`";"`|
25
-
|`properties`| string\[] (**optional**) | Property names to include in the table. Defaults to all the properties of `itemType`. |`["name", "address", "vat_number"]`|
19
+
Configuration keys that are supported by the data-table plugin:
26
20
27
-
Configuration example for 1 data-table instance accesible via `/plugins/table`:
|`entityType`|`"edge" \| "node"` (**required**) | Whether to display nodes or edges in the table. |`"node"`|
24
+
|`itemType`|`string` (**required**) | Name of the node category or edge type to display in the table. |`"Company"`|
25
+
|`delimiter`|`string` (**optional**) | The delimiter used for csv files downloads. Only one character is allowed. By default "," is used |`";"`|
26
+
|`properties`|`string[]` (**optional**) | Property names to include in the table. Defaults to all the properties of `itemType`. |`["name", "address", "vat_number"]`|
27
+
28
+
Configuration example for one data-table instance accessible via `/plugins/table`:
28
29
<imgwidth="1036"alt="Screenshot 2021-03-09 at 18 59 07"src="https://user-images.githubusercontent.com/11739632/110516230-9508c200-8109-11eb-9fae-1218010597f6.png">
29
30
30
-
Configuration example for 2 data-table instances accesible via `/plugins/table` and `/plugins/edgeTable`:
31
+
Configuration example for two data-table instances accessible via `/plugins/table` and `/plugins/edgeTable`:
31
32
<imgwidth="1031"alt="Screenshot 2021-03-10 at 15 16 40"src="https://user-images.githubusercontent.com/11739632/110642781-a4444a00-81b3-11eb-9864-919916648db9.png">
32
33
33
-
*You can run multiple data-table instances by passing an array with unique `basePath` per config.*
34
+
> ℹ️ You can set up multiple data-table instances by passing an array with unique `basePath` per config.*
34
35
35
36
## URL parameters
36
37
37
38
This plugin supports the following URL parameters in the query string:
38
39
39
-
| Param | Type | Description | Example |
40
-
|:--|:--|:--|:--|
41
-
|`queryId`|integer, short UUID or UUID (**required**, forbidden if `queryName` is used) | ID of the query to run. |`queryId=61b338b0`|
42
-
|`queryName`|string (**required**, forbidden if `queryId` is used) | Name of the query to run. |`queryName=getTransactions`|
43
-
|`sourceKey`|string (**required**) | Key of the data-source to run the query on. |`sourceKey=b16e9ed5`|
44
-
|`limit`|integer (**optional**) | Maximum number of results to display. |`limit=500`|
45
-
|`param_number_{{Encoded field name}}`| number (**optional**) |*For query templates*, any numerical parameter of the template. |`param_number_age=30`|
46
-
|`param_string_{{Encoded field name}}`| string (**optional**) |*For query templates*, any string parameter of the template. |`param_string_city=Paris`|
47
-
|`param_ids_{{Encoded field name}}`| comma-separated list (**optional**) |*For query templates*, any edgeset/nodeset parameter of the template. |`param_ids_target_ids=1,50,12`|
48
-
|`showLongValues`|boolean (**optional**) | Avoids truncation of long texts. |`showLongValues=false`|
|`queryId`|`integer`, short UUID or UUID (**required**, forbidden if `queryName` is used) | ID of the query to run. |`queryId=61b338b0`|
43
+
|`queryName`|`string` (**required**, forbidden if `queryId` is used) | Name of the query to run. |`queryName=getTransactions`|
44
+
|`sourceKey`|`string` (**required**) | Key of the data-source to run the query on. |`sourceKey=b16e9ed5`|
45
+
|`limit`|`integer` (**optional**) | Maximum number of results to display. |`limit=500`|
46
+
|`param_number_{{Encoded field name}}`|`number` (**optional**) |*For query templates*, any numerical parameter of the template. |`param_number_age=30`|
47
+
|`param_string_{{Encoded field name}}`|`string` (**optional**) |*For query templates*, any string parameter of the template. |`param_string_city=Paris`|
48
+
|`param_ids_{{Encoded field name}}`| comma-separated list (**optional**) |*For query templates*, any edgeset/nodeset parameter of the template. |`param_ids_target_ids=1,50,12`|
49
+
|`showLongValues`|`boolean` (**optional**) | Avoids truncation of long texts. |`showLongValues=false`|
49
50
50
51
### Usage with standard queries
51
52
52
-
In order to display the result of a standard query in a table:
53
+
To display the result of a standard query in a table:
53
54
54
55
1. Create a standard READ query. For example: `MATCH (n) return n LIMIT 1000`.
55
-
2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=61b338b0`.
56
+
2. Note down the newlycreated query ID, it will by the value of `queryId`. For example: `queryId=61b338b0`.
56
57
3. Compose a valid data-table plugin URL and open it in a new tab. For example:
@@ -61,12 +62,12 @@ You can save this URL as a [Custom Action](https://doc.linkurio.us/user-manual/l
61
62
62
63
### Usage with query templates
63
64
64
-
In order to display the result of a query template in a table:
65
+
To display the result of a query template in a table:
65
66
66
67
1. Create a READ query template. For example: `MATCH (n) where n.city={{"City Name":string}} return n LIMIT 1000`.
67
-
2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=bf450812`.
68
-
2. Note down each field title, [URL encode it](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent), prepend it with a valid URL parameter and give it a value. For example: `param_string_City%20Name=Paris`.
69
-
3. Compose a valid data-table plugin URL and open it in a new tab. For example:
68
+
2. Note down the newlycreated query ID, it will by the value of `queryId`. For example: `queryId=bf450812`.
69
+
3. Note down each field title, [URL encode it](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent), prepend it with a valid URL parameter and give it a value. For example: `param_string_City%20Name=Paris`.
70
+
4. Compose a valid data-table plugin URL and open it in a new tab. For example:
0 commit comments