types | References | ArcGIS Maps SDK for JavaScript

Types

import type { Theme, SchemeOutline, ColorSchemeForPoint, ColorSchemeForPolyline, ColorSchemeForPolygon } from "@arcgis/core/smartMapping/symbology/types.js";

Type definitions

Theme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Describes a theme that pairs well with the given basemaps. See the table below for more details of the properties in this object.

basemaps

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The Esri basemaps that pair well with the given theme.

description

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Text describing the theme in the UI.

label

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The label identifying the theme in UI elements.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the theme.

SchemeOutline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The outline color of the symbol.

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The width of the symbol in pixels or points.

ColorSchemeForPoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize point features with attribute data-driven color.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique id of the color scheme to use in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below.

Value	Description	Example
high-to-low	High values are emphasized with strong colors.
above-and-below	Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors.
centered-on	Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors.
extremes	High and low values are emphasized with strong colors. All others are visualized with weak colors.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The continuous color ramp that will be applied to the visualization.

colorsForClassBreaks

Property

Type: ColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Predefined classed color schemes to use for the visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the symbol used to indicate features with no data and features that are out of range.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the symbol.

size

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default size of the symbol in pixels or points.

ColorSchemeForPolyline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize polyline features with attribute data-driven color.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique id of the color scheme to use in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below.

Value	Description	Example
high-to-low	High values are emphasized with strong colors.
above-and-below	Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors.
centered-on	Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors.
extremes	High and low values are emphasized with strong colors. All others are visualized with weak colors.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The continuous color ramp that will be applied to the visualization.

colorsForClassBreaks

Property

Type: ColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Predefined classed color schemes to use for the visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the symbol used to indicate features with no data and features that are out of range.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol.

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default width of the symbol in pixels or points.

ColorSchemeForPolygon

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize polygon features with attribute data-driven color.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique id of the color scheme to use in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below.

Value	Description	Example
high-to-low	High values are emphasized with strong colors.
above-and-below	Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors.
centered-on	Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors.
extremes	High and low values are emphasized with strong colors. All others are visualized with weak colors.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The continuous color ramp that will be applied to the visualization.

colorsForClassBreaks

Property

Type: ColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Predefined classed color schemes to use for the visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the symbol used to indicate features with no data and features that are out of range.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the symbol.

ColorSchemeForMesh

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize mesh features with attribute data-driven color.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique id of the color scheme to use in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates which values will be emphasized in the continuous ramp and the map. Possible values are listed below.

Value	Description	Example
high-to-low	High values are emphasized with strong colors.
above-and-below	Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors.
centered-on	Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors.
extremes	High and low values are emphasized with strong colors. All others are visualized with weak colors.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The continuous color ramp that will be applied to the visualization.

colorsForClassBreaks

Property

Type: ColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Predefined classed color schemes to use for the visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the symbol used to indicate features with no data and features that are out of range.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol.

ColorScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize features with attribute data-driven color.

Type: ColorSchemeForPoint | ColorSchemeForPolyline | ColorSchemeForPolygon | ColorSchemeForMesh

ColorsForClassBreak

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of hex color strings. Each color is assigned to a specific break in classed color visualizations.

numClasses

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The number of classes or colors used in the ramp of discrete colors.

ColorSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: ColorScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The color scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: ColorScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional color schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

SizeSchemeForPoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize point features driven by attribute data.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill color of the marker symbol.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the marker symbol used to indicate features with no data and features that are out of range.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the marker symbol.

size

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default size of the marker symbol in pixels or points.

noDataSize

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The size of the marker symbol (in pixels or points) used to indicate features with no data and features that are out of range.

minSize

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The minimum size of a marker symbol in pixels or points representing features with low data values.

maxSize

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The maximum size of a marker symbol in pixels or points representing features with high data values.

opacity

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the marker symbol.

SizeSchemeForPolyline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize polyline features driven by attribute data.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the line symbol.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the line symbol used to indicate features with no data and features that are out of range.

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default width of the line symbol in pixels or points.

noDataWidth

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The width of the line symbol in pixels or points used to indicate features with no data and features that are out of range.

minWidth

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The minimum width of a line symbol in pixels or points representing features with low data values.

maxWidth

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The maximum width of a line symbol in pixels or points representing features with high data values.

opacity

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the line symbol.

SizeSchemeForPolygon

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize polygon features driven by attribute data. When visualized by size, polygons are represented with marker symbols.

opacity

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol.

marker

Property

Type: SizeSchemeForPoint

Since: ArcGIS Maps SDK for JavaScript 5.0

The scheme defining the symbology of the marker symbol used to represent polygon features by size.

background

Property

Type: SizeSchemeForPolygonBackground

Since: ArcGIS Maps SDK for JavaScript 5.0

The schema defining the backgound symbol of the feature. This is a fill symbol.

