Fusion Registry Wiki - User contributions [en]

Data Browser Configuration

2020-07-29T14:20:53Z

Knicholls: /* Theme */

[[Category:DataBrowserConfigure]]

= Overview =
The Fusion Data Browser is simply and HTML and JavaScript project which communicates with the Fusion Registry or Fusion Edge Server API using Web Services. As such it needs to know the URL of these services. In addition configuration of the main site such as which Locales to support, what options go into the sidebar, and what export formats are supported are all defined in the site configuration.

The configuration file is named '''siteconfig.json''' and is located under the properties folder, and will look something like this:

{
"ServicesAPI" : "https://demo.metadatatechnology.com/FusionRegistry/ws/fusion/info/product",
"Locales" : ["en", "he"],
"ExportFormats" : ["excel", "[[Reporting Template|reporttemplate]]", "[[SDMX-ML Structure Specific Data|sdmx-ml]]", "[[Fusion-CSV|csv]]", "[[Fusion-CSV-TS|csv-ts]]", "[[SDMX-CSV|sdmx-csv]]", "[[SDMX-JSON Data|sdmx-json]]"],
"SeriesList" : {
"ShowPCH" : true,
"HideInvalidFilters": false
},
"theme" : "fusion",
"DatasetNavigation": [
{
"Components": ["REF_AREA"]
},
{
"Components": ["CURRENCY"]
},
{
"Title" : "Product Breakdown",
"Components": ["TRD_PRODUCT"]
}
]
}

= Services API =
"ServicesAPI" : "https://demo.metadatatechnology.com/FusionRegistry/ws/fusion/info/product"

The Services API property is the web service URL of the Fusion Registry or Fusion Edge Server's product information service. It will match the example above, this web service needs to be accessible for the Data Browser to work. The response from the Fusion Registry is the location of all the web service entry points required by the Fusion Data Browser to operate.

= Locales =
"Locales" : ["en", "he"]
The Locales property is an array of supported locales for the Fusion Data Browser. Adding a new Locale into this list will result in the Fusion Data Browser adding it to the drop down selection for the user to choose. When a user switches to the Locale all the metadata and data requested from the Registry or Edge server will be requested in the given locale. If the server is able to provide the information in this locale (i.e if the metadata has a label in the language) it will, otherwise it will revert to another language, defaulting to English.

The second purpose for the locale is to change all the labels and text in the Fusion Data Browser. This is achieved by the Fusion Data Browser loading a properties file called browser_lang_[lang].json. where [lang] is replaced with the 2 character language code selected by the user. This file is located under the properties folder. If there is no file for your locale, the the Fusion Data Browser will check all other locales in your array, in order, until it finds a file it can use to resolve all the browser labels. In the above example the "en" locale will be checked first, as it is the first locale in the array. If you wish to create labels in your locale, please copy one of the existing browser_lang files, and change the text in the file. If you wish to re-share your file with us, please get in touch.

= Export Formats =
"ExportFormats" : ["sdmx", "csv", "excel"]
These are the list of supported export formats, if you wish to remove any, remove them from this array.

= Series List =
"SeriesList" : {
"ShowPCH" : true
},

ShowPCH refers to Show Percentage Change. If this is set to true, then the time series listed will show the percentage change from the latest period to the previous period.

= Dataset Navigation =
"DatasetNavigation": [
{
"Components": ["COUNTRY"]
},
{
"Components": ["CURRENCY"]
},
{
"Title" : "Product Breakdown",
"Components": ["TRD_PRODUCT"]
}
]
[[File:Fdb sidebar.png|thumb|Dataset Navigation]]
The DatasetNavigation property is used to control what breakdowns are presented in the sidebar. It is an array of Objects, where each Object represents a different breakdown.

The Components array lists the Dimenions to display a breakdown for. The Dimension ID is used, however it is not specific to any Data Structure Definition, so if multiple DSDs use the same ID for a Dimension, then they will all be included in the breakdown. Each breakdown
has a genearted title of 'Data by [breakdown], however this title can be changed by adding a Title property. The above configuration will generate the following Navigation in the sidebar:

 

If more then one Dimension ID is placed in the Array, then the breakdown becomes hierarchical.
"Components": ["CURRENCY", "FREQ"]

[[File:Fdb_sidebar2.png|thumb]]

The above will list the available Currencies in the Sidebar, and on Currency selection, the available Frequencies for the Currency will be shown.

