Skip to content

SdmxJsonCatalogItem

"type": "sdmx-json"

SdmxCatalogItemTraits

Trait Type Default Description
dataflowId string

SDMX Dataflow ID

agencyId string

SDMX Agency ID

unitMeasure string

This string is essentially 'units' for the dataset. If a UNIT_MEASURE SDMX attribute exists in this dataflow, the default unitMeasure will be determined from it.

dimensions SdmxDimensionTraits[]

Dimensions

AttributionTraits
attribution string

The attribution to display with the data.

CatalogMemberTraits
name string

The name of the catalog item.

description string

The description of the catalog item. Markdown and HTML may be used.

nameInCatalog string

The name of the item to be displayed in the catalog, if it is different from the one to display in the workbench.

info InfoSectionTraits[]

Human-readable information about this dataset.

infoSectionOrder string[]

An array of section titles definining the display order of info sections. If this property is not defined, {@link DataPreviewSections}'s DEFAULT_SECTION_ORDER is used

isOpenInWorkbench boolean true

Whether the item in the workbench open or collapsed.

shortReport string

A short report to show on the now viewing tab.

shortReportSections ShortReportTraits[]

A list of collapsible sections of the short report

isExperiencingIssues boolean

Whether the catalog item is experiencing issues which may cause its data to be unavailable

hideLegendInWorkbench boolean

Whether the legend is hidden in the workbench for this catalog member.

legends LegendTraits[]

The legends to display on the workbench.

hideSource boolean