SizeSchemeForPolygonBackground

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol representing the polygon.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the background fill symbol.

SizeScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize features with attribute data-driven size.

Type: SizeSchemeForPoint | SizeSchemeForPolyline | SizeSchemeForPolygon

SizeSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: SizeScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The size scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: SizeScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional size schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

LocationSchemeForPoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the location-only symbology scheme used to visualize point features.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill color of the marker symbol.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the marker symbol.

size

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The size of the marker symbol in pixels or points.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the marker symbol.

LocationSchemeForPolyline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the location-only symbology scheme used to visualize polyline features.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the line symbol.

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The width of the line symbol in pixels or points.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the line symbol.

LocationSchemeForPolygon

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the location-only symbology scheme used to visualize polygon features.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the fill symbol.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the fill symbol.

LocationSchemeForMesh

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the location-only symbology scheme used to visualize mesh features.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the fill symbol.

LocationScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type.

Type: LocationSchemeForPoint | LocationSchemeForPolyline | LocationSchemeForPolygon | LocationSchemeForMesh

LocationSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: LocationScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The location scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: LocationScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional location schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

TypeSchemeForPoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize point features driven by type-based attribute data.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The theme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the point symbols comprising the theme.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the point symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the point symbol.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the marker symbol.

size

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default size of the point symbol in pixels, points, or real-world units.

TypeSchemeForPolyline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The theme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The colors of the line symbols comprising the theme.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the line symbol used to indicate features with no data and features that are out of range.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the line symbol (0 - 1).

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default width of the line symbol in pixels or points.

TypeSchemeForPolygon

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The theme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the symbols comprising the theme.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol (0 - 1).

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the fill symbol.

TypeSchemeForMesh

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The theme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the symbols comprising the theme.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol (0 - 1).

PointCloudClassScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize point clouds.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The theme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the point symbols comprising the theme.

TypeSchemeForGeometry

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: TypeSchemeForPoint | TypeSchemeForPolyline | TypeSchemeForPolygon | TypeSchemeForMesh

TypeScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize features with attribute data-driven types.

Type: TypeSchemeForGeometry | PointCloudClassScheme

TypeSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: TypeScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The type scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: TypeScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional type schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

HeatmapScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize point features as a heatmap.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique id of the color scheme to usee in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

A continuous color ramp used to construct a heatmap.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the heatmap.

HeatmapSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: HeatmapScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The heatmap color scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: HeatmapScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional heatmap color schemes that may be used to visualize data overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

PredominanceSchemeForPoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize predominance for point features.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the point symbols used for each category.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the point symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the point symbol (0 - 1).

sizeScheme

Property

Type: SizeSchemeForPoint

Since: ArcGIS Maps SDK for JavaScript 5.0

The scheme defining the size visual variable if included in a predominance visualization.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the marker symbol.

PredominanceSchemeForPolyline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize predominance for polyline features.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The colors of the line symbols used for each category.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the line symbol used to indicate features with no data and features that are out of range.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the line symbol (0 - 1).

sizeScheme

Property

Type: SizeSchemeForPolyline

Since: ArcGIS Maps SDK for JavaScript 5.0

The scheme defining the size visual variable if included in a predominance visualization.

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default width of the line symbol in pixels or points.

PredominanceSchemeForPolygon

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize predominance for polygon features.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the polygon symbols used for each category.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol (0 - 1).

sizeScheme

Property

Type: SizeSchemeForPolygon

Since: ArcGIS Maps SDK for JavaScript 5.0

The scheme defining the size visual variable if included in a predominance visualization.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the fill symbol.

PredominanceSchemeForMesh

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize predominance for mesh features.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the mesh symbols used for each category.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol (0 - 1).

PredominanceScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the symbology scheme used to visualize predominance based on the layer's geometry type.

Type: PredominanceSchemeForPoint | PredominanceSchemeForPolyline | PredominanceSchemeForPolygon | PredominanceSchemeForMesh

PredominanceSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: PredominanceScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The predominance scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: PredominanceScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional predominance schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

RelationshipSchemeForPoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID uniquely identifying the color scheme.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colorsForClassBreaks

Property

Type: RelationshipColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the colors to use in each bin of the relationship visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the point symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the point symbol (0 - 1).

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the marker symbol.

size

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The size of the point symbol in points.

RelationshipSchemeForPolyline

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID uniquely identifying the color scheme.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colorsForClassBreaks

Property

Type: RelationshipColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the colors to use in each bin of the relationship visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the line symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the line symbol (0 - 1).

width

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The width of the line symbol in points.

RelationshipSchemeForPolygon

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID uniquely identifying the color scheme.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colorsForClassBreaks

Property

Type: RelationshipColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the colors to use in each bin of the relationship visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the fill symbol (0 - 1).

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the fill symbol.

