shortening of the browser url
the goal is to reduce the browser url size by reducing the query params when possible to avoid reaching browser limitations as much as possible.
here are the current keys:
notes:
- key can be renamed (easy work) (ie locale => l)
- values can be reworked (easy work) (ie dataflow identifiers => SIS-CC-stable,DF_AIR_EMISSIONS,OECD,1.0)
- key can be added or removed (medium work, requires to relocate router state fragment in another place)
new key | old key | type | definition | exemple |
---|---|---|---|---|
lc | locale | string | locale of the app | locale=fr |
fc | facet | string | open facet box in side in search results | facet=qmsoRy4r |
tm | term | string | search term | term=people |
pg | start | integer | page index of the search | start=0 |
fs | constraints | array | facet values selected in the search | constraints[0]=SIS-CC-stable |
df[ds|id|ag|vs] or better df={source},{agency},{id},{version} | dataflow[datasourceId|dataflowId|agencyId|version] | object | dataflow identifiers | dataflow[datasourceId]=SIS-CC-stable&dataflow[dataflowId]=DF_AIR_EMISSIONS&dataflow[agencyId]=OECD&dataflow[version]=2.1 |
- to be removed - | filter | string | open filter box in side in viz | filter=COU |
dq | dataquery | string | sdmx dataquery | dataquery=.AUS+AUT.GP.A |
ac=true|false | hasAccessibility=true|false | boolean | a11y mode of the app | hasAccessibility=false |
av=true|false | hasDataAvailability=true|false | boolean | sdmx data availability mode | hasDataAvailability=false |
vw=tb|ch | viewer=table|chart | string | type of viewer component used | viewer=table |
pd | period | string | period of the sdmx data request | period=2017,2020 |
- to be removed - or fq | frequency | string | frequency of the app | frequency=Q |
lt[rs|rw|cl] | layout[sections|rows|header] | object | layout of the table in the vis page | layout[sections]=&layout[rows]=STO&layout[header]=TIME_PERIOD |
lb=nm|id|bt | display=label|code|both | string | display mode of sdmx (label, code, both) | display=code |
to[]=true|false | time[]=true|false | object | order of time dimension(s) | time[TIME_PERIOD]=true |
Sandrine's comment:
There is no specification for the map, could we envisage the following shortcuts and implement it in this ticket.
new key | old key | type | definition | example |
---|---|---|---|---|
mp[id|lv] | map[mapId|levelId] | string | map information:ID of the map and ID of the map level | **map[mapId]**=world_countries&**map[levelId]**=countries |
Edited by Mike Velluet