{"id":13565816,"url":"https://github.com/Linkurious/lke-plugin-data-table","last_synced_at":"2025-04-03T23:30:36.897Z","repository":{"id":42368666,"uuid":"241575342","full_name":"Linkurious/lke-plugin-data-table","owner":"Linkurious","description":"Data-table plugins for Linkurious Enterprise","archived":false,"fork":false,"pushed_at":"2025-03-22T07:50:13.000Z","size":341,"stargazers_count":1,"open_issues_count":10,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-22T08:27:34.537Z","etag":null,"topics":["framework-lke","lang-javascript","linkurious-enterprise","plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Linkurious.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-19T08:56:50.000Z","updated_at":"2024-06-20T15:22:57.000Z","dependencies_parsed_at":"2024-01-19T06:56:38.249Z","dependency_job_id":"4e940374-9633-497f-993b-01a50d8be3ae","html_url":"https://github.com/Linkurious/lke-plugin-data-table","commit_stats":null,"previous_names":[],"tags_count":14,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Linkurious%2Flke-plugin-data-table","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Linkurious%2Flke-plugin-data-table/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Linkurious%2Flke-plugin-data-table/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Linkurious%2Flke-plugin-data-table/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Linkurious","download_url":"https://codeload.github.com/Linkurious/lke-plugin-data-table/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247097590,"owners_count":20883121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework-lke","lang-javascript","linkurious-enterprise","plugin"],"created_at":"2024-08-01T13:01:55.996Z","updated_at":"2025-04-03T23:30:36.027Z","avatar_url":"https://github.com/Linkurious.png","language":"JavaScript","readme":"# Data-table plugin for Linkurious Enterprise\n\nThis Linkurious Enterprise plugin allow displaying the result of a\nquery (or query template) as a table.\n\n![data-table plugin screenshot](./data-table-screenshot.png)\n\n## Configuration\n\nYou can configure a plugin via the [Linkurious Configuration](https://doc.linkurio.us/admin-manual/latest/configure/).\n\nConfiguration keys supported by all the plugins:\n| Key | Type | Description | Example |\n| :-- | :-- | :-- | :-- |\n| `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\"` |\n| `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` |\n\nConfiguration keys supported only by the data-table plugin:\n\n| Key | Type | Description | Example |\n| :-- | :-- | :-- | :-- |\n| `entityType`  | \"edge\" \\| \"node\" (**required**)  | Whether to display nodes or edges in the table. | `\"node\"` |\n| `itemType`    | string (**required**)            | Name of the node category or edge type to display in the table. | `\"Company\"` |\n| `delimiter`    | string (**optional**)           | The delimiter used for csv files downloads. Only one character is allowed. By default \",\" is used | `\";\"` |\n| `properties`  | string\\[] (**optional**)         | Property names to include in the table. Defaults to all the properties of `itemType`. | `[\"name\", \"address\", \"vat_number\"]` |\n\nConfiguration example for 1 data-table instance accesible via `/plugins/table`:\n\u003cimg width=\"1036\" alt=\"Screenshot 2021-03-09 at 18 59 07\" src=\"https://user-images.githubusercontent.com/11739632/110516230-9508c200-8109-11eb-9fae-1218010597f6.png\"\u003e\n\nConfiguration example for 2 data-table instances accesible via `/plugins/table` and `/plugins/edgeTable`:\n\u003cimg width=\"1031\" alt=\"Screenshot 2021-03-10 at 15 16 40\" src=\"https://user-images.githubusercontent.com/11739632/110642781-a4444a00-81b3-11eb-9864-919916648db9.png\"\u003e\n\n*You can run multiple data-table instances by passing an array with unique `basePath` per config.*\n\n## URL parameters\n\nThis plugin supports the following URL parameters in the query string:\n\n| Param | Type | Description | Example |\n| :-- | :-- | :-- | :-- |\n| `queryId`                     | integer, short UUID or UUID (**required**, forbidden if `queryName` is used)  | ID of the query to run. | `queryId=61b338b0` |\n| `queryName`                   | string (**required**, forbidden if `queryId` is used)  | Name of the query to run. | `queryName=getTransactions` |\n| `sourceKey`                   | string (**required**)   | Key of the data-source to run the query on. | `sourceKey=b16e9ed5` |\n| `limit`                       | integer (**optional**)  | Maximum number of results to display. | `limit=500` |\n| `param_number_{{Encoded field name}}` | number (**optional**)   | *For query templates*, any numerical parameter of the template. | `param_number_age=30` |\n| `param_string_{{Encoded field name}}` | string (**optional**)   | *For query templates*, any string parameter of the template. | `param_string_city=Paris` |\n| `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` |\n| `showLongValues`                       | boolean (**optional**)  | Avoids truncation of long texts. | `showLongValues=false` |\n\n### Usage with standard queries\n\nIn order to display the result of a standard query in a table:\n\n1. Create a standard READ query. For example: `MATCH (n) return n LIMIT 1000`.\n2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=61b338b0`.\n3. Compose a valid data-table plugin URL and open it in a new tab. For example:\n```\n{{baseUrl}}plugins/table?queryId=61b338b0\u0026sourceKey={{sourceKey}}\n```\nYou can save this URL as a [Custom Action](https://doc.linkurio.us/user-manual/latest/custom-actions/), and when triggered, the `{{baseUrl}}` and `{{sourceKey}}` will be replaced with your LKE base URL and your current data-source key, respectively, and the final URL will be opened in a new tab. You can always do it manually, if you want.\n\n### Usage with query templates\n\nIn order to display the result of a query template in a table:\n\n1. Create a READ query template. For example: `MATCH (n) where n.city={{\"City Name\":string}} return n LIMIT 1000`.\n2. Note down the newly-created query ID, it will by the value of `queryId`. For example: `queryId=bf450812`.\n2. 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`.\n3. Compose a valid data-table plugin URL and open it in a new tab. For example:\n```\n{{baseUrl}}plugins/table?queryId=bf450812\u0026sourceKey={{sourceKey}}\u0026param_string_City%20Name=Paris\n```\nYou can save this URL as a [Custom Action](https://doc.linkurio.us/user-manual/latest/custom-actions/), and when triggered, the `{{baseUrl}}` and `{{sourceKey}}` will be replaced with your LKE base URL and your current data-source key, respectively, and the final URL will be opened in a new tab. You can always do it manually if you want.\n\n*Note that when prepending `param_string_` to the template field name `City Name`, we had to [encode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) it into `City%20Name` in order to be URL compliant.*\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLinkurious%2Flke-plugin-data-table","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLinkurious%2Flke-plugin-data-table","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLinkurious%2Flke-plugin-data-table/lists"}