Data table: Footnote attributes displayed at highest possible level
As a .Stat DE user (visualisation page and data viewer)
In order to not be disturbed by unnecessary repetitive attribute information
I want to see attributes (that are defined to be shown as footnotes) attached to the always highest possible level in the table views.
References
- Full functional specifications in Aha! https://oecd.aha.io/features/ONEDATA-86
- Already implemented features for footnotes at observation level in in September 28, 2018
Original attachment level in the structural definitions and physical attachment in data messages
While attributes in SDMX-JSON data messages are physically attached to observations (or time series when the default series format is used), the original attachment level in the DSD can still be retrieved from the mandatory 'relationship' property in the attribute definition. It indicates one of the 3 possible attachment levels of attributes:
- dimensions: Array of Strings. One or more URN references to (a) local dimension(s) in the data structure definition on which the value of this attribute depends. Note that original relationships defined in data structure definitions through attachmentGroups or a group are resolved by the SDMX web service conveniently for the client into this list of dimensions.
{
"dimensions": ["FREQ", "SURVEY"]
}
- none: Empty Object. This means that value of the attribute will not vary with any of the other data structure components.
{
"none": {}
}
- primaryMeasure: String. URN reference to a primary measure locally as defined in the data structure definition. This is used to specify that the value of the attribute is dependent upon the observed value.
{
"primaryMeasure": "OBS_VALUE"
}
For more information see: https://github.com/sdmx-twg/sdmx-json/blob/master/data-message/docs/1-sdmx-json-field-guide.md
For option none, there is no variation of the attribute value across the whole DE data table, which corresponds below to the Scenario 1.
For option primaryMeasure, the attribute value varies for each cell in the DE data table, which corresponds below to the Scenario 5.
For option dimensions, the Scenario below to be used (1 to 5) depends on the table layout.
Scenario 1: The attribute value is the same for all cells in the table
Given that I'm displaying the DE data table
When an attribute has been defined in the configuration as a footnote (see syntax below)
And if the attachment level is dataset (indicated by option none) or if (for any other attachment level) all target dimensions have unique values (and are thus displayed in the data table title)
Then the (*) link is shown behind the table title (see yellow (*) in the screenshot).
Scenario 2: The attribute value is the same for all cells in any row section of the table
Given that I'm displaying the DE data table
When an attribute has been defined in the configuration as a footnote (see syntax below)
And if not scenario 1
And if at least one target dimension is displayed in a row section and no target dimension is displayed in data rows or columns
Then the (*) links are shown behind the corresponding row section dimension labels (see orange (*) in the screenshot).
Scenario 3: The attribute value is the same for all cells in any row of the table
Given that I'm displaying the DE data table
When an attribute has been defined in the configuration as a footnote (see syntax below)
And if not scenario 2
And if at least one target dimension is displayed in the rows and no target dimension is displayed in columns
Then the (*) links are displayed in a specific column in the rows corresponding to the specific attribute values (see red (*) in the screenshot). Thus, rows without an attribute value do not show the (*) link.
Scenario 4: The attribute value is the same for all cells in any column of the table
Given that I'm displaying the DE data table
When an attribute has been defined in the configuration as a footnote (see syntax below)
And if not scenario 3
And if at least one target dimension is displayed in the columns and no target dimension is displayed in rows
Then the (*) links are displayed in the specific row in the columns corresponding to the specific attribute values (see green (*) in the screenshot). Thus, columns without an attribute value do not show the (*) link.
#00c853
already implemented)
Scenario 5: The attribute value is different between the cells in the table (Given that I'm displaying the DE data table
When an attribute has been defined in the configuration as a footnote (see syntax below)
And if not scenario 4
Then the (*) links are displayed in the cells corresponding to the specific attribute values (see blue (*) in the example below). Thus, cells without an attribute value do not show the (*) link.
Important note: The colours of the (*) links are only used for illustrative purposes to ease understanding of these specifications. These colours are not to be used in the implementation.
Defining an attribute in the configuration for display as a footnote, through its ID:
"sdmx.attributes.footnotes": ["TIME_FORMAT"]