diff --git a/_includes/toc-dashboard.html b/_includes/toc-dashboard.html index 86164a7c..d9ce27a1 100644 --- a/_includes/toc-dashboard.html +++ b/_includes/toc-dashboard.html @@ -9,7 +9,8 @@
  • Dashboard usage
  • The first step of dashboard
  • Widget
  • -
  • Layout
  • +
  • Layouting Dashboard
  • node-red-dashboard nodes
  • Dashboard extra nodes
  • diff --git a/docs/dashboard/images/layout/ElementSizerNum.png b/docs/dashboard/images/layout/ElementSizerNum.png new file mode 100644 index 00000000..27c5e800 Binary files /dev/null and b/docs/dashboard/images/layout/ElementSizerNum.png differ diff --git a/docs/dashboard/images/layout/ElementSizert.png b/docs/dashboard/images/layout/ElementSizert.png new file mode 100644 index 00000000..bea9e4ff Binary files /dev/null and b/docs/dashboard/images/layout/ElementSizert.png differ diff --git a/docs/dashboard/images/layout/Group-Properties.png b/docs/dashboard/images/layout/Group-Properties.png new file mode 100644 index 00000000..2c932aa7 Binary files /dev/null and b/docs/dashboard/images/layout/Group-Properties.png differ diff --git a/docs/dashboard/images/layout/Layout.png b/docs/dashboard/images/layout/Layout.png new file mode 100644 index 00000000..ed8e041d Binary files /dev/null and b/docs/dashboard/images/layout/Layout.png differ diff --git a/docs/dashboard/images/layout/LayoutButton.png b/docs/dashboard/images/layout/LayoutButton.png new file mode 100644 index 00000000..1c17003f Binary files /dev/null and b/docs/dashboard/images/layout/LayoutButton.png differ diff --git a/docs/dashboard/images/layout/LayoutEditor.png b/docs/dashboard/images/layout/LayoutEditor.png new file mode 100644 index 00000000..dfa04f2a Binary files /dev/null and b/docs/dashboard/images/layout/LayoutEditor.png differ diff --git a/docs/dashboard/images/layout/Link.png b/docs/dashboard/images/layout/Link.png new file mode 100644 index 00000000..7173cfa0 Binary files /dev/null and b/docs/dashboard/images/layout/Link.png differ diff --git a/docs/dashboard/images/layout/OLD/ElementSizerNum.png b/docs/dashboard/images/layout/OLD/ElementSizerNum.png new file mode 100644 index 00000000..f378e491 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/ElementSizerNum.png differ diff --git a/docs/dashboard/images/layout/OLD/ElementSizert.png b/docs/dashboard/images/layout/OLD/ElementSizert.png new file mode 100644 index 00000000..29053904 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/ElementSizert.png differ diff --git a/docs/dashboard/images/layout/OLD/Group-Properties.png b/docs/dashboard/images/layout/OLD/Group-Properties.png new file mode 100644 index 00000000..369b6787 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Group-Properties.png differ diff --git a/docs/dashboard/images/layout/OLD/Layout.png b/docs/dashboard/images/layout/OLD/Layout.png new file mode 100644 index 00000000..cb9a7ee8 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Layout.png differ diff --git a/docs/dashboard/images/layout/OLD/Link.png b/docs/dashboard/images/layout/OLD/Link.png new file mode 100644 index 00000000..cb9b156f Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Link.png differ diff --git a/docs/dashboard/images/layout/OLD/Site.png b/docs/dashboard/images/layout/OLD/Site.png new file mode 100644 index 00000000..6feb7efa Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Site.png differ diff --git a/docs/dashboard/images/layout/OLD/Spacer.png b/docs/dashboard/images/layout/OLD/Spacer.png new file mode 100644 index 00000000..550d7299 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Spacer.png differ diff --git a/docs/dashboard/images/layout/OLD/Tab-Group-button.png b/docs/dashboard/images/layout/OLD/Tab-Group-button.png new file mode 100644 index 00000000..a42f2a77 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Tab-Group-button.png differ diff --git a/docs/dashboard/images/layout/OLD/Widget-Properties.png b/docs/dashboard/images/layout/OLD/Widget-Properties.png new file mode 100644 index 00000000..ec335a87 Binary files /dev/null and b/docs/dashboard/images/layout/OLD/Widget-Properties.png differ diff --git a/docs/dashboard/images/layout/Site.png b/docs/dashboard/images/layout/Site.png new file mode 100644 index 00000000..fbdbf24d Binary files /dev/null and b/docs/dashboard/images/layout/Site.png differ diff --git a/docs/dashboard/images/layout/Spacer.png b/docs/dashboard/images/layout/Spacer.png new file mode 100644 index 00000000..0eeaac02 Binary files /dev/null and b/docs/dashboard/images/layout/Spacer.png differ diff --git a/docs/dashboard/images/layout/Tab-Group-button.png b/docs/dashboard/images/layout/Tab-Group-button.png new file mode 100644 index 00000000..994b43e0 Binary files /dev/null and b/docs/dashboard/images/layout/Tab-Group-button.png differ diff --git a/docs/dashboard/images/layout/Widget-Properties.png b/docs/dashboard/images/layout/Widget-Properties.png new file mode 100644 index 00000000..11feed26 Binary files /dev/null and b/docs/dashboard/images/layout/Widget-Properties.png differ diff --git a/docs/dashboard/layout-ja.md b/docs/dashboard/layout-ja.md deleted file mode 100644 index 48760dcc..00000000 --- a/docs/dashboard/layout-ja.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: docs-dashboard -toc: toc-dashboard.html -title: Layout (レイアウト) ---- - -### Change width on layout setting after adding group (グループを追加してレイアウトを横長に変更する) -text diff --git a/docs/dashboard/layout.md b/docs/dashboard/layout.md index 12bed833..51955a8f 100644 --- a/docs/dashboard/layout.md +++ b/docs/dashboard/layout.md @@ -1,8 +1,184 @@ --- layout: docs-dashboard toc: toc-dashboard.html -title: Layout +title: Layouting Dashboard + --- -### Change width on layout setting after adding group -text + + +### Basic UI Elements of Dashboard + + + + + + The Node-RED Dashboard consists of `Widget`,` Group`, and `Tab`. Widget is a GUI element such as button or chart. Tab represents the entire dashboard screen displayed on the Web browser. Multiple Tabs can be defined, and one tab can be displayed by selecting from the side menu or switching with the `ui_control node`. Group is used to define the area where multiple widgets will be placed. Group and Tab are defined as configuration nodes. + +### Layouting Dashboard Elements + + + + + + + + The dashboard layout is defined using a grid with fixed size element. The widget has the height and width, and the group has the width in units of the number of grids. The size in pixels of the grid's unit element can be set by '*1x1 Widget Size*' of the `Site` tab of the dashboard sidebar. + + + +On the `SIte` tab, spacing between widgets and the spacing and paddings between groups can also be specified. + +
    + + + + + + The widgets are arranged in the group and the group in the tab so that they fit within their respective widths. The hierarchical relationship of these elements can be managed in the `Layout` tab of the dashboard sidebar. + + + +While layouting the dashboard screen, placements of screen elements are determined as follows: + +1. place widgets in each group from top to bottom and left to right, + +2. place groups in each tab from top to bottom and left to right. + + + + To place the widgets on the belonging group and the groups on the belonging tab, free space that can placed the element is searched from top to bottom and from left to right, and first first found area is used to place them. If the browser that is displaying the dashboard is resized, the placement of the goups within the displayed tab will be adjusted automatically. + + The order and belonging relation of UI elements on the `Layout` tab can be changed by drag & drop. + +
    + +### Adding a Widget to Dashboard + + + + + + The group to place the widget can be set by the *Group* item of *Properties* of the UI node corresponding to the widget. The *Size* item is used for setting the widget size. + +![Widget-Properties.png](images/layout/Widget-Properties.png) + + + + The *Group* setting specify the belonging tab and the width of the group in the same way. + +![Group-Properties.png](images/layout/Group-Properties.png) + + + + + + A new tab can be added by pressing the `+tab` button on the `Layout` tab of the dashboard sidebar, and a new group can be added by pressing the `+group` button that appears while mouse over the group element. + +
    + +### Setting UI Element Size + + + + + + + + The size of widget and tab is set by the *Size* item. Selecting the `Size` item will display a popup interface for specifying UI element size. The size of the UI elemt can be specified by the grid area. + + + + Pressing the `auto` button indicate to set the widget size automatically. Its behaviour depends on UI widgets. Typically, the width of the widget is set to the same as the width of the belonging group, and the height is set to appropriate value. + +
    + + + + Clicking *W xH* at the top of the UI will display the following interface for changing the widget size using digits input. This UI is useful to specify the size for large widget. + +ElementSizerNum.png + +### Adjusting Layout using Spacer + + + + + + + +The `Spacer` node can be used for fine-tuning the placement of widgets in a group. The Spacer node is a special widget for filling in the area with the specified size. + + To add a `Spacer` to a group, use the `+spacer` button displayed while mouse over the group on the `Layout` tab. + +
    + +### Layout Editor + + + + + + While layouting a complicated dashboard screen, GUI-based `Layout Editor` can be used. The layout editor can be opened by pressing the `layout` button displayed while mouse over on a tab on the `Layout` tab. + +
    + + + + The `Layout Editor` displays the grid layout of the groups that make up the specified tab. + + The width of each group can be changed by the *Width* item displayed on the top right. + + + + The placement of widgets in a group can be changed by drag & dropping widgets. The lock mark on the upper right of the widget indicates whether the widget size is *auto* or not. If the key is unlocked, the widget size can be changed by dragging the arrow at the bottom right. + + After finishing layout with the `Layout Editor`, `Spacer` nodes are automatically inserted at appropriate positions. + +![LayoutEditor.png](images/layout/LayoutEditor.png) + +
    + +### Link to Web Page + + + +A link to a web page instead of tab can be added to side menu using `+Link` button of the `Layout` tab. The specified link can be selected from the side menu of dashboard or the `ui_control` node and can redirect to the page or embed it in the dashboard using iframe. + +### Configuring Group Title + + + + + + The group name is displayed at the top of the group on the dashboard by default. It can be disabled by unselecting the'Display group name'check box of the group settings panel. + +### Configuring Title Bar & Side Menu + + + + + +At the top of the dashboard screen, a title bar that displays side menus etc. is shown by default. This can be hidden by the `Site` tab settings. Also, the side menu can be configured to be always shown or shown in icon only from the `Site` tab settings. + + + +Title and icons of each tab and whether to display the tab on the side menu can be set from the settings paneg of each tab. + + + + [Material Design icon](https://klarsys.github.io/angular-material-icons/) *(e.g. 'check', 'close')*, a [Font Awesome icon](https://fontawesome.com/v4.7.0/icons/) *(e.g. 'fa-fire')*, a [Weather icon](https://github.com/Paul-Reed/weather-icons-lite/blob/master/css_mappings.md) *(e.g. 'wi-wu-sunny')*, or a [Google material icon]([Google Fonts](https://fonts.google.com/icons)) *(e.g. 'mi-videogame_asset')* can be used as an icon for a tab. diff --git a/docs/index.html b/docs/index.html index b75cf959..ef73a1cf 100644 --- a/docs/index.html +++ b/docs/index.html @@ -27,12 +27,17 @@

    Frequently Asked Questions

    Tutorials

    Examples of what you can do, taken one step at a time

    -
  • -
    -

    Cookbook

    -

    Recipes to help you get things done with Node-RED

    -
  • +
  • +
    +

    Cookbook

    +

    Recipes to help you get things done with Node-RED

    +
  • +
  • +
    +

    Dashboard

    +

    The definitive guide to using Node-RED Dashboard

    +