= Theme =
The '''theme''' property is used to change the css files used to skin the data browser. Each theme corresponds to the name of the folder in the "lib/css/themes" folder. In here, the name of the folder will be the same as this property, this property is mandatory, and the default is the "fusion" theme.
You can add your own theme by adding the following css to a new theme:
* codepicker.css - this themes the codePicker
* main.css - this is the main css wrapper that effects the site as a whole, every page will include this file
* pivottable.css - css file skins the pivot table UI widget, this is used in conjunction with viewData.css, but the pivot table has more complex CSS
* serieslist.css - skins the series list section of the databrowser
* viewData.css - all the charting and viewing of the data, when you are looking at data, these are the styles that affect that page

== Changing selective styles ==

All the files above are loaded all at once, as this is a single-page application (SPA), so in order to control different styles applied at different elements, you must use the classes and the ID's from the dom.

For example, if i wish to have ALL the pages max-width 1110px except for say the chart and the search table, i would:

* navigate to main.css
* find the id's i want to effect (in this case, #dataflow-view, #home-page, #codepicker-view
* add a max-width: 1100px;
* find or add #search-result-view and set width to 100%
* go to view data.css
* add #chart-view{ width: 100%;}

And now, you will have all the pages with max-width except the search and the charts, where they will be width 100% relative to boostrap's container-fluid style.

== extending bootstrap ==

Because we use the bootstrap framework and grid layout to build the Data Browser, you might want to have, say a button that contains custom colours.

To do this, you would add a custom bootstrap style in main.css that describes your colours. you may then use this with the btn class on a button.

For example:

.btn-fusion has:
color: #111;
background-color: #c8e2fc;
border: 1px #26517b solid;
we can now apply this to an element on the DOM:
<button class="btn btn-fusion"></button>

Instead of overriding the Bootstrap style for btn-default.

== Understanding the HTML layout ==

most of the HTML classes and ID's are in a logical order, and it is best to use the browser dom viewer to understand the classes and ID's
All majour wrappers are label with an ID:

home-page, search-result-view, dataflow-view, etc... this makes it wasy to target JUST elements in those wrappers without effecting the whole site.

For example. If i want to just change the button colours for all button in the dataflow view, i can just do:
#dataflow-view btn { background-color: #c8F2fc; }

sub containers are classed and then inner containers are mostly ID's with UID's but if you wish to fine tune these elements, then you would need to make a CSS selector that can uniquely identity the elements, ALL elements on the page should be able to be identified uniquely with CSS selectors

Chart Configuration

2020-07-29T13:55:18Z

Knicholls:

[[Category:DataBrowserConfigure]]

= Overview =
The Chart Configuration is used to configure global properties for the Pivot Table and Time Series Chart.

The properties file is called chartconfig.json and is found in the properties folder. It will look something like this:
{
"EmbedURL" : "https://myservver.org/fusionembeddedchart",
"PivotTable" : {
"ObsLimit" : 2000
},
"maxDecimals": 2,
"numberFormat": "#,###.##",
"TimeSeries" : {
"GroupCount" : 500,
"SeriesLimit" : 20,
"SeriesDisplay" : {
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",
"WB:GCI(1.0)" : "${REF_AREA} ${INDICATOR}\n[bold]{sdmxdate}[/] \n{valueY}",
},
"dateFormat": {
"annual": "yyyy",
"daily": "yyyy-MM-dd",
"monthly": "yyyy-MM"
}
}
}

= Embed URL =
Charts created in the Fusion Data Browser can be saved or shared as a URL. The URL will rebuild the chart exactly as it has been defined, with the same series and properties. The URL does not include the data; this is obtained from the server at the time the chart is generated. The Embed feature of the Fusion Data Browser requires a second application to be running. The EmbedURL provides the entry point to this application. [more details coming...]

= Pivot Table Configuration =
"PivotTable" : {
"ObsLimit" : 2000
},

The Pivot Table configuration is used to restrict how many observations can be put into the table at once, this is to prevent the table from becoming too large for the web browser to render. If a user tries to graph more observations, the data browser will automatically aggregate one or more of the Dimensions, allowing the user to using slicing, or inline query modications to bring the chart size back into the limit.

= Number Format =
This property is used to configure Am Charts number formatting, if you use this property, then Max Decimals is ignored for AmCharting, but still still be applied to the series table chart.

