touchGripKnobInput {shinyKnobs}

Highly configurable, touch-enabled grip dial knob input for Shiny

Description

Highly configurable, touch-enabled grip dial knob input for Shiny

Usage

touchGripKnobInput(
  inputId,
  label = NULL,
  labelPosition = "top",
  width = "auto",
  step = "any",
  min = 0,
  max = 1,
  initial = 0.5,
  color = "orange",
  guideTicks = 9,
  gripBumps = 5,
  gripExtrusion = 0.5,
  minRotation = 20,
  maxRotation = 340,
  dragResistance = 100,
  wheelResistance = 100,
  globalRatePolicy = NULL,
  globalRatePolicyDelay = 500
)

Arguments

inputId

The input slot that will be used to access the value.

label

Optional label for knob

labelPosition

Position of label ('top' or 'bottom')

width

Width of the knob as a percentage of the container element

step

The step amount for value changes, usually used with min and max parameters. Can be 'any' (no step)

min

The minimum input value.

max

The maximum input value.

initial

Initial value of the knob. Knob resets to this value when double-clicked.

color

The color to use for the focus indicator and indicator dot. You can set any *hex* color (ex : '#0F1BC3') or named color, choices are 'purple', 'blue', 'green', 'yellow', 'red', 'orange' or 'transparent' to disable.

guideTicks

Number of tick marks on the outer guide ring (default = 9)

gripBumps

Number of grip bumps that appear when interacting with the dial (default = 5)

gripExtrusion

The degree to which the grips 'cut' into the dial when the user interacts with it. (range 0 to 1, default = 0.5)

minRotation

The angle (in degrees) of rotation corresponding to the min value, relative to pointing straight down (0 degree) (default = pointing to the first guide tick mark)

maxRotation

The angle (in degrees) of rotation corresponding to the max value, relative to pointing straight down (0 degree) (default = pointing to the last guide tick mark)

dragResistance

The amount of resistance to value change on mouse/touch drag events. Higher value means more precision, and the user will have to drag farther to change the input's value. (0 to 100)

wheelResistance

The amount of resistance to value change on mouse wheel scroll. Higher value means more precision, and the mouse wheel will be less effective at changing the input's value. (0 to 100)

globalRatePolicy

Rate policy determining the behavior of output value events. NULL will output values in real-time, 'debounce' will output values once the knob stops moving, 'throttle' will output values while the knob is moving but only at a certain frequency (controlled with ratePolicyDelay). This setting will affect every touchKnobInput in the project.

globalRatePolicyDelay

Delay to use when globalRatePolicy is set to 'throttle' or 'debounce'. This setting will affect every touchKnobInput in the project.

Value

Numeric value server-side.

Examples

if (interactive()) {

library("shiny")
library("shinyKnobs")

ui <- fluidPage(
  touchGripKnobInput(
    inputId = "myKnob",
    width = "25%",
    label = "A label...",
    color = "#428BCA"
  ),
  verbatimTextOutput(outputId = "res")
)

server <- function(input, output, session) {

  output$res <- renderPrint(input$myKnob)

}

shinyApp(ui = ui, server = server)

}