Options for room comment icons

Usage

indoorCommentOptions(
  icon = "comment",
  color = "#ffffff",
  background_color = "#7c3aed",
  show = TRUE,
  marker_label = "Read room comments",
  popup_label = "Room comments",
  source_label = "Read source",
  size = 36,
  min_size = 12,
  fit_to_room = TRUE,
  placement = "edge"
)

Arguments

icon: One of "comment", "quote", or "info" for bundled vector icons, or a short plain-text symbol such as "\u2605" or "\u270e".
color, background_color: Icon foreground and background colors as hexadecimal #RGB or #RRGGBB strings.
show: Whether to display comment icons.
marker_label: Accessible action label for a comment icon. The room label, when supplied, is appended automatically.
popup_label: Heading displayed above the room comments.
source_label: Label for each comment's source link.
size: Maximum visual badge diameter in CSS pixels.
min_size: Minimum visual badge diameter when fitting to a room.
fit_to_room: Scale the badge and its icon with the room's projected size as the map zoom changes. Point features retain size. The clickable target remains at least 44 pixels for touch and keyboard access.
placement: "edge" places the icon just outside the room's exterior boundary, with a short connector, leaving the room available for clicks. "center" places it at the interior reference point. Point and line features without an exterior ring use an offset from their reference point.

Value

An object of class leaflet_indoor_comment_options.

Examples

indoorCommentOptions(icon = "quote", background_color = "#7c3aed")
#> $icon
#> [1] "quote"
#> 
#> $color
#> [1] "#ffffff"
#> 
#> $backgroundColor
#> [1] "#7c3aed"
#> 
#> $show
#> [1] TRUE
#> 
#> $markerLabel
#> [1] "Read room comments"
#> 
#> $popupLabel
#> [1] "Room comments"
#> 
#> $sourceLabel
#> [1] "Read source"
#> 
#> $size
#> [1] 36
#> 
#> $minSize
#> [1] 12
#> 
#> $fitToRoom
#> [1] TRUE
#> 
#> $placement
#> [1] "edge"
#> 
#> attr(,"class")
#> [1] "leaflet_indoor_comment_options"
indoorCommentOptions(icon = "\u2605", marker_label = "Lire les témoignages",
                     popup_label = "Témoignages", source_label = "Source")
#> $icon
#> [1] "★"
#> 
#> $color
#> [1] "#ffffff"
#> 
#> $backgroundColor
#> [1] "#7c3aed"
#> 
#> $show
#> [1] TRUE
#> 
#> $markerLabel
#> [1] "Lire les témoignages"
#> 
#> $popupLabel
#> [1] "Témoignages"
#> 
#> $sourceLabel
#> [1] "Source"
#> 
#> $size
#> [1] 36
#> 
#> $minSize
#> [1] 12
#> 
#> $fitToRoom
#> [1] TRUE
#> 
#> $placement
#> [1] "edge"
#> 
#> attr(,"class")
#> [1] "leaflet_indoor_comment_options"