Documentation on number formats is here:
https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/

= Max Decimals =
This property is used to configure the charting decimals without padding, set this value if you wish to restrict the amount of decimal points you want to display on the interactive charting.
If this value is not set, the whole number is shown

= Time Series Configuration =

== Group Count ==
"GroupCount" : 500,

The Group count is used to prevent the time series chart from plotting every single data point on long time series. This can cause the chart to look messy, and contain far too much information for a user to meaningfully use.

{|
|-
|
[[File:Fdb ts groupcount off.png|thumb|Without Group Count]]
|| [[File:Fdb_ts_groupcount.png|thumb|With Group Count=500]]
|}

The Group Count value indicates the maximum number of points to plot on a time series for the displayed range. When the user zooms into the chart, the time series will be refined to show more points.

It is possible to remove the Group Count by setting it to -1.

== Series Limit ==
"SeriesLimit" : 20,
The Series Limit prevents a user from creating a Time Series chart with too many series. The limit can be unset by setting the value to -1, howver a time series chart with thousands of series will cause a web browser to become unresponsive as it tries to render the information, so a limit is recommended.

== Series Display ==
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",

The Series Display property enables a Global configuration of the tooltips shown when a user hovers over a time series line.

{|
|-
|
[[File:Fdb series toolip.png|frame|Showing Series Tooltip]]
|}

Without this setting, the label defaults to showing the series key, in the format A:UK:EMP, where A is the reported value in the first Dimension, UK the reported value in the second Dimension and so on.

The Series Display properties are the URN short code of a Dataflow, for example "ECB:EXR(1.0)" refers to a European Central Bank dataset for EXR (Exchange Rates) at version 1.0. The Default property can be defined to apply a label rule to any dataset that does not have a specific rule.

The Syntax includes variable placeholders for Dimension or Attribute values, dates, and observation values. Markup can be used to change the font styling or text. The following table shows the syntax:

== Text Variables ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| ${REF_AREA} || Replaced by the value of the Reference Area Dimension, in the Locale set on the Data Browser (or an alternative Locale if there is not one avalable in the requested Locale)
|-
| {sdmxdate}|| Replaced by the date in SDMX format, as reported in the dataset. For example 2001-Q1.
|-
| {valueY} || Replaced by the reported observation value
|}

== Observation Value Modifiers ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| {valueY.formatNumber('###.00')} || @see [https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/#Overriding_format AM Charts Formatting Numbers]
|-
| {valueY.open} || First (open) Observation value for the series, within current selection.
|-
| {valueY.high} || Highest observation value for the series, within current selection.
|-
| {valueY.low} || Lowest observation value for the series, within current selection.
|-
| {valueY.close} || Last (close) observation value for the series, within current selection.
|-
| {valueY.sum} || Sum of all values in a series, within current selection.
|-
| {valueY.count} || Number data items in series, within current selection.
|-
| {valueY.average} || Average values in a series, within current selection.
|-
| {valueY.change} || Difference between series first and last value
|-
| {valueY.changePercent} || Difference between series first and last values in percent.
|-
| {valueY.previousChange} || Difference between value of current and previous items.
|-
| {valueY.previousChangePercent} || Difference between value of current and previous items, in percent.
|}

== Style ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| \n || New Line
|-
| [bold]Text[/] || Outputs the 'Text' in Bold
|-
| [#00ff00]Green Text[/]! || Colours 'Green Text' green
|-
| [font-size: 30px]Large Text[/] || Uses inline CSS to make the font-size large
|}

= Data Format =
This property can be used to configure the date format for the time series chart, this needs to take a valid date format defined by the JavaScript standard https://www.w3schools.com/js/js_date_formats.asp

Chart Configuration

2020-07-29T13:49:20Z

Knicholls:

[[Category:DataBrowserConfigure]]

= Overview =
The Chart Configuration is used to configure global properties for the Pivot Table and Time Series Chart.

The properties file is called chartconfig.json and is found in the properties folder. It will look something like this:
{
"EmbedURL" : "https://myservver.org/fusionembeddedchart",
"PivotTable" : {
"ObsLimit" : 2000
},
"maxDecimals": 2
"TimeSeries" : {
"GroupCount" : 500,
"SeriesLimit" : 20,
"numberFormat": "#,###.##",
"SeriesDisplay" : {
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",
"WB:GCI(1.0)" : "${REF_AREA} ${INDICATOR}\n[bold]{sdmxdate}[/] \n{valueY}",
},
"dateFormat": {
"annual": "yyyy",
"daily": "yyyy-MM-dd",
"monthly": "yyyy-MM"
}
}
}

