Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICreateRuntimeMapOptions

Describes options for creating a runtime map

export
interface

ICreateRuntimeMapOptions

extends

{IAuthenticatedRequest}

Hierarchy

Index

Properties

Optional iconFormat

iconFormat: "PNG" | "PNG8" | "GIF" | "JPG"

The image format for requested icons

type

{("PNG" | "PNG8" | "GIF" | "JPG")}

memberof

ICreateRuntimeMapOptions

Optional iconHeight

iconHeight: undefined | number

The height of requested icons

type

{number}

memberof

ICreateRuntimeMapOptions

Optional iconWidth

iconWidth: undefined | number

The width of requested icons

type

{number}

memberof

ICreateRuntimeMapOptions

Optional iconsPerScaleRange

iconsPerScaleRange: undefined | number

If requesting icons, the number of icons per scale range

type

{number}

memberof

ICreateRuntimeMapOptions

mapDefinition

mapDefinition: Common.ResourceIdentifier

The map definition id

type

{Common.ResourceIdentifier}

memberof

ICreateRuntimeMapOptions

Optional password

password: undefined | string

The password

type

{string}

memberof

IAuthenticatedRequest

requestedFeatures

requestedFeatures: number | RuntimeMapFeatureFlags.LayersAndGroups | RuntimeMapFeatureFlags.LayerIcons | RuntimeMapFeatureFlags.LayerFeatureSources

A bitmask indicating what data to return

type

{(number | RuntimeMapFeatureFlags)}

memberof

ICreateRuntimeMapOptions

Optional session

session: undefined | string

The session id

type

{string}

memberof

IAuthenticatedRequest

Optional targetMapName

targetMapName: undefined | string

The target map name to assign. Otherwise the map name will be computed from the map definition id

type

{string}

memberof

ICreateRuntimeMapOptions

Optional username

username: undefined | string

The username

type

{string}

memberof

IAuthenticatedRequest

Generated using TypeDoc