Indicates that the source of this data should be hidden from the UI (obviously this isn't super-secure as you can just look at the network requests).

metadataUrls MetadataUrlTraits[]

Metadata URLs to show in data catalog.

dataUrls DataUrlTraits[]

Data URLs to show in data catalog.

dataCustodian string

Gets or sets a description of the custodian of this data item.

modelDimensions DimensionTraits[]

This provides ability to set model JSON through SelectableDimensions (a dropdown).

disableAboutData boolean

Disables the 'About Data' button in the workbench.

ChartPointOnMapTraits
chartPointOnMap LatLonHeightTraits

The point on map where the current chart for the item was generated from. A marker will be shown at this point if the chart is active.

ChartTraits
chartType string

Type determines how the data availibility will be plotted on chart. eg: momentLines, momentPoints

chartDisclaimer string

A HTML string to show above the chart as a disclaimer

chartColor string

The color to use when the data set is displayed on the chart. The value can be any html color string, eg: 'cyan' or '#00ffff' or 'rgba(0, 255, 255, 1)' for the color cyan.

chartGlyphStyle string

The glyph style to use for points plotted on the chart. Allowed values include circle, cross, diamond, square, star, triangle, wye. Default is "circle".

DiscretelyTimeVaryingTraits
fromContinuous string nearest

Specifies how a continuous time (e.g. the timeline control) is mapped to a discrete time for this dataset. Valid values are:
* nearest - the nearest available discrete time to the current continuous time is used.
* next - the discrete time equal to or after the current continuous time is used.
* previous - the discrete time equal to or before the current continuous time is used.

showInChartPanel boolean

Whether to plot data availability on a chart.

disableDateTimeSelector boolean true

When true, disables the date time selector in the workbench

multiplierDefaultDeltaStep number 2

The multiplierDefaultDeltaStep is used to set the default multiplier (see TimeVaryingTraits.multiplier trait) - it represents the average number of (real-time) seconds between (dataset) time steps. For example, a value of five would set the multiplier so that a new time step (of this dataset) would appear every five seconds (on average) if the timeline is playing. This trait will only take effect if multiplier is not explicitly set.

ExportableTraits
disableExport boolean

Disable user export functionality

FeatureInfoTraits
featureInfoTemplate FeatureInfoTemplateTraits

A template object for formatting content in feature info panel

featureInfoUrlTemplate string

A template URL string for fetching feature info. Template values of the form {x} will be replaced with corresponding property values from the picked feature.

showStringIfPropertyValueIsNull string

If the value of a property is null or undefined, show the specified string as the value of the property. Otherwise, the property name will not be listed at all.

GroupTraits
excludeMembers string[]

An array of strings of excluded group and item names. A group or item name that appears in this list will not be shown to the user. This is case-insensitive and will also apply to all child/nested groups

isOpen boolean

True if this group is open and its contents are visible; otherwise, false.

members ModelReference

The members of this group.

LayerOrderingTraits
keepOnTop boolean

Keeps the layer on top of all other imagery layers.

supportsReordering boolean true

Does this layer support reordering in the workbench.

MappableTraits
rectangle RectangleTraits

The bounding box rectangle that contains all the data in this catalog item.

disablePreview boolean

Disables the preview on the Add Data panel. This is useful when the preview will be very slow to load.

disableZoomTo boolean true

Disables the zoom to (aka 'Ideal Zoom') button in the workbench.

show boolean true

Show or hide a workbench item. When show is false, a mappable item is removed from the map and a chartable item is removed from the chart panel.

initialMessage InitialMessageTraits

A message to show when the user adds the catalog item to the workbench. Useful for showing disclaimers.

RasterLayerTraits
opacity number 0.8

The opacity of the map layers.

leafletUpdateInterval number

Update a tile only once during this interval when the map is panned. Value should be specified in milliseconds.

tileErrorHandlingOptions TileErrorHandlingTraits

Options for handling tile errors

clipToRectangle boolean true

Gets or sets a value indicating whether this dataset should be clipped to the {@link CatalogItem#rectangle}. If true, no part of the dataset will be displayed outside the rectangle. This property is true by default, leading to better performance and avoiding tile request errors that might occur when requesting tiles outside the server-specified rectangle. However, it may also cause features to be cut off in some cases, such as if a server reports an extent that does not take into account that the representation of features sometimes require a larger spatial extent than the features themselves. For example, if a point feature on the edge of the extent is drawn as a circle with a radius of 5 pixels, half of that circle will be cut off.

SdmxCommonTraits
modelOverrides ModelOverrideTraits[]

This provides ability to override Dataflow dimensions by concept or codelist ID (full URN). For example, setting a default value for a given concept. Codelist overrides take priority over concept overrides. TODO add example

SplitterTraits
splitDirection number

The side of the splitter to display this imagery layer on. Defaults to both sides.

disableSplitter boolean true

If true, splitter funcitonality will be hidden for this model.

TableTraits
showUnmatchedRegionsWarning boolean true

True to show a warning when some of the region IDs in the CSV file could not be matched to a region. False to silently ignore unmatched regions.

columns TableColumnTraits[]

Options for individual columns in the CSV.

defaultColumn TableColumnTraits

The default settings to use for all columns

styles TableStyleTraits[]

The set of styles that can be used to visualize this dataset.

defaultStyle TableStyleTraits

The default style to apply when visualizing any column in this CSV.

activeStyle string

The ID of the currently-selected style.

enableManualRegionMapping boolean

If enabled, there will be controls to set region column and region type.

columnTitles string[]

An optional array of column titles that override the individual TableColumnTraits.title setting.

columnUnits string[]

An optional array of column units that override the individual TableColumnTraits.unit setting.

removeDuplicateRows boolean

If two rows in the table are identical, only retain one copy. This could cause performance issues, and so should be used only when absolutely necessary.

TimeVaryingTraits
currentTime string

The current time at which to show this dataset.

initialTimeSource string start

The initial time to use if Current Time is not specified. Valid values are
* start - the dataset's start time
* stop - the dataset's stop time
* now - the current system time. If the system time is after Stop Time, Stop Time is used. If the system time is before Start Time, Start Time is used.
* none - do not automatically set an initial time
This value is ignored if Current Time is specified.

startTime string

The earliest time for which this dataset is available. This will be the start of the range shown on the timeline control.

stopTime string

The latest time for which this dataset is available. This will be the end of the range shown on the timeline control.

multiplier number

The multiplier to use in progressing time for this dataset. For example, 5.0 means that five seconds of dataset time will pass for each one second of real time.

isPaused boolean true

True if time is currently paused for this dataset, or false if it is progressing.

dateFormat string

A dateformat string (using the dateformat package) used to adjust the presentation of the date in various spots in the UI for a catalog item.
For example, to just show the year set to 'yyyy'. Used in places like the the Workbench Item and Bottom Dock

UrlTraits
url string

The base URL of the file or service.

forceProxy boolean

Force the default proxy to be used for all network requests.

cacheDuration string 1d

The cache duration to use for proxied URLs for this catalog member. If undefined, proxied URLs are effectively cachable forever. The duration is expressed as a Varnish-like duration string, such as '1d' (one day) or '10000s' (ten thousand seconds).

SdmxDimensionTraits

Trait Type Default Description
position string

The position attribute specifies the position of the dimension in the data structure definition, starting at 0. This is important for making sdmx-csv requests

DimensionTraits
id string

Dimension ID

name string

Dimension name (human-readable)

options DimensionOptionTraits[]

Dimension options

selectedId string

Selected Option's ID

allowUndefined boolean

Allow dimension to be undefined

disable boolean

Hides dimension

DimensionOptionTraits

Trait Type Default Description
id string

Option ID

name string

Option name (human-readable)

value any

Value (if this is undefined, id will be used)

InfoSectionTraits

Trait Type Default Description
name string

The name of the section.

content string

The content of the section, in Markdown and HTML format. Set this property to null to remove this section entirely.

contentAsObject any

The content of the section which is a JSON object. Set this property to null to remove this section entirely.

show boolean true

Indicates if this info section showing (not collapsed).

ShortReportTraits

Trait Type Default Description
name string

The name of the section.

content string

The content of the section.

show boolean true

Indicates if this short report section showing.

LegendTraits

Trait Type Default Description
title string

A title to be displayed above the legend.

url string

The URL of the legend image.

imageScaling number 1

Scaling of the legend. For example, a high DPI legend may have scaling = 0.5, so it will be scaled doown 50%

urlMimeType string

The MIME type of the URL legend image.

items LegendItemTraits[]

LegendItemTraits

Trait Type Default Description
title string

The title to display next to this legend item.

multipleTitles string

Multiple titles to display next to this legend item.

maxMultipleTitlesShowed string 10

Maximum number of multiple titles to display next to this legend item. (Default is 10)

titleAbove string

The title to display above this legend item, i.e. marking the top of a box on the legend.

titleBelow string

The title to display below this legend item, i.e. marking the bottom of a box on the legend.

color string

The CSS color to display for this item. This property is ignored if Legend URL is specified.

outlineColor string

The CSS color with which to outline this item.

multipleColors string[]

Multiple colors to show with this item in a grid arrangement.

imageUrl string

The URL of an image to display with this item.

addSpacingAbove boolean

True to add a bit of extra spacing above this item in order to separate it visually from the rest of the legend.

imageHeight number 20

The height of the legend image.

imageWidth number 20

The width of the legend image.

MetadataUrlTraits

Trait Type Default Description
url string

The metadata URL of the file or service.

title string

Title used for metadata URL button.

DataUrlTraits

Trait Type Default Description
type string

Type of data URL. This value will be used to provide context or instruction on how to use the data URL. For example wcs will provide a link to WCS docs. Current supported values are: - wfs = A Web Feature Service (WFS) base URL - wcs = A Web Coverage Service (WCS) base URL - wfs-complete = A complete, ready-to-use link to download features from a WCS server - wcs-complete = A complete, ready-to-use link to download features from a WFS server - direct = Direct URL to dataset (this is the default if no type is specified) - none = Hide data URL

MetadataUrlTraits
url string

The metadata URL of the file or service.

title string

Title used for metadata URL button.

DimensionTraits

Trait Type Default Description
id string

Dimension ID

name string

Dimension name (human-readable)

options DimensionOptionTraits[]

Dimension options

selectedId string

Selected Option's ID

allowUndefined boolean

Allow dimension to be undefined

disable boolean

Hides dimension

LatLonHeightTraits

Trait Type Default Description
latitude number

Latitude in degrees

longitude number

Longitude in degrees

height number

Height above ellipsoid in metres

FeatureInfoTemplateTraits

Trait Type Default Description
name string

A mustache template string for formatting name

template string

A Mustache template string for formatting description

partials any

An object, mapping partial names to a template string. Defines the partials used in Template.

formats any

An object, mapping field names to formatting options.

RectangleTraits

Trait Type Default Description
west number

The westernmost longitude in degrees.

south number

The southernmost longitude in degrees.

east number

The easternmost longitude in degrees.

north number

The northernmost longitude in degrees.

InitialMessageTraits

Trait Type Default Description
title string

The title of the message.

content string

The content of the message.

key string

Identifier. If multiple messages with the same key are triggered, only the first will be displayed.

confirmation boolean

Whether the message requires confirmation.

confirmText string

If confirmation is true, the text to put on the confirmation button.

width number

Width of the message.

height number

Height of the message.

TileErrorHandlingTraits

Trait Type Default Description
thresholdBeforeDisablingItem number

The number of tile failures before disabling the item.

treat403AsError boolean

Indicates whether a 403 response code when requesting a tile should be treated as an error. If false, 403s are assumed to just be missing tiles and need not be reported to the user.

treat404AsError boolean

Indicates whether a 404 response code when requesting a tile should be treated as an error. If false, 404s are assumed to just be missing tiles and need not be reported to the user.

ignoreUnknownTileErrors boolean

A flag indicating whether non-specific (no HTTP status code) tile errors should be ignored. This is a last resort, for dealing with odd cases such as data sources that return non-images (eg XML) with a 200 status code. No error messages will be shown to the user.

ModelOverrideTraits

Trait Type Default Description
id string

Concept ID (full URN form - urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=ABS:CS_C16_COMMON(1.0.0).REGION)

type string

Override concept/dimension type - Possible values are: - 'region': values contain region codes used for region mapping - eg Country code) - 'region-type': values contains region types - eg 'CNT2' which is 2-letter country codes) - 'unit-measure': values should be used to describe primary-measure (eg in chart title) - 'unit-multiplier': multiply primary-measure value by atrtibute values - 'frequency': value used to determine time period frequency (ie. yearly, monthly...)

