@cdc/dashboard 4.25.10 → 4.26.1

package/Dynamic_Data.md

@@ -26,6 +26,72 @@ Dashboards have a section called `sharedFilters` that is mapped over to gather a
 
 After all required selections are made the `sharedFilters` are mapped over to gather query parameters to attach to the dynamic datasets. If the sharedFilter item has a list of `usedBy` identifiers the query parameters will only apply to datasets that are mapped to those respective visualizations or rows, conversly if there's now `usedBy` or the list is empty the sharedFilter item will apply it's query parameter(s) to all dynamic datasets used by the current dashboard.
 
+## URL Filter Types: Query String vs File Name
+
+URL filters support two different methods for modifying dataset URLs, specified by the `filterBy` property:
+
+### Query String Filters (`filterBy: "Query String"`)
+
+Query String filters append the filter value as a URL query parameter. This is the most common approach for REST APIs.
+
+**Configuration:**
+- `filterBy`: Set to `"Query String"`
+- `queryParameter`: The name of the query parameter to append (e.g., `"geography"`, `"state"`)
+- `datasetKey`: **Auto-populated** from the widgets specified in `usedBy` - you don't need to specify this manually
+
+**Example:**
+```json
+{
+  "key": "Geography",
+  "type": "urlfilter",
+  "filterBy": "Query String",
+  "queryParameter": "geography",
+  "usedBy": ["chart1"],
+  "apiFilter": {
+    "apiEndpoint": "https://api.cdc.gov/states",
+    "valueSelector": "state",
+    "textSelector": "state_name"
+  }
+}
+```
+
+When a user selects "Alaska", the dataset URL `https://api.cdc.gov/data.json` becomes `https://api.cdc.gov/data.json?geography=Alaska`.
+
+### File Name Filters (`filterBy: "File Name"`)
+
+File Name filters replace the filename portion of the URL. This is useful for APIs that use path-based routing or file-based data sources.
+
+**Configuration:**
+- `filterBy`: Set to `"File Name"`
+- `fileName`: Template for the new filename, use `${query}` placeholder for the filter value
+- `datasetKey`: **Required** - specifies which dataset's filename should be modified
+- `whitespaceReplacement`: How to handle spaces in the filter value (`"Keep Spaces"`, `"Remove Spaces"`, or `"Replace With Underscore"`)
+
+**Example:**
+```json
+{
+  "key": "State",
+  "type": "urlfilter",
+  "filterBy": "File Name",
+  "fileName": "NSSPSubState${query}",
+  "datasetKey": "resp-data.json",
+  "whitespaceReplacement": "Remove Spaces",
+  "usedBy": ["chart1"],
+  "apiFilter": {
+    "apiEndpoint": "https://api.cdc.gov/states",
+    "valueSelector": "state"
+  }
+}
+```
+
+When a user selects "Alaska", the dataset URL `https://api.cdc.gov/data/default.json` becomes `https://api.cdc.gov/data/NSSPSubStateAlaska.json`.
+
+### Dataset Key Behavior
+
+- **Query String filters**: The `datasetKey` is automatically determined from the widgets specified in the `usedBy` array. The system looks at each widget's `dataKey` property to identify which datasets should receive the query parameter.
+
+- **File Name filters**: The `datasetKey` must be explicitly specified to indicate which dataset's filename should be modified. This is required because filename transformations apply to specific URLs.
+
 Example (2):
 
 ```

package/dist/{cdcdashboard-fce76882.es.js → cdcdashboard-BnB1QM5d.es.js}

@@ -1,4 +1,4 @@
-const o = "Topology", e = [
+const o = [
   [
     [
       381613,
@@ -359835,7 +359835,7 @@ const o = "Topology", e = [
       4
     ]
   ]
-], r = {
+], e = {
   scale: [
     19541440750834335e-20,
     13610231396060925e-20
@@ -359844,7 +359844,7 @@ const o = "Topology", e = [
     -135.94188728451547,
     24.236087
   ]
-}, s = {
+}, r = {
   regions: {
     type: "GeometryCollection",
     geometries: [
@@ -361520,16 +361520,9 @@ const o = "Topology", e = [
       }
     ]
   }
-}, t = {
-  type: o,
-  arcs: e,
-  transform: r,
-  objects: s
 };
 export {
-  e as arcs,
-  t as default,
-  s as objects,
-  r as transform,
-  o as type
+  o as arcs,
+  r as objects,
+  e as transform
 };

package/dist/{cdcdashboard-c55ac1ea.es.js → cdcdashboard-D6CG2-Hb.es.js}

@@ -1,4 +1,4 @@
-const o = "Topology", s = [
+const o = [
   [
     [
       19832,
@@ -37842,7 +37842,7 @@ const o = "Topology", s = [
     -178.19451843993753,
     18.963909185849403
   ]
-}, r = {
+}, s = {
   states: {
     type: "GeometryCollection",
     geometries: [
@@ -39369,16 +39369,9 @@ const o = "Topology", s = [
       }
     ]
   }
-}, p = {
-  type: o,
-  arcs: s,
-  transform: e,
-  objects: r
 };
 export {
-  s as arcs,
-  p as default,
-  r as objects,
-  e as transform,
-  o as type
+  o as arcs,
+  s as objects,
+  e as transform
 };

package/dist/{cdcdashboard-31a33da1.es.js → cdcdashboard-MXgURbdZ.es.js}

@@ -1,4 +1,4 @@
-const e = "Topology", a = [
+const e = [
   [
     [
       819,
@@ -34591,7 +34591,7 @@ const e = "Topology", a = [
       -75
     ]
   ]
-], p = {
+], a = {
   scale: [
     0.013996889580093316,
     0.00821422737479012
@@ -34600,7 +34600,7 @@ const e = "Topology", a = [
     -179.99999999990004,
     -84.71367427324907
   ]
-}, t = {
+}, p = {
   countries: {
     type: "GeometryCollection",
     geometries: [
@@ -39186,16 +39186,9 @@ const e = "Topology", a = [
       }
     ]
   }
-}, s = {
-  type: e,
-  arcs: a,
-  transform: p,
-  objects: t
 };
 export {
-  a as arcs,
-  s as default,
-  t as objects,
-  p as transform,
-  e as type
+  e as arcs,
+  p as objects,
+  a as transform
 };