carouselBox: Create a carousel box for the main body of a dashboard.

Description Usage Arguments See Also

Description

A carouseleBox displays carouselSets and carouselItem as main box content, often structures as an carouselSets follows several carouselItems.

Usage

1
2
3
4
5
6
7
8
carouselBox(..., title = NULL, footer = NULL, status = NULL,
  solidHeader = FALSE, background = NULL, width = 6, height = NULL,
  collapsible = FALSE, collapsed = FALSE)

carouselSets(..., id = NULL, class = NULL, itemStartWith = 1L,
  .list = NULL)

carouselItem(..., caption = NULL, .list = NULL)

Arguments

...

For carousel items, this may consist of carouselSetss, which in turn includes one or more carouselItems.

title

Optional title.

footer

Optional footer text.

status

The status of the item This determines the item's background color. Valid statuses are listed in validStatuses.

solidHeader

Should the header be shown with a solid color background?

background

If NULL (the default), the background of the box will be white. Otherwise, a color string. Valid colors are listed in validColors.

width

The width of the box, using the Bootstrap grid system. This is used for row-based layouts. The overall width of a region is 12, so the default valueBox width of 4 occupies 1/3 of that width. For column-based layouts, use NULL for the width; the width is set by the column that contains the box.

height

The height of a box, in pixels or other CSS unit. By default the height scales automatically with the content.

collapsible

If TRUE, display a button in the upper right that allows the user to collapse the box.

collapsed

If TRUE, start collapsed. This must be used with collapsible=TRUE.

.list

An optional list containing items to put in the carousel same as the ... arguments, but in list format. This can be useful when working with programmatically generated items.

See Also

box for usage examples.

Other boxes: box, calendarBox, chatBox, infoBox, socialWigetBox, tabBox, timelineBox, valueBox


gyang274/ygdashboard documentation built on May 17, 2019, 9:42 a.m.