regionType string

If type has been specified as 'region', you can also manually specify the region type (eg SA2 for ABS Statistical Area 2)

regionTypeReplacements ReplaceStringTraits[]

If type has been specified as 'region' and this dataflow contains multiple regionTypes - you can add a map to correct automatically detected region types. For example: setting regionTypeReplacements = [{find: 'SA1_2016', replace: 'SA1_2011'}] will replace regionType with SA1_2011 if it was SA1_2016

DimensionTraits
name string

Dimension name (human-readable)

options DimensionOptionTraits[]

Dimension options

selectedId string

Selected Option's ID

allowUndefined boolean

Allow dimension to be undefined

disable boolean

Hides dimension

ReplaceStringTraits

Trait Type Default Description
find string

String to find

replace string

String to replace with

TableColumnTraits

Trait Type Default Description
name string

The name of the column.

title string

The displayed title of the column.

units string

The units for the column values.

transformation ColumnTransformationTraits

Transformation to apply to this column

type string

The type of the column. If not specified, the type is guessed from the column's name and values. Valid types are:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • longitude
  • latitude
  • height
  • time
  • scalar
  • enum
  • region
  • text
  • address
  • hidden
regionType string

The type of region referenced by the values in this column. If Type is not defined and this value can be resolved, the column Type will be region.

