MapServerInfo

A class that provides read-only information about a map (data frame) in a map service.

Property

Type

Description

BackgroundColor

Color

The background color of the map that is displayed behind features in the map.

BackgroundSymbol

FillSymbol

The background fill symbol which displays the background color.

Bookmarks

MapServerBookmark[]

The predefined, named extents.

CopyrightText

string

The text information on map content ownership.

DefaultMapDescription

MapDescription

The default description of a map. The MapDescription can be altered to change map properties on the fly.

DefaultTimeStepInterval

double

The default setting for the time step interval.

DefaultTimeStepIntervalSpecified

bool

Indicates if DefaultTimeStepInterval is specified.

DefaultTimeStepIntervalUnits

esriTimeUnits

The time units of the time step interval is measured

DefaultTimeStepIntervalUnitsSpecified

bool

Indicates if DefaultTimeStepIntervalUnits is specified.

DefaultTimeWindow

double

The default setting for the time window.

DefaultTimeWindowSpecified

bool

Indicates if DefaultTimeWindow is specified.

Description

string

The text information on the content of the map.

Extent

Envelope

The default extent of the map.

FullExtent

Envelope

Full extent of the map. The full extent of the map can either be the combined extent of all layers within the map or a custom full extent set by on the data frame (map).

FullTimeExtent

TimeExtent

The time extent of interest for which the map was authored.

MapLayerInfos

MapLayerInfo[]

A list of read-only information about each layer in a map.

Name

string

The name of the map.

SpatialReference

SpatialReference

The default spatial reference of the map.

StandaloneTableDescriptions

StandaloneTableDescription[]

Standalone table objects belonging to the map.

StandaloneTableInfos

StandaloneTableInfo[]

Standalone table info objects belonging to the map.

SupportsDynamicLayers

bool

Indicates if this server supports per-request modification to layer properties.

SupportedImageReturnTypes

esriImageReturnType

The supported types for returning map images.

Units

esriUnits

The default map units of the map.

Remarks

SupportsDynamicLayers

It returns the value of enableDynamicLayers property set in a service configuration.

When this is true, the MapServer supports the following capabilities:

  • modify layer's renderer
  • change layer order
  • add new layers dynamically from registered workspace
  • add or modify layer/table joins
2/28/2020