= Embed URL =
Charts created in the Fusion Data Browser can be saved or shared as a URL. The URL will rebuild the chart exactly as it has been defined, with the same series and properties. The URL does not include the data; this is obtained from the server at the time the chart is generated. The Embed feature of the Fusion Data Browser requires a second application to be running. The EmbedURL provides the entry point to this application. [more details coming...]

= Pivot Table Configuration =
"PivotTable" : {
"ObsLimit" : 2000
},

The Pivot Table configuration is used to restrict how many observations can be put into the table at once, this is to prevent the table from becoming too large for the web browser to render. If a user tries to graph more observations, the data browser will automatically aggregate one or more of the Dimensions, allowing the user to using slicing, or inline query modications to bring the chart size back into the limit.

= Number Format =
This property is used to configure Am Charts number formatting, if you use this property, then Max Decimals is ignored for AmCharting, but still still be applied to the series table chart.

Documentation on number formats is here:
https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/

= Max Decimals =
This property is used to configure the charting decimals without padding, set this value if you wish to restrict the amount of decimal points you want to display on the interactive charting.
If this value is not set, the whole number is shown

= Time Series Configuration =

== Group Count ==
"GroupCount" : 500,

The Group count is used to prevent the time series chart from plotting every single data point on long time series. This can cause the chart to look messy, and contain far too much information for a user to meaningfully use.

{|
|-
|
[[File:Fdb ts groupcount off.png|thumb|Without Group Count]]
|| [[File:Fdb_ts_groupcount.png|thumb|With Group Count=500]]
|}

The Group Count value indicates the maximum number of points to plot on a time series for the displayed range. When the user zooms into the chart, the time series will be refined to show more points.

It is possible to remove the Group Count by setting it to -1.

== Series Limit ==
"SeriesLimit" : 20,
The Series Limit prevents a user from creating a Time Series chart with too many series. The limit can be unset by setting the value to -1, howver a time series chart with thousands of series will cause a web browser to become unresponsive as it tries to render the information, so a limit is recommended.

== Series Display ==
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",

The Series Display property enables a Global configuration of the tooltips shown when a user hovers over a time series line.

{|
|-
|
[[File:Fdb series toolip.png|frame|Showing Series Tooltip]]
|}

Without this setting, the label defaults to showing the series key, in the format A:UK:EMP, where A is the reported value in the first Dimension, UK the reported value in the second Dimension and so on.

The Series Display properties are the URN short code of a Dataflow, for example "ECB:EXR(1.0)" refers to a European Central Bank dataset for EXR (Exchange Rates) at version 1.0. The Default property can be defined to apply a label rule to any dataset that does not have a specific rule.

The Syntax includes variable placeholders for Dimension or Attribute values, dates, and observation values. Markup can be used to change the font styling or text. The following table shows the syntax:

== Text Variables ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| ${REF_AREA} || Replaced by the value of the Reference Area Dimension, in the Locale set on the Data Browser (or an alternative Locale if there is not one avalable in the requested Locale)
|-
| {sdmxdate}|| Replaced by the date in SDMX format, as reported in the dataset. For example 2001-Q1.
|-
| {valueY} || Replaced by the reported observation value
|}

== Observation Value Modifiers ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| {valueY.formatNumber('###.00')} || @see [https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/#Overriding_format AM Charts Formatting Numbers]
|-
| {valueY.open} || First (open) Observation value for the series, within current selection.
|-
| {valueY.high} || Highest observation value for the series, within current selection.
|-
| {valueY.low} || Lowest observation value for the series, within current selection.
|-
| {valueY.close} || Last (close) observation value for the series, within current selection.
|-
| {valueY.sum} || Sum of all values in a series, within current selection.
|-
| {valueY.count} || Number data items in series, within current selection.
|-
| {valueY.average} || Average values in a series, within current selection.
|-
| {valueY.change} || Difference between series first and last value
|-
| {valueY.changePercent} || Difference between series first and last values in percent.
|-
| {valueY.previousChange} || Difference between value of current and previous items.
|-
| {valueY.previousChangePercent} || Difference between value of current and previous items, in percent.
|}