regionDisambiguationColumn string

The name of the column to use to disambiguate region matches in this column.

replaceWithZeroValues string[]

Values of the column to replace with 0.0, such as -.

replaceWithNullValues string[]

Values of the column to replace with null, such as NA.

format any

The formatting options to pass to toLocaleString when formatting the values of this column for the legend and feature information panels. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString and https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat

ColumnTransformationTraits

Trait Type Default Description
expression string

Transformation expression used to change column values (row-by-row). This uses http://bugwheels94.github.io/math-expression-evaluator . For example x*3 will multiply all column values by 3, x*columnA will multiple this column with columnA (note - columnA must be in dependencies array).

dependencies string[]

Array of column names which are 'injected' in to the expression. For example, to use the expression x*columnA (where columnA is the name of another column), dependencies must include 'columnA'

TableStyleTraits

Trait Type Default Description
id string

The ID of the style.

title string

The human-readable title of the style. Set this to null to remove the style entirely.

legendTitle string

The title to show on the legend. If not specified, Title is used.

regionColumn string

The column to use for region mapping.

latitudeColumn string

The column to use for the latitude of points. If Region Column is specified, this property is ignored.

longitudeColumn string

The column to use for the longitude of points. If Region Column is specified, this property is ignored.

color TableColorStyleTraits

Options for controlling the color of points or regions.

pointSize TablePointSizeStyleTraits

Options for controlling the size of points. This property is ignored for regions.

chart TableChartStyleTraits

Options for controlling the chart created from this CSV.

time TableTimeStyleTraits

Options for controlling how the visualization changes with time.

hidden boolean

Hide style from "Display Variable" drop-down in workbench. It is hidden by default if number of colors (enumColors or numberOfBins) is less than 2 - as a ColorMap with a single color isn't super useful

TableColorStyleTraits

Trait Type Default Description
colorColumn string

The column to use to color points or regions.

nullColor string

The color to use when the value is null, specified as a CSS color string.

regionColor string #02528d

