Back to Devexpress

TdxCustomMapControl Class

vcl-dxmapcontrol-eb949c5c.md

latest7.4 KB
Original Source

TdxCustomMapControl Class

The base class for the Map Control.

Declaration

delphi
TdxCustomMapControl = class(
    TcxControl,
    IdxScreenTipProvider
)

Remarks

The VCL Map Control (TdxMapControl) allows you to create interactive map interfaces in an application, add image and text overlays, build routes, and pinpoint specific locations.

Main API Members

The list below outlines key members of the TdxCustomMapControl class. These members allow you to manage map layers and data providers, as well as configure UI elements and user interaction options.

Appearance and Behavior Options

BorderStyleSpecifies if the skin-dependent border is visible.ColorSpecifies the background color.LookAndFeelProvides access to look & feel settings.NavigationPanelProvides access to Navigation Panel settings.OnCenterPointChanged | OnZoomLevelChangedAllow you to respond to map zoom and pan operations.OnCenterPointChanging | OnZoomLevelChangingAllow you to prevent map zoom and pan operations depending on certain conditions in your application.OnSelectionChangedAllow you to respond to map item selection changes.OnSelectionChangingAllows you to prevent users from selecting or deselecting certain map items.OptionsBehaviorProvides access to user interaction options.

Map Layer Management Options

AddImageTileLayer | AddItemFileLayer | AddItemLayerCreate a new map layer of the corresponding type.InformationProviders

Provides access to the collection of auxiliary information providers.

Information providers complement a tile data provider associated with a map image layer and allow you to display additional map-related information, such as routes and addresses.

Layers

Provides access to the map layer collection.

Tip

Map layer indexes in the collection also determine the Z-order (draw order) of corresponding layers. A map layer with the highest index is displayed on top of all other layers.

We recommend that you display the most transparent layers on top (map item layers with markers, for example).

Map Item Selection Management Options

ClearSelectionDeselects all map items.DeselectDeselects an individual map item.SelectSelects or deselects an individual map item.SelectedMapItemCountReturns the number of selected map items.SelectedMapItemsProvides indexed access to individual selected map items.

Map Zoom and Pan Options

ActualCenterPointReturns a geographical point that corresponds to the displayed map’s center.ActualZoomLevelReturns the current map zoom level.CenterPointSpecifies the map center. You can use this property to pan the displayed map.Zoom | ZoomAsync | ZoomIn | ZoomLevel | ZoomOut | ZoomToFitItems | ZoomToFitLayerItems | ZoomToGeoRectZoom the displayed map in or out.

General-Purpose API Members

AssignCopies settings between Map Controls.BeginUpdate | EndUpdateAllow you to avoid excessive server queries and redraw operations during batch map setting changes.IsLockedIdentifies if Map Control updates are disabled.

To see the VCL Map Control in action, run the Mapping demo in the VCL Demo Center installed with compiled DevExpress demos. Click items listed in the sidebar to switch between individual demos that highlight different Map Control features.

Download: Compiled VCL Demos

Tip

Compiled DevExpress demos ship with source code installed in the Public Documents folder (%Public%) for all users ( default ). You can find all project and source code files for the Map Control demo in the following folder:

%Public%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressMapControl

Terminal TdxCustomMapControl Class Descendant

Do not use the TdxCustomMapControl class directly. Use TdxMapControl instead.

Implements

IdxScreenTipProvider

Inheritance

TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TdxCustomMapControl

See Also

TdxCustomMapControl Members

dxMapControl Unit