-
Notifications
You must be signed in to change notification settings - Fork 1
Configuration
The most straightforward way to customize query-overview is by using a configuration object whose properties describe the behavior and appearance of the chart. Since query-overview is a Webcharts chart object, many default Webcharts settings are set in the chartSettings.js file as described below. Refer to the Webcharts documentation for more details on these settings.
In addition to the standard Webcharts settings several custom settings not available in the base Webcharts library have been added to query-overview to facilitate data mapping and other custom functionality. These custom settings are described in detail below. All defaults can be overwritten by users.
The sections below describe each query-overview setting as of version 2.1.0.
string
site variable name
default: "sitename"
string
participant ID variable name
default: "subjectnameoridentifier"
string
visit/folder variable name
default: "folderoid"
string
visit/folder description variable name
default: "folderinstancename"
string
form variable name
default: "formoid"
string
form description variable name
default: "ecrfpagename"
string
field variable name
default: "fieldname"
string
field description variable name
default: "fieldlabel"
string
query origin variable name
default: "markinggroup"
string
entity opening query variable name
default: "queryopenby"
string
query text variable name
default: "querytext"
string
query response text variable name
default: "queryresponsetext"
string
query status variable name
default: "querystatus"
array
an array of query statuses that dictates how they are ordered in the legend and chart
default:
[
"Open",
"Answered",
"Closed",
"Cancelled"
]
array
an array of colors that determines the colors for query statuses
default:
[
"#fd8d3c",
"#4daf4a",
"#377eb8",
"#999999"
]
string
query open date variable name
default: "queryopendate"
string
query response date variable name
default: "queryresponsedate"
string
query resolution date variable name
default: "queryresolveddate"
string
query recency variable measured in days between query open date and data snapshot date, regardless of query status
default: "odays"
string
query recency category variable name; overrides recency_col
default: "open_time"
array
an array of query recency cutoffs for which query recency range will be derived
default:
[
7,
14,
30
]
array
an array of query statuses for which query age will be derived
default:
[
"Open"
]
string
query age variable measured in days between query open date and data snapshot date, query response date, or query resolution date for open, answered, and resolved queries, respectively
default: "qdays"
array
an array of query age cutoffs for which query age range will be derived
default:
[
14,
28,
56,
112
]
array
an array of colors with which to color query age range categories; only as many colors as there are query age range categories will be used, from darkest to lightest
default:
[
"#ffffcc",
"#ffeda0",
"#fed976",
"#feb24c",
"#fd8d3c",
"#fc4e2a",
"#e31a1c",
"#bd0026",
"#800026"
]
string
coloring variable name of query categorization: query age, query status, or any custom categorization; note that queryage is derived by the renderer
default: "queryage"
array
an array of variables by which to count queries; each value of the variable is plotted on the y-axis
default: none
string
group-by variable name
default: none
string
group-by variable label
default: none
array
an array of variables with which to stratify each group-by value, each value of which plots as a component of a stacked bar when Bar Arrangement is set to Stacked or as individual bars when Bar Arrangement is set to grouped
default: none
string
Stratification variable name
default: none
string
Stratification variable label
default: none
array
Stratification variable order
default: none
array
Stratification variable colors
default: none
array
an array of variables with which to filter the data
default: none
string
filter variable name
default: none
string
filter variable label
default: none
number
controls the maximum number of options that appear in the multi-select dropdowns before a scrollbar appears
default: 6
array
an array of variables which will print in the listing; if unspecified all variables in data will appear in listing
default: none
string
detail listing variable name
default: none
string
detail listing column header
default: none
string
controls arrangement of bars, either stacked or grouped side-by-side
default: "stacked"
number
a value that limits the number of groups displayed on the y-axis
default: All
boolean
sort groups on the y-axis alphanumerically; by default groups are sorted by descending frequency
default: true
boolean
optionally truncate cell text past a certain number of characters
default: true
number
cell text past this cutoff will be truncated and the full text will be captured in a tooltip
default: 100
The objects below contain Webcharts settings for each display as of version 2.1.0 of the Query Overview.
{
"x": {
"label": "# of Queries",
"column": null,
"behavior": "flex"
},
"y": {
"type": "ordinal",
"column": null,
"label": "Form",
"sort": null
},
"marks": [
{
"type": "bar",
"per": [
null
],
"split": null,
"arrange": null,
"summarizeX": "count",
"tooltip": null
}
],
"color_by": null,
"color_dom": null,
"legend": {
"location": "top",
"label": null,
"order": null
},
"margin": {
"right": 50
},
"range_band": 25
}
{
"searchable": true,
"sortable": true,
"pagination": true,
"exportable": true,
"nRowsPerPage": 10
}