The color to use when the styling the region, specified as a CSS color string.

nullLabel string

The label to use in the legend for null values.

minimumValue number

The minimum value to use when creating ColorMaps. This is only applied for scalar columns.

maximumValue number

The maximum value to use when creating ColorMaps. This is only applied for scalar columns.

numberOfBins number

The number of different colors to bin the data into. This property is ignored if Bin Maximums is specified for a scalar column or Enum Colors is specified for an enum column.

binMaximums number[]

The maximum values of the bins to bin the data into, specified as an array of numbers. The first bin extends from the dataset's minimum value to the first value in this array. The second bin extends from the first value in this array to the second value in this array. And so on. If the maximum value of the dataset is greater than the last value in this array, an additional bin is added automatically. This property is ignored if the Color Column is not a scalar.

binColors string[]

The colors to use for the bins, each specified as a CSS color string. If there are more colors than bins, the extra colors are ignored. If there are more bins than colors, the colors are repeated as necessary.

enumColors EnumColorTraits[]

The colors to use for enumerated values. This property is ignored if the Color Column type is not enum.

colorPalette string

The name of a ColorBrewer palette to use when mapping values to colors. This property is ignored if Bin Colors is defined and has enough colors for all bins, or if Enum Colors is defined. The default value depends on the type of the Color Column and on the data. Scalar columns that cross zero will use the diverging purple-to-orange palette PuOr. Scala columns that do not cross zero will use the sequential Red palette Reds. All other scenarios will use the 21 color HighContrast palette. D3 color schemes are also supported (https://github.com/d3/d3-scale-chromatic) - but without scheme or interpolate string (for example - to use interpolateViridis - set colorPalete = Viridis). This is case seensitive.

legendTicks number

The number of tick marks (in addition to the top and bottom) to show on the legend when the Color Bin Method is set to none and Color Bins is not defined.

legend LegendTraits

The legend to show with this style. If not specified, a suitable is created automatically from the other parameters.

EnumColorTraits

Trait Type Default Description
value string

The enumerated value to map to a color.

color string

The CSS color to use for the enumerated value.

TablePointSizeStyleTraits

Trait Type Default Description
pointSizeColumn string

The column to use to size points.

nullSize number 9

The point size, in pixels, to use when the column has no value.

sizeFactor number 14

The size, in pixels, of the point is: Normalized Value * Size Factor + Size Offset where the Normalized Value is a value in the range 0 to 1 with 0 representing the lowest value in the column and 1 representing the highest.

sizeOffset number 10

The size, in pixels, of the point is: Normalized Value * Size Factor + Size Offset where the Normalized Value is a value in the range 0 to 1 with 0 representing the lowest value in the column and 1 representing the highest.

TableChartStyleTraits

Trait Type Default Description
xAxisColumn string

The column to use as the X-axis.

lines TableChartLineStyleTraits[]

Lines on the chart, each of which is formed by plotting a column as the Y-axis.

TableChartLineStyleTraits

Trait Type Default Description
name string

Chart line name (will replace y-column name).

yAxisColumn string

The column to use as the Y-axis.

yAxisMinimum number

The minimum value to show on the Y axis of the chart.

yAxisMaximum number

The maximum value to show on the Y axis of the chart.

color string

The color of the line. If not specified, a unique color will be assigned automatically.

isSelectedInWorkbench boolean true

The selection state of the line in the workbench.

TableTimeStyleTraits

Trait Type Default Description
timeColumn string

The column that indicates the time of a sample or the start time of an interval.

endTimeColumn string

The column that indicates the end time of an interval.

idColumns string[]

The columns that identify an entity as it changes over time.

isSampled boolean

True if the rows in this CSV correspond to "sampled" data, and so the feature position, color, and size should be interpolated to produce smooth animation of the features over time. If False, then times are treated as the start of discrete periods and feature positions, colors, and sizes are kept constant until the next time. This value is ignored if the CSV does not have both a time column and an ID column.

displayDuration number

Display duration for each row in the table, in minutes.

spreadStartTime boolean

Indicates if start time of feature should be "spread" so that all features are displayed at the earliest time step. This is useful for non-contiguous sensor data. If true, the earliest time step will display the earliest values for all features (eg sensor IDs) - even if the time value is after the earliest time step. This means that at time step 0, all features will be displayed.

spreadFinishTime boolean

Indicates if finish time of feature should be "spread" so that all features are displayed at the latest time step. See also spreadStartTime.