== Style ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| \n || New Line
|-
| [bold]Text[/] || Outputs the 'Text' in Bold
|-
| [#00ff00]Green Text[/]! || Colours 'Green Text' green
|-
| [font-size: 30px]Large Text[/] || Uses inline CSS to make the font-size large
|}

= Data Format =
This property can be used to configure the date format for the time series chart, this needs to take a valid date format defined by the JavaScript standard https://www.w3schools.com/js/js_date_formats.asp

Chart Configuration

2020-07-29T12:19:21Z

Knicholls: /* Overview */

[[Category:DataBrowserConfigure]]

= Overview =
The Chart Configuration is used to configure global properties for the Pivot Table and Time Series Chart.

The properties file is called chartconfig.json and is found in the properties folder. It will look something like this:
{
"EmbedURL" : "https://myservver.org/fusionembeddedchart",
"PivotTable" : {
"ObsLimit" : 2000
},
"TimeSeries" : {
"GroupCount" : 500,
"SeriesLimit" : 20,
"maxDecimals": 2
"numberFormat": "#,###.##",
"SeriesDisplay" : {
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",
"WB:GCI(1.0)" : "${REF_AREA} ${INDICATOR}\n[bold]{sdmxdate}[/] \n{valueY}",
},
"dateFormat": {
"annual": "yyyy",
"daily": "yyyy-MM-dd",
"monthly": "yyyy-MM"
}
}
}

= Embed URL =
Charts created in the Fusion Data Browser can be saved or shared as a URL. The URL will rebuild the chart exactly as it has been defined, with the same series and properties. The URL does not include the data; this is obtained from the server at the time the chart is generated. The Embed feature of the Fusion Data Browser requires a second application to be running. The EmbedURL provides the entry point to this application. [more details coming...]

= Pivot Table Configuration =
"PivotTable" : {
"ObsLimit" : 2000
},

The Pivot Table configuration is used to restrict how many observations can be put into the table at once, this is to prevent the table from becoming too large for the web browser to render. If a user tries to graph more observations, the data browser will automatically aggregate one or more of the Dimensions, allowing the user to using slicing, or inline query modications to bring the chart size back into the limit.

= Number Format =
This property is used to configure Am Charts number formatting, if you use this property, then Max Decimals is ignored for AmCharting, but still still be applied to the series table chart.

Documentation on number formats is here:
https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/

= Max Decimals =
This property is used to configure the charting decimals without padding, set this value if you wish to restrict the amount of decimal points you want to display on the interactive charting.
If this value is not set, the whole number is shown

= Time Series Configuration =

== Group Count ==
"GroupCount" : 500,

The Group count is used to prevent the time series chart from plotting every single data point on long time series. This can cause the chart to look messy, and contain far too much information for a user to meaningfully use.

{|
|-
|
[[File:Fdb ts groupcount off.png|thumb|Without Group Count]]
|| [[File:Fdb_ts_groupcount.png|thumb|With Group Count=500]]
|}

The Group Count value indicates the maximum number of points to plot on a time series for the displayed range. When the user zooms into the chart, the time series will be refined to show more points.

It is possible to remove the Group Count by setting it to -1.

== Series Limit ==
"SeriesLimit" : 20,
The Series Limit prevents a user from creating a Time Series chart with too many series. The limit can be unset by setting the value to -1, howver a time series chart with thousands of series will cause a web browser to become unresponsive as it tries to render the information, so a limit is recommended.

== Series Display ==
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",

The Series Display property enables a Global configuration of the tooltips shown when a user hovers over a time series line.

{|
|-
|
[[File:Fdb series toolip.png|frame|Showing Series Tooltip]]
|}

Without this setting, the label defaults to showing the series key, in the format A:UK:EMP, where A is the reported value in the first Dimension, UK the reported value in the second Dimension and so on.

The Series Display properties are the URN short code of a Dataflow, for example "ECB:EXR(1.0)" refers to a European Central Bank dataset for EXR (Exchange Rates) at version 1.0. The Default property can be defined to apply a label rule to any dataset that does not have a specific rule.

The Syntax includes variable placeholders for Dimension or Attribute values, dates, and observation values. Markup can be used to change the font styling or text. The following table shows the syntax:

