ArcGisImageServerCatalogItem

Example usage

{
  "url": "https://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer",
  "type": "esri-imageServer",
  "name": "CharlotteLAS"
}

ArcGisImageServerCatalogItemTraits

Trait	Type	Default	Description
`maximumScale`	`number`		Gets or sets the denominator of the largest scale (smallest denominator) for which tiles should be requested. For example, if this value is 1000, then tiles representing a scale larger than 1:1000 (i.e. numerically smaller denominator, when zooming in closer) will not be requested. Instead, tiles of the largest-available scale, as specified by this property, will be used and will simply get blurier as the user zooms in closer. Note: maximumLevel overrides this property.
`parameters`	`any`		Additional parameters to pass to the ImageServer when requesting images.
`tokenUrl`	`string`		URL to use for fetching request tokens
`token`	`string`		Token to use for fetching request tokens (if not using tokenUrl)
`maxRefreshIntervals`	`number`	`10000`	The maximum number of discrete times that can be created by a single date range when layer in time-enabled.
`wkid`	`number`	`102100`	The well-known ID of the spatial reference of the image server. Only Web Mercator (102100 or 102113 or 3857) and WGS84 (4326) are supported.
`usePreCachedTiles`	`boolean`		If true, the server's pre-cached tiles are used. If false, then the ImageServer exportImage endpoint will be used. This will default to false if parameters (including time) have been specified, otherwise it will default to true if a server supports pre-cached tiles.
`bandIds`	`number[]`		The band IDs to use when requesting images.
`renderingRule`	`ArcGisImageServerRenderingRule`		The rendering rule to apply to the image service. This must be a JSON object - for example `{"rasterFunction": "RFTAspectColor"}`. Note `allowRasterFunction` must be true for this to be applied.
`allowRasterFunction`	`boolean`		If true, then the renderingRule will be applied to the image service. If false, the renderingRule will be ignored. This will default to true if an image service supports raster functions.
`availableRasterFunctions`	`ArcGisImageServerAvailableRasterFunctionTraits[]`		The available raster functions for the ImageServer. Defaults to all raster functions in the service if the server supports raster functions. Note: `allowRasterFunction` must be true. To set the default raster function, use the `renderingRule` property.
`disableRasterFunctionSelectors`	`boolean`		When true, disables the dimension selectors in the workbench. This will default to true if the server does not support raster functions.
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.
`hideDefaultDescription`	`boolean`		If true, then no generic default description will be displayed if `description` is undefined.
`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 defining 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
`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`	`EnumDimensionTraits[]`		This provides ability to set model JSON through SelectableDimensions (a dropdown). When an option is selected, the `value` property will be used to call `updateModelFromJson()`. All string properties support Mustache templates (with the catalog member as context)
`disableAboutData`	`boolean`		Disables the 'About Data' button in the workbench.
`shareable`	`boolean`	`true`	True (default) if this catalog member may be included in share links. False to exclude it from share links.
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`		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.
FeaturePickingTraits
`allowFeaturePicking`	`boolean`	`true`	Indicates whether features in this catalog item can be selected by clicking them on the map.
ImageryProviderTraits
`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.
`minimumLevel`	`number`		The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems
`maximumLevel`	`number`		The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit
`tileWidth`	`number`	`256`	Tile width in pixels. Default value is 256 pixels
`tileHeight`	`number`	`256`	Tile height in pixels. Default value is 256 pixels
LayerOrderingTraits
`keepOnTop`	`boolean`		Keeps the layer on top of all other imagery layers.
`supportsReordering`	`boolean`	`true`	Does this layer support reordering in the workbench.
LegendOwnerTraits
`legends`	`LegendTraits[]`		The legends to display on the workbench.
`legendBackgroundColor`	`string`		Apply background color to all legends. This can be useful if legends are transparent and clash with Terria colours
`hideLegendInWorkbench`	`boolean`		Whether the legend is hidden in the workbench for this catalog member.
MappableTraits
`rectangle`	`RectangleTraits`		The bounding box rectangle that contains all the data in this catalog item.
`idealZoom`	`IdealZoomTraits`		Override default ideal zoom if the given values are valid.
`disablePreview`	`boolean`		Disables the preview on the Add Data panel. This is useful when the preview will be very slow to load.
`disableZoomTo`	`boolean`		Disables the zoom to (aka 'Ideal Zoom') button in the workbench.
`zoomOnAddToWorkbench`	`boolean`		Zoom to dataset when added to workbench. Doesn't work if `disableZoomTo` is true.
`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.
`featureInfoTemplate`	`FeatureInfoTemplateTraits`		A template object for formatting content in feature info panel
`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.
`maximumShownFeatureInfos`	`number`		The maximum number of "feature infos" that can be displayed in feature info panel.
MinMaxLevelTraits
`maxScaleDenominator`	`number`		The denominator of the smallest scale (largest denominator) for which tiles should be requested. For example, if this value is 10000, then tiles representing a scale smaller than 1:10000 (i.e. numerically larger denominator, when zooming out further) will not be requested. For large scales set hideLayerBeforeMaxScaleDenominator to true, otherwise you may experience performance issues (requesting too many tiles).
`minScaleDenominator`	`number`		The denominator of the largest scale (smallest denominator) for which tiles should be requested. For example, if this value is 1000, then tiles representing a scale larger than 1:1000 (i.e. numerically smaller denominator, when zooming in closer) will not be requested. Instead, tiles of the largest-available scale, as specified by this property, will be used and will simply get blurier as the user zooms in closer.
`hideLayerAfterMinScaleDenominator`	`boolean`		True to hide tiles when the `Minimum Scale Denominator` is exceeded. If false, we can zoom in arbitrarily close to the (increasingly blurry) layer.
`scaleWorkbenchInfo`	`string`		The message to show to the user when this dataset is not visible due to scale.
OpacityTraits
`opacity`	`number`	`0.8`	The opacity of the item.
`disableOpacityControl`	`boolean`		When true, the user will be unable to change the opacity of the item
SplitterTraits
`splitDirection`	`number`		The side of the splitter to display this imagery layer on. Defaults to both sides.
`disableSplitter`	`boolean`		If true, splitter funcitonality will be hidden for this model.
TimeVaryingTraits
`timeLabel`	`string`		Time label which is shown in workbench next to date/time selector (Will default to t("dateTime.selectorLabel") = "Time:").
`currentTime`	`string`	`2024-11-22T01:09:29.817000000Z`	The current time at which to show this dataset.
`initialTimeSource`	`string`	`now`	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`		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).

