Interface ICreateRuntimeMap

A command that creates a runtime map from the given Map Definition

Inherited Members

ICommand.Parent

Namespace: OSGeo.MapGuide.MaestroAPI.Commands

Assembly: OSGeo.MapGuide.MaestroAPI.dll

Syntax

public interface ICreateRuntimeMap : ICommand

Properties

IconFormat

The icon image format (default: PNG)

Declaration

string IconFormat { get; set; }

Property Value

Type	Description
System.String

IconHeight

The height of each inline icon that will be rendered (default: 16)

Declaration

int IconHeight { get; set; }

Property Value

Type	Description
System.Int32

IconsPerScaleRange

The number of icons to render inline (as base64 images) per scale range in each layer of the map

Declaration

int IconsPerScaleRange { get; set; }

Property Value

Type	Description
System.Int32

IconWidth

The width of each inline icon that will be rendered (default: 16)

Declaration

int IconWidth { get; set; }

Property Value

Type	Description
System.Int32

MapDefinition

The resource id of the Map Definition to create a Runtime Map from

Declaration

string MapDefinition { get; set; }

Property Value

Type	Description
System.String

RequestedFeatures

A bitmask specifying what pieces of information to include in the CREATERUNTIMEMAP response. Use the OSGeo.MapGuide.MaestroAPI.Commands.RuntimeMapRequest to determine what valid values you can use.

Declaration

int RequestedFeatures { get; set; }

Property Value

Type	Description
System.Int32

TargetMapName

The name to assign to the created runtime map. If null, then MapGuide will auto-generate one based on the Map Definition ID

Declaration

string TargetMapName { get; set; }

Property Value

Type	Description
System.String

Methods

Execute()

Executes the request and returns the structure of the created runtime map

Declaration

IRuntimeMapInfo Execute()

Returns

Type	Description
IRuntimeMapInfo	The structure of the runtime map