RelationshipSchemeForMesh

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID uniquely identifying the color scheme.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colorsForClassBreaks

Property

Type: RelationshipColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the colors to use in each bin of the relationship visualization.

noDataColor

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the fill symbol used to indicate features with no data.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the fill symbol (0 - 1).

RelationshipScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type.

Type: RelationshipSchemeForPoint | RelationshipSchemeForPolyline | RelationshipSchemeForPolygon | RelationshipSchemeForMesh

RelationshipColorsForClassBreak

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

colors

Property

Type: Color[][]

Since: ArcGIS Maps SDK for JavaScript 5.0

The fill colors of the symbols used for each bin in the relationship visualization.

numClasses

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The number of breaks (rows/columns) for each variable in the relationship visualization.

RelationshipSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: RelationshipScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The relationship scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: RelationshipScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional relationship schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

DotDensityScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the symbology scheme used to visualize predominance for polygon features.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The dot color for each attribute.

opacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The opacity of the symbol (0 - 1).

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the symbol.

DotDensitySchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: DotDensityScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The dot density scheme best suited for the given basemap and geometry type.

secondarySchemes

Property

Type: DotDensityScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional dot density schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

PieChartScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties defining the colors and schemes used to visualize pie charts.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the color scheme.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The colors used to visualize pie slices in the chart.

colorForOthersCategory

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The color of the "others" category.

sizeScheme

Property

Type: SizeScheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The scheme defining the size visual variable used to vary chart size per feature.

outline

Property

Type: SchemeOutline

Since: ArcGIS Maps SDK for JavaScript 5.0

Properties for defining the outline of the pie chart.

size

Property

Type: string | number

Since: ArcGIS Maps SDK for JavaScript 5.0

The default size of the pie charts in points or pixels.

PieChartSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: PieChartScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggest default chart scheme based on the given basemap.

secondarySchemes

Property

Type: PieChartScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional chart schemes that may be used to visualize data overlaid on the given basemap.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

FlowScheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Suggested property values for defining the scheme used to visualize flow lines.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique id of the color scheme to use in the visualization. The id is assigned based on the following template: <themeName>/<basemapName>/<schemeName>.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the scheme.

theme

Property

Type: "flow-line" | "wave-front"

Since: ArcGIS Maps SDK for JavaScript 5.0

Determines how flow lines will render. Possible values are listed below.

Value	Description	Example
flow-line	Renders the uv and magnitude data as animated flow lines. This is ideal for representing wind and other atmospheric data.
wave-front	Renders UV and magnitude data in a wave-like animation. This theme works well for ocean data.

Known Limitations

The wave-front flow theme is not supported in 3D SceneView.

color

Property

Type: Color

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested color of the flow lines if a color visual variable is not desired.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested colors to use if a ColorVariable is set on the flow renderer.

density

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested FlowRenderer.density of the streamlines.

flowSpeed

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested FlowRenderer.flowSpeed of the streamlines.

trailLength

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested length of the streamlines.

trailWidth

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested width of the streamlines.

trailCap

Property

Type: "butt" | "round"

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested cap style of the streamlines.

Known Limitations

The round trail cap is not supported in 3D SceneView.

layerEffect

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested ImageryTileLayer.effect to apply to the input layer.

Known Limitations

The layer effects are not supported in 3D SceneView.

minSize

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested size to apply to small magnitude values if a SizeVariable is set on the flow renderer.

maxSize

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested size to apply to large magnitude values if a SizeVariable is set on the flow renderer.

minOpacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested opacity to apply to small magnitude values if an OpacityVariable is set on the flow renderer.

maxOpacity

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The suggested opacity to apply to large magnitude values if an OpacityVariable is set on the flow renderer.

FlowSchemes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The return object of the getSchemes() method.

primaryScheme

Property

Type: FlowScheme

Since: ArcGIS Maps SDK for JavaScript 5.0

The flow scheme best suited for the given basemap.

secondarySchemes

Property

Type: FlowScheme[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional flow schemes that may be used to visualize streamlines overlaid on the given basemap or basemap theme.

basemapId

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The ID of the basemap associated with the given schemes.

basemapTheme

Property

Type: BasemapTheme | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the average basemap color is light or dark.

BasemapTheme

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "light" | "dark"

ColorRamp

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines a ramp of colors to use for visualizing data in a chart, Renderer, or ColorVariable.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The unique name of the color ramp.

colors

Property

Type: Color[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of five colors intended for displaying a continuous color ramp.

colorsForClassBreaks

Property

Type: ColorsForClassBreak[]

Since: ArcGIS Maps SDK for JavaScript 5.0

Contains an array of ramps ranging in size from 1 color to 10 colors. All ramps are part of the same color scheme, but provide a different number of colors depending on the requirements of the ramp needed for the visualization.