visualifyjs 2.5.3-2.dev → 2.5.3-9-dev

package/docs/{docs/_sidebar.md → _sidebar.md}

@@ -1,44 +1,42 @@
--   Getting started
-
-    -   [Introduction](/README.md)
-    -   [Quick start](/quickstart.md)
-    -   [More pages](/more-pages.md)
-
--   Visualify.Recharts
-    
-    -   [Usage](/rechart-basic-usage.md)
-    -   [Attributes](/rechart-attributes.md)
-    -   [Line Chart](/Rechart/line.md)
-    -   [Bar Chart](/Rechart/bar.md)
-    -   [Pie Chart](/Rechart/pie.md)
-    -   [Radar Chart](/Rechart/radar.md)
-    -   [Funnel Chart](/Rechart/funnel.md)
-    -   [Scatter Chart](/Rechart/scatter.md)
-    
-  
--   Page Mode
-
-    -   [ScatterL](/components/scatterL.md)
-    -   [Visium](/components/visium.md)
-    -   [DotBio](/components/dotBio.md)
-    -   [Echart](/components/echart.md)
-    -   [Plotly](/components/plotly.md)
-    -   [Macaron](/components/macaron.md)
-    -   [More...](/components/more.md)
-
--   Customization
-
-    -   [Configuration](/configuration.md)
-    -   [Theme](/theme.md)
-
--   Guide
-
-    -   [CLI](/CLI.md)
-    -   [Deploy](/deploy.md)
-
--   Showcase
-
-    -   [MmTrBC](https://visualify.pharmacy.arizona.edu/MmTrBC/)
-    -   [EsoDev](https://visualify.pharmacy.arizona.edu/EsoDev/)
-
--   [UpdateLog](/log.md)
+-   Getting started
+
+    -   [Introduction](/README.md)
+    -   [Quick start](/quickstart.md)
+    -   [More pages](/more-pages.md)
+
+-   Visualify.Recharts
+    
+    -   [Usage](/rechart-basic-usage.md)
+    -   [Attributes](/rechart-attributes.md)
+    -   [Line Chart](/Rechart/line.md)
+    -   [Bar Chart](/Rechart/bar.md)
+    -   [Pie Chart](/Rechart/pie.md)
+    -   [Radar Chart](/Rechart/radar.md)
+    -   [Funnel Chart](/Rechart/funnel.md)
+    
+  
+-   Page Mode
+
+    -   [ScatterL](/components/scatterL.md)
+    -   [Visium](/components/visium.md)
+    -   [DotBio](/components/dotBio.md)
+    -   [Echart](/components/echart.md)
+    -   [Plotly](/components/plotly.md)
+    -   [Macaron](/components/macaron.md)
+    -   [More...](/components/more.md)
+
+-   Customization
+
+    -   [Configuration](/configuration.md)
+    -   [Theme](/theme.md)
+
+-   Guide
+
+    -   [CLI](/CLI.md)
+    -   [Deploy](/deploy.md)
+
+-   Showcase
+
+    -   [MmTrBC](https://visualify.pharmacy.arizona.edu/MmTrBC/)
+
+-   [UpdateLog](/log.md)

package/docs/{docs/components → components}/dotBio.md

@@ -1,34 +1,34 @@
-# DotBio Component
-
-The DotBio component is a dot plot that
-displays the expression of genes in different cell types. 
-
-
-## Properties
-
-The DotBio component has the following properties:
-
--   `type` (string): The type of the component, in this case `DotBio`.
--   `id` (string): The unique identifier of the component.
--   `row` (int): The row in which the component is to be displayed.
--   `col` (int): The column in which the component is to be displayed.
--   `rowspan` (int): The number of rows the component is to span.
--   `colspan` (int): The number of columns the component is to span.
--   `settings` (object): The settings of the component.
--   `meta` (object): The metadata API of the component.
-    -   `name` (string): The name of the metadata.
-    -   `url` (string): The URL of the metadata.
--   `exclude_celltype` (array): The cell types to be excluded.
--   `gene` (string): The gene API.
--   `genelist` (string): The genelist variable name we want to use.
-
-### settings Properties
-
-The `settings` object has the following properties:
-
--   `preset` (string): The preset of the component.
--   `ignoreEmptyData` (boolean): Whether to ignore empty data or not.
--   `showscale` (boolean): Whether to show the scale or not.
--   `showlegend` (boolean): Whether to show the legend or not.
-        
-
+# DotBio Component
+
+The DotBio component is a dot plot that
+displays the expression of genes in different cell types. 
+
+
+## Properties
+
+The DotBio component has the following properties:
+
+-   `type` (string): The type of the component, in this case `DotBio`.
+-   `id` (string): The unique identifier of the component.
+-   `row` (int): The row in which the component is to be displayed.
+-   `col` (int): The column in which the component is to be displayed.
+-   `rowspan` (int): The number of rows the component is to span.
+-   `colspan` (int): The number of columns the component is to span.
+-   `settings` (object): The settings of the component.
+-   `meta` (object): The metadata API of the component.
+    -   `name` (string): The name of the metadata.
+    -   `url` (string): The URL of the metadata.
+-   `exclude_celltype` (array): The cell types to be excluded.
+-   `gene` (string): The gene API.
+-   `genelist` (string): The genelist variable name we want to use.
+
+### settings Properties
+
+The `settings` object has the following properties:
+
+-   `preset` (string): The preset of the component.
+-   `ignoreEmptyData` (boolean): Whether to ignore empty data or not.
+-   `showscale` (boolean): Whether to show the scale or not.
+-   `showlegend` (boolean): Whether to show the legend or not.
+        
+

package/docs/{docs/components → components}/echart.md

@@ -1,82 +1,82 @@
-# Echart Component
-
-The Echart component is a wrapper around the
-[Apache ECharts](https://echarts.apache.org/en/index.html) library. It is used
-to create a variety of visualizations including scatter plots, line charts, bar
-charts, and more.
-
-This Echart Component is same as the Rechart Component, but it is used for the
-page mode, which enable the user to create a page with multiple components. And
-it also **support the API to fetch the data**.
-
-## Properties
-
-The Echart component has the following properties:
-
--   `type` (string): The type of the component, in this case `Echart`.
--   `id` (string): The unique identifier of the component.
--   `row` (int): The row in which the component is to be displayed.
--   `col` (int): The column in which the component is to be displayed.
--   `rowspan` (int): The number of rows the component is to span.
--   `colspan` (int): The number of columns the component is to span.
--   `config` (object): The configuration of the component.
--   `parser` (object): The parser of the component.
--   `trigger` (object): The trigger of the component.
-
-### config Properties
-
-The `config` object has the following properties:
-
--   `width` (int): The width of the component.
--   `height` (int): The height of the component.
--   `preset` (string): The preset of the component.
--   `title` (string): The title of the component.
--   `xAxis` (string): The x-axis of the component.
--   `yAxis` (string): The y-axis of the component.
--   `legend` (string): The legend of the component.
--   `tooltip` (string): The tooltip of the component.
--   `data` (string): The data of the component.
-
-### parser Properties
-
-The `parser` object has the following properties:
-
--   `sources` (array): The sources of the component.
-    -   `name` (string): The name of the trigger.
-    -   `url` (string): The URL of the data.
-    -   `type` (string): The type of the component.
-    -   `responseKey` (string): The response key of the component.
-    -   `trigger` (object): The trigger of the component.
-        -   `title` (boolean): set the title to the triiger value.
-
-### Example
-
-```json
-        {
-            "id": "mmtrbc_tsne",
-            "type": "Echart",
-            "col": 2,
-            "rowspan": 3,
-            "config": {
-                "width": 600,
-                "height": 600,
-                "preset": "mmtrbc",
-                "title": " "
-            },
-            "parser": {
-                "sources": [{
-                    "name": "metadata",
-                    "url": "<your-backend-url>"
-                }, {
-                    "name": "gene",
-                    "url": "<your-backend-url>",
-                    "responseKey": "gene",
-                    "trigger": {
-                        "name": "mmtrbc_gene",
-                        "title": true
-                    }
-                }],
-                "type": "scatter"
-            }
-        }
-```
+# Echart Component
+
+The Echart component is a wrapper around the
+[Apache ECharts](https://echarts.apache.org/en/index.html) library. It is used
+to create a variety of visualizations including scatter plots, line charts, bar
+charts, and more.
+
+This Echart Component is same as the Rechart Component, but it is used for the
+page mode, which enable the user to create a page with multiple components. And
+it also **support the API to fetch the data**.
+
+## Properties
+
+The Echart component has the following properties:
+
+-   `type` (string): The type of the component, in this case `Echart`.
+-   `id` (string): The unique identifier of the component.
+-   `row` (int): The row in which the component is to be displayed.
+-   `col` (int): The column in which the component is to be displayed.
+-   `rowspan` (int): The number of rows the component is to span.
+-   `colspan` (int): The number of columns the component is to span.
+-   `config` (object): The configuration of the component.
+-   `parser` (object): The parser of the component.
+-   `trigger` (object): The trigger of the component.
+
+### config Properties
+
+The `config` object has the following properties:
+
+-   `width` (int): The width of the component.
+-   `height` (int): The height of the component.
+-   `preset` (string): The preset of the component.
+-   `title` (string): The title of the component.
+-   `xAxis` (string): The x-axis of the component.
+-   `yAxis` (string): The y-axis of the component.
+-   `legend` (string): The legend of the component.
+-   `tooltip` (string): The tooltip of the component.
+-   `data` (string): The data of the component.
+
+### parser Properties
+
+The `parser` object has the following properties:
+
+-   `sources` (array): The sources of the component.
+    -   `name` (string): The name of the trigger.
+    -   `url` (string): The URL of the data.
+    -   `type` (string): The type of the component.
+    -   `responseKey` (string): The response key of the component.
+    -   `trigger` (object): The trigger of the component.
+        -   `title` (boolean): set the title to the triiger value.
+
+### Example
+
+```json
+        {
+            "id": "mmtrbc_tsne",
+            "type": "Echart",
+            "col": 2,
+            "rowspan": 3,
+            "config": {
+                "width": 600,
+                "height": 600,
+                "preset": "mmtrbc",
+                "title": " "
+            },
+            "parser": {
+                "sources": [{
+                    "name": "metadata",
+                    "url": "<your-backend-url>"
+                }, {
+                    "name": "gene",
+                    "url": "<your-backend-url>",
+                    "responseKey": "gene",
+                    "trigger": {
+                        "name": "mmtrbc_gene",
+                        "title": true
+                    }
+                }],
+                "type": "scatter"
+            }
+        }
+```

package/docs/{docs/components → components}/html.md

@@ -1,34 +1,34 @@
-# HTML Component
-
-The HTML component is used to display HTML content on the page.
-
-## Properties
-
-The HTML component has the following properties:
-
--   `type` (string): The type of the component, in this case `HTML`.
--   `id` (string): The unique identifier of the component.
--   `row` (int): The row in which the component is to be displayed.
--   `col` (int): The column in which the component is to be displayed.
--   `colspan` (int): The number of columns the component is to span.
--   `html` (string): The HTML content to be displayed.
-
-## Future Work
-
-We will add the ability to fetch the HTML content from an API.
-
-- `script` (string): The script to be executed.
-- `style` (string): The style to be applied.
-
-### Example
-
-```json
-{
-    "type": "HTML",
-    "row": 1,
-    "col": 2,
-    "colspan": 3,
-    "html": "<img style='width: 100%' src='./mainpage.png' alt='Abstract'>"
-}
-```
-
+# HTML Component
+
+The HTML component is used to display HTML content on the page.
+
+## Properties
+
+The HTML component has the following properties:
+
+-   `type` (string): The type of the component, in this case `HTML`.
+-   `id` (string): The unique identifier of the component.
+-   `row` (int): The row in which the component is to be displayed.
+-   `col` (int): The column in which the component is to be displayed.
+-   `colspan` (int): The number of columns the component is to span.
+-   `html` (string): The HTML content to be displayed.
+
+## Future Work
+
+We will add the ability to fetch the HTML content from an API.
+
+- `script` (string): The script to be executed.
+- `style` (string): The style to be applied.
+
+### Example
+
+```json
+{
+    "type": "HTML",
+    "row": 1,
+    "col": 2,
+    "colspan": 3,
+    "html": "<img style='width: 100%' src='./mainpage.png' alt='Abstract'>"
+}
+```
+