Skip to content

Commit

Permalink
simplify redundant docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@benmusson
benmusson committed Dec 23, 2024
1 parent 7d8e110 commit 576d246
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 262 deletions.
8 changes: 5 additions & 3 deletions modules/charts/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

A module for Ignition that adds a collection of enhanced Perspective charting components.

![chart-js.png](docs/examples/chart-js.png)

## Getting Started

1. Download the [latest version] from [releases].
Expand All @@ -18,9 +20,9 @@ A module for Ignition that adds a collection of enhanced Perspective charting co

### Component Directory

| Name | Category | Description |
|----------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Chart.js Component](./docs/components/chartjs.md) | Charting | Chart.js renders chart elements on an HTML5 canvas unlike other D3.js-based charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. | |
| Name | Category | Description |
|---------------------------------------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Chart.js Component](https://docs.mussonindustrial.com/ignition/embr-charts/components/chart-js/) | Charting | Chart.js renders chart elements on an HTML5 canvas unlike other D3.js-based charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. | |

---

Expand Down
108 changes: 0 additions & 108 deletions modules/charts/docs/components/chartjs.md
View file

This file was deleted.

18 changes: 9 additions & 9 deletions modules/periscope/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,18 @@ A module for Ignition that includes design extensions and enhancements for Persp

### Component Directory

| Name | Category | Description |
|-------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Embedded View +](./docs/components/view.md) | Embedding + | An enhanced Embedded View component with load ahead optimizations and gateway-side property handling. |
| [Flex Repeater +](./docs/components/flex-repeater.md) | Embedding + | An enhanced Flex Repeater component with support for unique view paths, common view parameters/styling, load ahead optimizations, and gateway-side property handling. |
| [Swiper](./docs/components/swiper.md) | Embedding + | Swiper is the most modern free and open source mobile touch slider with hardware accelerated transitions and amazing native behavior. |
| Name | Category | Description |
|-------------------------------------------------------------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Embedded View +](https://docs.mussonindustrial.com/ignition/embr-periscope/components/embedded-view-plus/) | Embedding + | An enhanced Embedded View component with load ahead optimizations and gateway-side property handling. |
| [Flex Repeater +](https://docs.mussonindustrial.com/ignition/embr-periscope/components/flex-repeater-plus/) | Embedding + | An enhanced Flex Repeater component with support for unique view paths, common view parameters/styling, load ahead optimizations, and gateway-side property handling. |
| [Swiper](https://docs.mussonindustrial.com/ignition/embr-periscope/components/swiper/) | Embedding + | Swiper is the most modern free and open source mobile touch slider with hardware accelerated transitions and amazing native behavior. |

### Scripting Directory

| Name | Category | Description |
|------------------------------------------------|-------------|-------------------------------------------------------------|
| [`system.perspective.runJavaScriptAsync`]() | Perspective | Asynchronously run JavaScript code on the client. |
| [`system.perspective.runJavaScriptBlocking`]() | Perspective | Run JavaScript code on the client and block for the result. |
| Name | Category | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------|
| [`system.perspective.runJavaScriptAsync`](https://docs.mussonindustrial.com/ignition/embr-periscope/scripting/perspective/system-perspective-runJavaScriptAsync) | Perspective | Asynchronously run JavaScript code on the client. |
| [`system.perspective.runJavaScriptBlocking`](https://docs.mussonindustrial.com/ignition/embr-periscope/scripting/perspective/system-perspective-runJavaScriptBlocking) | Perspective | Run JavaScript code on the client and block for the result. |


## Changelog
Expand Down
23 changes: 0 additions & 23 deletions modules/periscope/docs/components/flex-repeater.md
View file

This file was deleted.

Loading

0 comments on commit 576d246

Please sign in to comment.