== Text Variables ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| ${REF_AREA} || Replaced by the value of the Reference Area Dimension, in the Locale set on the Data Browser (or an alternative Locale if there is not one avalable in the requested Locale)
|-
| {sdmxdate}|| Replaced by the date in SDMX format, as reported in the dataset. For example 2001-Q1.
|-
| {valueY} || Replaced by the reported observation value
|}

== Observation Value Modifiers ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| {valueY.formatNumber('###.00')} || @see [https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/#Overriding_format AM Charts Formatting Numbers]
|-
| {valueY.open} || First (open) Observation value for the series, within current selection.
|-
| {valueY.high} || Highest observation value for the series, within current selection.
|-
| {valueY.low} || Lowest observation value for the series, within current selection.
|-
| {valueY.close} || Last (close) observation value for the series, within current selection.
|-
| {valueY.sum} || Sum of all values in a series, within current selection.
|-
| {valueY.count} || Number data items in series, within current selection.
|-
| {valueY.average} || Average values in a series, within current selection.
|-
| {valueY.change} || Difference between series first and last value
|-
| {valueY.changePercent} || Difference between series first and last values in percent.
|-
| {valueY.previousChange} || Difference between value of current and previous items.
|-
| {valueY.previousChangePercent} || Difference between value of current and previous items, in percent.
|}

== Style ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| \n || New Line
|-
| [bold]Text[/] || Outputs the 'Text' in Bold
|-
| [#00ff00]Green Text[/]! || Colours 'Green Text' green
|-
| [font-size: 30px]Large Text[/] || Uses inline CSS to make the font-size large
|}

= Data Format =
This property can be used to configure the date format for the time series chart, this needs to take a valid date format defined by the JavaScript standard https://www.w3schools.com/js/js_date_formats.asp

Chart Configuration

2020-07-24T10:37:45Z

Knicholls:

[[Category:DataBrowserConfigure]]

= Overview =
The Chart Configuration is used to configure global properties for the Pivot Table and Time Series Chart.

The properties file is called chartconfig.json and is found in the properties folder. It will look something like this:
{
"EmbedURL" : "https://myservver.org/fusionembeddedchart",
"PivotTable" : {
"ObsLimit" : 2000
},
"TimeSeries" : {
"GroupCount" : 500,
"SeriesLimit" : 20,
"maxDecimals": 2 || "numberFormat": "#,###.##",
"SeriesDisplay" : {
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",
"WB:GCI(1.0)" : "${REF_AREA} ${INDICATOR}\n[bold]{sdmxdate}[/] \n{valueY}",
},
"dateFormat": {
"annual": "yyyy",
"daily": "yyyy-MM-dd",
"monthly": "yyyy-MM"
}
}
}

= Embed URL =
Charts created in the Fusion Data Browser can be saved or shared as a URL. The URL will rebuild the chart exactly as it has been defined, with the same series and properties. The URL does not include the data; this is obtained from the server at the time the chart is generated. The Embed feature of the Fusion Data Browser requires a second application to be running. The EmbedURL provides the entry point to this application. [more details coming...]

= Pivot Table Configuration =
"PivotTable" : {
"ObsLimit" : 2000
},

The Pivot Table configuration is used to restrict how many observations can be put into the table at once, this is to prevent the table from becoming too large for the web browser to render. If a user tries to graph more observations, the data browser will automatically aggregate one or more of the Dimensions, allowing the user to using slicing, or inline query modications to bring the chart size back into the limit.

= Number Format =
This property is used to configure Am Charts number formatting, if you use this property, then Max Decimals is ignored for AmCharting, but still still be applied to the series table chart.

Documentation on number formats is here:
https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/

= Max Decimals =
This property is used to configure the charting decimals without padding, set this value if you wish to restrict the amount of decimal points you want to display on the interactive charting.
If this value is not set, the whole number is shown

= Time Series Configuration =

== Group Count ==
"GroupCount" : 500,

The Group count is used to prevent the time series chart from plotting every single data point on long time series. This can cause the chart to look messy, and contain far too much information for a user to meaningfully use.

{|
|-
|
[[File:Fdb ts groupcount off.png|thumb|Without Group Count]]
|| [[File:Fdb_ts_groupcount.png|thumb|With Group Count=500]]
|}

The Group Count value indicates the maximum number of points to plot on a time series for the displayed range. When the user zooms into the chart, the time series will be refined to show more points.

