Annotations FULL_NAME for Alternative labels in table and chart views
As Ambra,
I want to be able to see, when available, the alternative label for a child code of a codelist with a simple or advanced hierarchy whenever the hierarchical context (parent codes) of a code is not provided (e.g. in table sub-title, row sections and columns and rows when the parent code is not available),
So that the hierarchical context of the code is always clear.
SDMX syntax
- Syntax in the item of ItemScheme:
"annotations": [{
"text": {
"en": "This is my full name",
"fr": "Ceci est mon nom complet"
},
"type": "FULL_NAME"
}]
- Syntax in the hierarchical code in Hierarchy:
<str:Hierarchy id="H_ES" leveled="false">
<com:Name xml:lang="es">OECD CL_AREA hierarchy_es</com:Name>
<str:HierarchicalCode id="EU1">
<com:Annotations>
<com:Annotation id="@SDMX">
<com:AnnotationType>FULL_NAME</com:AnnotationType>
<com:AnnotationText xml:lang="en">Full name text for EU1</com:AnnotationText>
<com:AnnotationText xml:lang="fr">Full name en francais pour EU1</com:AnnotationText>
</com:Annotation>
</com:Annotations>
<str:CodelistAliasRef>CL_AREA</str:CodelistAliasRef>
Functional specifications
The alternative label is displayed whenever available for all the codes
- in the data table sub-header, row section and column axis
- in the data table row whenever the related parent code is not included in the data message and is not displayable
- in the chart views
The alternative label is obtained
- from the
FULL_NAME
annotation of the corresponding hierarchical code in Hierarchies, if they are being used - otherwise from the
FULL_NAME
annotation of the corresponding code in Codelists
The alternative label only replaces the normal code label.
Examples
Assuming the codes or underlying hierarchical codes have FULL_NAME annotations.
- Codes in the sub-header to be replaced by the alternative labels:
- Codes in the row section axis to be replaced by the alternative labels:
- Codes in the column axis to be replaced by the alternative labels:
- Codes in the row axis to be replaced by the alternative labels whenever the parent code is not included in the data message:
- Codes in the chart views to be replaced by the alternative labels:
Note: The alternative label in .csv downloads is implemented through ticket dotstatsuite-core-common#32.
Edited by Jens Dossé