Skip to content

SocrataCatalogGroup

"type": "socrata-group"

SocrataCatalogGroupTraits

Trait Type Default Description
facetGroups string[] tags,categories

Facets to include in group structure. By default, tags and categories will be used,

facetFilters FacetFilterTraits[]

Facets (key/value pairs) to use to filter datasets.

filterQuery any [object Object]

Gets or sets the filter query to pass to Socrata when querying the available data sources and their groups.

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.

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.

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

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).

FacetFilterTraits

Trait Type Default Description
name string

Name of facet

value string

Value of facet to use as filter

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

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)