PGM Documentation

PGM Documentation

  • RCode
  • RPGM
  • Server

›API Reference

Getting started

  • Documentation
  • Installation
  • RPGM Software

RPGM Project

  • Introduction
  • Sequences (.pseq)
  • GUI (.pgui)
  • Widgets

Tutorials

  • Getting started
  • Dynamism & Layout
  • Plotly
  • CSS
  • CSS for Grid

API Reference

  • R GUI Functions
  • R RPGM Functions
  • R Script Functions
  • R XLSX Functions
  • CSS Reference
  • Widget Properties
  • Widget Types

Widget Properties

These widget properties are used in functions like gui.setProperties().

Widget Properties List

These properties are generally available to all widgets:

PropertyDefaultDescription
value""The value of the widget.
isrFALSEIf the value is an R expression.
css""A list of CSS styles or a list of CSS class names.
margintop10The space over the widget in pixels.
labeltext""The text of the label.
labelposition"left"The position of the label. Can be "left", "top", "topaligned" or "hidden".
helptext"The help text below the widget.
helpposition"bottom"The position of the help text. Can be "bottom" or "label".
requiredFALSEIf the input is required.
onchange""R Code to execute when the widget's value changed.
condition""R condition when submitting the form.

Specific widgets properties

Buttons

PropertyDefaultDescription
onpress""R code to execute when pressing the button.
buttonsize"md"The size of the button. Can be "sm", "md", "lg" or "fw".
buttondesign"primary"The style of the button. Can be "primary", "secondary", "success", "info", "warning", "danger", "light" or "dark".

Columns

PropertyDefaultDescription
columnswidthsc(4, 4, 4)The widths of each columns.
columnspadding10The padding between each columns.

Graphs

PropertyDefaultDescription
graphtitle""
graphx""
graphy""

Grids

PropertyDefaultDescription
forcesortFALSEAdded in v3.0.60 Force column sorting client side. DANGER! This can lead to several bugs and MUST ONLY BE USED ON READONLY grids.
gridcolumns""The columns headers.
gridnbcolumns""The number of columns.
gridnbrows""The number of rows.
gridrows""The rows headers.
gridtype"text"The type of the grid. Can be "text", "integer", "float" or "checkbox".
readonlyFALSEAdded in v3.0.60 Disable sending back grid data after submit. Can be used for big data for preventing lags.

Labels

PropertyDefaultDescription
fontsize14The size of the font in widget.
fontfamily"default"The family of the font.
fontcolor"#000000"The color of the font.

Lists

PropertyDefaultDescription
boxdesign"light"The style of the list. Can be "primary", "secondary", "success", "info", "warning", "danger", "light" or "dark".
boxheader""The list header.

Numbers

PropertyDefaultDescription
min""The minimal value allowed.
max""The maximal value allowed.
step""The step between each value.

Progress

PropertyDefaultDescription
progresscolor"#27ae60"The color of the progress bar or circle.
progressdescription"%"The text of the progress bar or circle.

R Repeaters

PropertyDefaultDescription
intervalcode""The R Code to execute.
intervaltime1000The interval in ms between each R execution.

Tabs

PropertyDefaultDescription
tabsnames[]The name of the tabs.
tabscurrent1The currently selected tab index.
Last updated on 10/04/2020
← CSS ReferenceWidget Types →
  • Widget Properties List
  • Specific widgets properties
    • Buttons
    • Columns
    • Graphs
    • Grids
    • Labels
    • Lists
    • Numbers
    • Progress
    • R Repeaters
    • Tabs
PGM Documentation
Docs
RPGM Server
More
Main PGM Solutions website
Copyright © 2022 PGM Solutions