cog_disp_filter: Helper function for creating a cognostic for a link to...

In trelliscopejs: Create Interactive Trelliscope Displays

Helper function for creating a cognostic for a link to another display in a filtered state

Description

Helper function for creating a cognostic for a link to another display in a filtered state

Usage

cog_disp_filter(
  display,
  var,
  val,
  desc = "link",
  group = "common",
  type = c("href", "href_hash"),
  default_label = FALSE,
  default_active = FALSE,
  filterable = FALSE,
  sortable = FALSE
)

Arguments

display	A string indicating the name of the display to link to.
var	A string indicating the variable name to filter on.
val	A string indicating the value of the filter.
desc	a description for this cognostic value
group	optional categorization of the cognostic for organizational purposes in the viewer (currently not implemented in the viewer)
type	of either "href" or "href_hash". "href" will open the link in a new page. "href_hash" will update the page's hash and reload the page (useful when changing state inside an iframe)
default_label	should this cognostic be used as a panel label in the viewer by default?
default_active	should this cognostic be active (available for sort / filter / sample) by default?
filterable	should this cognostic be filterable? Default is TRUE. It can be useful to set this to FALSE if the cognostic is categorical with many unique values and is only desired to be used as a panel label.
sortable	should this cognostic be sortable?

trelliscopejs documentation built on Aug. 8, 2025, 6:40 p.m.