rangeHeading: Headings for overlay dropdown menus

In overshiny: Interactive Overlays on 'shiny' Plots

Headings for overlay dropdown menus

Description

Use a call to one of these functions as the heading parameter of overlayServer() to provide a heading on the overlay dropdown menu reporting the start and end position of the overlay. For numbers, the heading from rangeHeading() will be e.g. "1.5 - 3.5". For dates, the heading from dateHeading() will be e.g. "2025-05-01 - 2025-06-01".

Usage

rangeHeading(..., sep = " - ")

dateHeading(format, ..., sep = " - ")

Arguments

...	Further arguments to be passed to format(), such as digits, scientific, etc. See the documentation for format() for details.
sep	A separator that will be inserted between the start and end position of the overlay. Use NULL to only print the start position.
format	For dateHeading() only, the date format to use, e.g. "%Y-%m-%d". See the documentation for format.Date() for details.

Value

A heading function suitable to pass to overlayServer() as the heading argument.

See Also

overlayServer(), for a complete example.

Examples

server <- function(input, output) {
    ov <- overlayServer("my_plot", 8, heading = dateHeading("%b %d"))
    # further server code here . . .
}

overshiny documentation built on Sept. 9, 2025, 5:50 p.m.