ArcGisImageServerRenderingRule

Trait	Type	Description
`rasterFunction`	`string`	The name of the raster function.
`variableName`	`string`	optional for well known functions, default is "Raster" for raster function templates.
`rasterFunctionArguments`	`any`	Overwrite the raster function default configuration by specifying argument parameters (argument names and value types are defined by the author of each raster function template and are not discoverable through ArcGis REST API).

ArcGisImageServerAvailableRasterFunctionTraits

Trait	Type	Description
`name`	`string`	The name of the raster function.
`description`	`string`	The description of the raster function.
`help`	`string`	Help text for the raster function

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.

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

EnumDimensionTraits

Trait	Type	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	Description
`id`	`string`	Option ID
`name`	`string`	Option name (human-readable)
`value`	`any`	Value (if this is undefined, `id` will be used)

TileErrorHandlingTraits

Trait	Type	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.

LegendTraits

Trait	Type	Default	Description
`title`	`string`		A title to be displayed above the legend.
`url`	`string`		The URL of the legend image. If the URL suffix isn't one of the following `png\|jpg\|jpeg\|gif\|svg`, then `urlMimeType` must be defined - otherwise a hyperlink will be shown.
`imageScaling`	`number`	`1`	Scaling of the legend. For example, a high DPI legend may have scaling = `0.5`, so it will be scaled down 50%
`urlMimeType`	`string`		The MIME type of the `URL` legend image. For example `"image/png"`
`items`	`LegendItemTraits[]`
`backgroundColor`	`string`		Apply background color to entire legend. This can be useful if legend is transparent and clashes with Terria colours. This will override `legendBackgroundColor`.

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.
`outlineWidth`	`number`		The width of outline in pixels
`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.
`marker`	`string`		Maki marker ID to display with this item (eg "circle").
`rotation`	`number`		The degrees to rotate legend 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.

RectangleTraits

Trait	Type	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.
CameraTraits
`position`	`VectorTraits`	Position of the camera in the Earth-centered Fixed frame in meters.
`direction`	`VectorTraits`	The look direction of the camera in the Earth-centered Fixed frame.
`up`	`VectorTraits`	The up vector direction of the camera in the Earth-centered Fixed frame.

VectorTraits

Trait	Type	Description
`x`	`number`	X component of vector in the Earth-centered Fixed frame.
`y`	`number`	Y component of vector in the Earth-centered Fixed frame.
`z`	`number`	Z component of vector in the Earth-centered Fixed frame.

IdealZoomTraits

Trait	Type	Default	Description
`lookAt`	`LookAtTraits`		Parameters for camera to look at a target.
`camera`	`CameraTraits`		Use camera position, direction and up if fully defined. Otherwise use rectangle if fully defined.

LookAtTraits

Trait	Type	Default	Description
`targetLongitude`	`number`		Target longitude on the WGS84 ellipsoid in degrees
`targetLatitude`	`number`		Target latitude on the WGS84 ellipsoid in degrees
`targetHeight`	`number`	`100`	Target height in meters. Treat it as camera height. A positive value is above the WGS84 ellipsoid. Default to 100 meters.
`heading`	`number`		Heading in degrees. Treat it as camera bearing. North is 0. A positive value rotates clockwise, negative anti-clockwise. Default to 0.
`pitch`	`number`	`45`	Pitch in degrees. Treat it as camera pitch. A positive value is to look down, negative up. Default to 45.
`range`	`number`	`500`	The range in meters. It is the distance between the target position and camera position projected onto the local plane. Not negative and default to 500.

CameraTraits

Trait	Type	Description
`position`	`VectorTraits`	Position of the camera in the Earth-centered Fixed frame in meters.
`direction`	`VectorTraits`	The look direction of the camera in the Earth-centered Fixed frame.
`up`	`VectorTraits`	The up vector direction of the camera in the Earth-centered Fixed frame.
RectangleTraits
`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	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.

FeatureInfoTemplateTraits

Trait	Type	Description
`name`	`string`	A mustache template string for formatting name
`template`	`string`	A Mustache template string for formatting description
`showFeatureInfoDownloadWithTemplate`	`boolean`	Show feature info download if a `template` has been provided. If no `template` is provided, then download will always show.
`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.