Search results

Maps

Represents the Maps control.

<div id="maps"/>
<script>
  var maps = new Maps();
  maps.appendTo("#maps");
</script>

Properties

annotations

AnnotationModel[]

Options for customizing the annotation of maps.

annotationsModule

Annotations

annotationModule is used to place the any text or images into the maps.

background

string

To configure the background of the maps container.

Defaults to null

baseLayerIndex

number

To configure baseMapIndex of maps. Option to select which layer to be visible.

Defaults to 0

border

BorderModel

Options for customizing the color and width of the maps border.

bubbleModule

Bubble

bubbleModule is used to add bubble to the maps.

centerPosition

Object

To configure the zoom level of maps.

Defaults to { latitude: null, longitude: null}

dataLabelModule

DataLabel

dataLabelModule is used to add datalabel to the maps.

description

string

Description for maps.

Defaults to null

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

format

string

To apply internationalization for maps

Defaults to null

height

string

To configure height of maps.

Defaults to null

highlightModule

Highlight

highlightModule is used to add highlight to the maps.

layers

LayerSettingsModel[]

To configure the layers settings of the maps.

legendModule

Legend

legendModule is used to add legend to the maps.

legendSettings

LegendSettingsModel

To configure the legend settings of the maps.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to undefined

mapsArea

MapsAreaSettingsModel

To customization Maps area

mapsTooltipModule

MapsTooltip

mapsTooltipModule is used to add tooltip to the maps.

margin

MarginModel

Options to customize left, right, top and bottom margins of the maps.

markerModule

Marker

markerModule is used to add marker to the maps.

navigationLineModule is used to add navigationLine to the maps.

projectionType

string

Specifies the ProjectionType for the maps.

Defaults to Mercator

selectionModule

Selection

selectionModule is used to add selection to the maps.

tabIndex

number

TabIndex value for the maps.

Defaults to 1

theme

string

Specifies the theme for the maps.

Defaults to Material

titleSettings

TitleSettingsModel

To configure the title settings of the maps.

useGroupingSeparator

boolean

To enable the separator

Defaults to false

width

string

To configure width of maps.

Defaults to null

zoomModule

Zoom

zoomModule is used to add zoom to the maps.

zoomSettings

ZoomSettingsModel

To configure the zoom settings of the maps.

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

addLayer

To add layer

Parameter Type Description
layer LayerSettingsModel

Returns void

addMarker

To add marker

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

To destroy maps control.

Returns void

export

Handles the export method for chart control.

Returns void

getLocalizedLabel

Gets the localized label by locale keyword.

Returns string

getModuleName

Get component name

Returns string

mapsOnClick

To handle the click event for the maps.

Returns void

mapsOnDoubleClick

To handle the double click event for the maps.

Returns void

panByDirection

To pan the map by specifies the direction

Parameter Type Description
direction string

Returns void

print

Handles the print method for chart control.

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

removeLayer

To remove layer

Parameter Type Description
index number

Returns void

zoomByPosition

To zoom the map by specifies the center position

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

animationComplete

EmitType<IAnimationCompleteEventArgs>

Triggers after the animation completed.

annotationRendering

EmitType<IAnnotationRenderingEventArgs>

Triggers before annotation rendering.

beforePrint

EmitType<IPrintEventArgs>

Triggers before the prints gets started.

bubbleClick

EmitType<IBubbleClickEventArgs>

Triggers event mouse clicking on the maps bubble element.

bubbleMouseMove

EmitType<IBubbleMoveEventArgs>

Triggers event mouse moving on the maps bubble element.

bubbleRendering

EmitType<IBubbleRenderingEventArgs>

Triggers before the maps bubble rendered.

click

EmitType<IMouseEventArgs>

Triggers on clicking the maps.

dataLabelRendering

EmitType<ILabelRenderingEventArgs>

Triggers before the data label get rendered.

doubleClick

EmitType<IMouseEventArgs>

Triggers on double clicking the maps.

itemHighlight

EmitType<ISelectionEventArgs>

Trigger before highlight applied

itemSelection

EmitType<ISelectionEventArgs>

Triggers before selection applied

layerRendering

EmitType<ILayerRenderingEventArgs>

Triggers before the maps layer rendered.

load

EmitType<ILoadEventArgs>

Triggers before maps rendered.

loaded

EmitType<ILoadedEventArgs>

Triggers after maps rendered.

markerClick

EmitType<IMarkerClickEventArgs>

Triggers event mouse clicking on the maps marker element.

markerMouseMove

EmitType<IMarkerMoveEventArgs>

Triggers event mouse moving on the maps marker element.

markerRendering

EmitType<IMarkerRenderingEventArgs>

Triggers before the maps marker rendered.

pan

EmitType<IMapPanEventArgs>

Triggers before panning.

resize

EmitType<IResizeEventArgs>

Triggers on resizing the maps.

rightClick

EmitType<IMouseEventArgs>

Triggers on right clicking the maps.

shapeHighlight

EmitType<IShapeSelectedEventArgs>

Triggers before highlight applied for shape

shapeRendering

EmitType<IShapeRenderingEventArgs>

Triggers before the maps shape rendered.

shapeSelected

EmitType<IShapeSelectedEventArgs>

Triggers while clicking the shape

tooltipRender

EmitType<ITooltipRenderEventArgs>

Triggers before the maps tooltip rendered.

zoom

EmitType<IMapZoomEventArgs>

Triggers before zoom in or zoom out.