It is possible to remove the Group Count by setting it to -1.

== Series Limit ==
"SeriesLimit" : 20,
The Series Limit prevents a user from creating a Time Series chart with too many series. The limit can be unset by setting the value to -1, howver a time series chart with thousands of series will cause a web browser to become unresponsive as it tries to render the information, so a limit is recommended.

== Series Display ==
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",

The Series Display property enables a Global configuration of the tooltips shown when a user hovers over a time series line.

{|
|-
|
[[File:Fdb series toolip.png|frame|Showing Series Tooltip]]
|}

Without this setting, the label defaults to showing the series key, in the format A:UK:EMP, where A is the reported value in the first Dimension, UK the reported value in the second Dimension and so on.

The Series Display properties are the URN short code of a Dataflow, for example "ECB:EXR(1.0)" refers to a European Central Bank dataset for EXR (Exchange Rates) at version 1.0. The Default property can be defined to apply a label rule to any dataset that does not have a specific rule.

The Syntax includes variable placeholders for Dimension or Attribute values, dates, and observation values. Markup can be used to change the font styling or text. The following table shows the syntax:

== Text Variables ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| ${REF_AREA} || Replaced by the value of the Reference Area Dimension, in the Locale set on the Data Browser (or an alternative Locale if there is not one avalable in the requested Locale)
|-
| {sdmxdate}|| Replaced by the date in SDMX format, as reported in the dataset. For example 2001-Q1.
|-
| {valueY} || Replaced by the reported observation value
|}

== Observation Value Modifiers ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| {valueY.formatNumber('###.00')} || @see [https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/#Overriding_format AM Charts Formatting Numbers]
|-
| {valueY.open} || First (open) Observation value for the series, within current selection.
|-
| {valueY.high} || Highest observation value for the series, within current selection.
|-
| {valueY.low} || Lowest observation value for the series, within current selection.
|-
| {valueY.close} || Last (close) observation value for the series, within current selection.
|-
| {valueY.sum} || Sum of all values in a series, within current selection.
|-
| {valueY.count} || Number data items in series, within current selection.
|-
| {valueY.average} || Average values in a series, within current selection.
|-
| {valueY.change} || Difference between series first and last value
|-
| {valueY.changePercent} || Difference between series first and last values in percent.
|-
| {valueY.previousChange} || Difference between value of current and previous items.
|-
| {valueY.previousChangePercent} || Difference between value of current and previous items, in percent.
|}

== Style ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| \n || New Line
|-
| [bold]Text[/] || Outputs the 'Text' in Bold
|-
| [#00ff00]Green Text[/]! || Colours 'Green Text' green
|-
| [font-size: 30px]Large Text[/] || Uses inline CSS to make the font-size large
|}

= Data Format =
This property can be used to configure the date format for the time series chart, this needs to take a valid date format defined by the JavaScript standard https://www.w3schools.com/js/js_date_formats.asp

Chart Configuration

2020-06-29T08:47:14Z

Knicholls:

[[Category:DataBrowserConfigure]]

= Overview =
The Chart Configuration is used to configure global properties for the Pivot Table and Time Series Chart.

The properties file is called chartconfig.json and is found in the properties folder. It will look something like this:
{
"EmbedURL" : "https://myservver.org/fusionembeddedchart",
"PivotTable" : {
"ObsLimit" : 2000
},
"TimeSeries" : {
"GroupCount" : 500,
"SeriesLimit" : 20,
"maxDecimals": 2,
"SeriesDisplay" : {
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",
"WB:GCI(1.0)" : "${REF_AREA} ${INDICATOR}\n[bold]{sdmxdate}[/] \n{valueY}",
},
"dateFormat": {
"annual": "yyyy",
"daily": "yyyy-MM-dd",
"monthly": "yyyy-MM"
}
}
}

= Embed URL =
Charts created in the Fusion Data Browser can be saved or shared as a URL. The URL will rebuild the chart exactly as it has been defined, with the same series and properties. The URL does not include the data; this is obtained from the server at the time the chart is generated. The Embed feature of the Fusion Data Browser requires a second application to be running. The EmbedURL provides the entry point to this application. [more details coming...]

= Pivot Table Configuration =
"PivotTable" : {
"ObsLimit" : 2000
},

The Pivot Table configuration is used to restrict how many observations can be put into the table at once, this is to prevent the table from becoming too large for the web browser to render. If a user tries to graph more observations, the data browser will automatically aggregate one or more of the Dimensions, allowing the user to using slicing, or inline query modications to bring the chart size back into the limit.

= Max Decimals =
This property is used to configure the charting decimals without padding, set this value if you wish to restrict the amount of decimal points you want to display on the interactive charting.
If this value is not set, the whole number is shown

= Time Series Configuration =

== Group Count ==
"GroupCount" : 500,

The Group count is used to prevent the time series chart from plotting every single data point on long time series. This can cause the chart to look messy, and contain far too much information for a user to meaningfully use.

{|
|-
|
[[File:Fdb ts groupcount off.png|thumb|Without Group Count]]
|| [[File:Fdb_ts_groupcount.png|thumb|With Group Count=500]]
|}

The Group Count value indicates the maximum number of points to plot on a time series for the displayed range. When the user zooms into the chart, the time series will be refined to show more points.

It is possible to remove the Group Count by setting it to -1.

== Series Limit ==
"SeriesLimit" : 20,
The Series Limit prevents a user from creating a Time Series chart with too many series. The limit can be unset by setting the value to -1, howver a time series chart with thousands of series will cause a web browser to become unresponsive as it tries to render the information, so a limit is recommended.

== Series Display ==
"Default": "${REF_AREA}\n${SERIES} \n[bold]{sdmxdate}[/] \n[bold]{valueY}[/]",
"ECB:EXR(1.0)": "${CURRENCY} [bold]to[/] ${CURRENCY_DENOM} \n[bold]{sdmxdate}[/]\n[bold]{valueY}[/]",

The Series Display property enables a Global configuration of the tooltips shown when a user hovers over a time series line.

{|
|-
|
[[File:Fdb series toolip.png|frame|Showing Series Tooltip]]
|}

Without this setting, the label defaults to showing the series key, in the format A:UK:EMP, where A is the reported value in the first Dimension, UK the reported value in the second Dimension and so on.

The Series Display properties are the URN short code of a Dataflow, for example "ECB:EXR(1.0)" refers to a European Central Bank dataset for EXR (Exchange Rates) at version 1.0. The Default property can be defined to apply a label rule to any dataset that does not have a specific rule.

The Syntax includes variable placeholders for Dimension or Attribute values, dates, and observation values. Markup can be used to change the font styling or text. The following table shows the syntax:

== Text Variables ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| ${REF_AREA} || Replaced by the value of the Reference Area Dimension, in the Locale set on the Data Browser (or an alternative Locale if there is not one avalable in the requested Locale)
|-
| {sdmxdate}|| Replaced by the date in SDMX format, as reported in the dataset. For example 2001-Q1.
|-
| {valueY} || Replaced by the reported observation value
|}

== Observation Value Modifiers ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| {valueY.formatNumber('###.00')} || @see [https://www.amcharts.com/docs/v4/concepts/formatters/formatting-numbers/#Overriding_format AM Charts Formatting Numbers]
|-
| {valueY.open} || First (open) Observation value for the series, within current selection.
|-
| {valueY.high} || Highest observation value for the series, within current selection.
|-
| {valueY.low} || Lowest observation value for the series, within current selection.
|-
| {valueY.close} || Last (close) observation value for the series, within current selection.
|-
| {valueY.sum} || Sum of all values in a series, within current selection.
|-
| {valueY.count} || Number data items in series, within current selection.
|-
| {valueY.average} || Average values in a series, within current selection.
|-
| {valueY.change} || Difference between series first and last value
|-
| {valueY.changePercent} || Difference between series first and last values in percent.
|-
| {valueY.previousChange} || Difference between value of current and previous items.
|-
| {valueY.previousChangePercent} || Difference between value of current and previous items, in percent.
|}

== Style ==
{| class="wikitable"
|-
! Syntax !! Description
|-
| \n || New Line
|-
| [bold]Text[/] || Outputs the 'Text' in Bold
|-
| [#00ff00]Green Text[/]! || Colours 'Green Text' green
|-
| [font-size: 30px]Large Text[/] || Uses inline CSS to make the font-size large
|}

= Data Format =
This property can be used to configure the date format for the time series chart, this needs to take a valid date format defined by the JavaScript standard https://www.w3schools.com/js/js_date_formats.asp

Data Browser Configuration

2020-06-29T08:41:04Z

Knicholls: