Class MapsBuilder

Inheritance
System.Object
ControlBuilder
MapsBuilder
Inherited Members
Namespace: Syncfusion.EJ2.Maps
Assembly: Syncfusion.EJ2.dll
Syntax
public class MapsBuilder : ControlBuilder

Constructors

MapsBuilder()

Declaration
public MapsBuilder()

MapsBuilder(Maps)

Declaration
public MapsBuilder(Maps model)
Parameters
Type Name Description
Maps model

Fields

model

Declaration
public Maps model
Field Value
Type Description
Maps

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

AllowImageExport(Boolean)

Enables or disables the export to image functionality in maps.

Declaration
public MapsBuilder AllowImageExport(bool allowImageExport = true)
Parameters
Type Name Description
System.Boolean allowImageExport
Returns
Type Description
MapsBuilder

AllowPdfExport(Boolean)

Enables or disables the export to PDF functionality in maps.

Declaration
public MapsBuilder AllowPdfExport(bool allowPdfExport = true)
Parameters
Type Name Description
System.Boolean allowPdfExport
Returns
Type Description
MapsBuilder

AllowPrint(Boolean)

Enables or disables the print functionality in maps.

Declaration
public MapsBuilder AllowPrint(bool allowPrint = true)
Parameters
Type Name Description
System.Boolean allowPrint
Returns
Type Description
MapsBuilder

AnimationComplete(String)

Triggers after the animation is completed in the maps.

Declaration
public MapsBuilder AnimationComplete(string animationComplete)
Parameters
Type Name Description
System.String animationComplete
Returns
Type Description
MapsBuilder

AnnotationRendering(String)

Triggers before rendering an annotation in the maps.

Declaration
public MapsBuilder AnnotationRendering(string annotationRendering)
Parameters
Type Name Description
System.String annotationRendering
Returns
Type Description
MapsBuilder

Annotations(Action<MapsAnnotationBuilder>)

Declaration
public MapsBuilder Annotations(Action<MapsAnnotationBuilder> annotations)
Parameters
Type Name Description
System.Action<MapsAnnotationBuilder> annotations
Returns
Type Description
MapsBuilder

Annotations(List<MapsAnnotation>)

Gets or sets the options for customizing the annotations in the maps.

Declaration
public MapsBuilder Annotations(List<MapsAnnotation> annotations)
Parameters
Type Name Description
System.Collections.Generic.List<MapsAnnotation> annotations
Returns
Type Description
MapsBuilder

Background(String)

Gets or sets the background color of the maps container.

Declaration
public MapsBuilder Background(string background)
Parameters
Type Name Description
System.String background
Returns
Type Description
MapsBuilder

BaseLayerIndex(Double)

Gets or sets the index of the layer of maps which will be the base layer. It provides the option to select which layer to be visible in the maps.

Declaration
public MapsBuilder BaseLayerIndex(double baseLayerIndex)
Parameters
Type Name Description
System.Double baseLayerIndex
Returns
Type Description
MapsBuilder

BeforePrint(String)

Triggers before the print gets started.

Declaration
public MapsBuilder BeforePrint(string beforePrint)
Parameters
Type Name Description
System.String beforePrint
Returns
Type Description
MapsBuilder

Border(MapsBorder)

Gets or sets the options for customizing the style properties of the maps border.

Declaration
public MapsBuilder Border(MapsBorder border)
Parameters
Type Name Description
MapsBorder border
Returns
Type Description
MapsBuilder

Border(Action<MapsBorderBuilder>)

Declaration
public MapsBuilder Border(Action<MapsBorderBuilder> border)
Parameters
Type Name Description
System.Action<MapsBorderBuilder> border
Returns
Type Description
MapsBuilder

BubbleClick(String)

Triggers when performing the click operation on the bubble element in maps.

Declaration
public MapsBuilder BubbleClick(string bubbleClick)
Parameters
Type Name Description
System.String bubbleClick
Returns
Type Description
MapsBuilder

BubbleMouseMove(String)

Triggers when hovering the mouse on the bubble element in maps.

Declaration
public MapsBuilder BubbleMouseMove(string bubbleMouseMove)
Parameters
Type Name Description
System.String bubbleMouseMove
Returns
Type Description
MapsBuilder

BubbleRendering(String)

Triggers before the bubble element gets rendered on the map.

Declaration
public MapsBuilder BubbleRendering(string bubbleRendering)
Parameters
Type Name Description
System.String bubbleRendering
Returns
Type Description
MapsBuilder

CenterPosition(MapsCenterPosition)

Gets or sets the center position of the maps.

Declaration
public MapsBuilder CenterPosition(MapsCenterPosition centerPosition)
Parameters
Type Name Description
MapsCenterPosition centerPosition
Returns
Type Description
MapsBuilder

CenterPosition(Action<MapsCenterPositionBuilder>)

Declaration
public MapsBuilder CenterPosition(Action<MapsCenterPositionBuilder> centerPosition)
Parameters
Type Name Description
System.Action<MapsCenterPositionBuilder> centerPosition
Returns
Type Description
MapsBuilder

Click(String)

Triggers when a user clicks on an element in Maps.

Declaration
public MapsBuilder Click(string click)
Parameters
Type Name Description
System.String click
Returns
Type Description
MapsBuilder

DataLabelRendering(String)

Triggers before the data-label gets rendered.

Declaration
public MapsBuilder DataLabelRendering(string dataLabelRendering)
Parameters
Type Name Description
System.String dataLabelRendering
Returns
Type Description
MapsBuilder

Description(String)

Gets or sets the description of the maps for assistive technology.

Declaration
public MapsBuilder Description(string description)
Parameters
Type Name Description
System.String description
Returns
Type Description
MapsBuilder

DoubleClick(String)

Triggers when performing the double click operation on an element in maps.

Declaration
public MapsBuilder DoubleClick(string doubleClick)
Parameters
Type Name Description
System.String doubleClick
Returns
Type Description
MapsBuilder

EnablePersistence(Boolean)

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

Declaration
public MapsBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
MapsBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public MapsBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
MapsBuilder

Format(String)

Gets or sets the format to apply internationalization for the text in the maps.

Declaration
public MapsBuilder Format(string format)
Parameters
Type Name Description
System.String format
Returns
Type Description
MapsBuilder

Height(String)

Gets or sets the height in which the maps is to be rendered.

Declaration
public MapsBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
MapsBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public MapsBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
MapsBuilder

ItemHighlight(String)

Trigger before the shape, bubble or marker gets highlighted.

Declaration
public MapsBuilder ItemHighlight(string itemHighlight)
Parameters
Type Name Description
System.String itemHighlight
Returns
Type Description
MapsBuilder

ItemSelection(String)

Triggers before the shape, bubble or marker gets selected.

Declaration
public MapsBuilder ItemSelection(string itemSelection)
Parameters
Type Name Description
System.String itemSelection
Returns
Type Description
MapsBuilder

LayerRendering(String)

Triggers before the maps layer gets rendered.

Declaration
public MapsBuilder LayerRendering(string layerRendering)
Parameters
Type Name Description
System.String layerRendering
Returns
Type Description
MapsBuilder

Layers(Action<MapsLayerBuilder>)

Declaration
public MapsBuilder Layers(Action<MapsLayerBuilder> layers)
Parameters
Type Name Description
System.Action<MapsLayerBuilder> layers
Returns
Type Description
MapsBuilder

Layers(List<MapsLayer>)

Gets or sets the options to customize the layers of the maps.

Declaration
public MapsBuilder Layers(List<MapsLayer> layers)
Parameters
Type Name Description
System.Collections.Generic.List<MapsLayer> layers
Returns
Type Description
MapsBuilder

LegendRendering(String)

Triggers before the legend gets rendered.

Declaration
public MapsBuilder LegendRendering(string legendRendering)
Parameters
Type Name Description
System.String legendRendering
Returns
Type Description
MapsBuilder

LegendSettings(MapsLegendSettings)

Gets or sets the options to customize the legend of the maps.

Declaration
public MapsBuilder LegendSettings(MapsLegendSettings legendSettings)
Parameters
Type Name Description
MapsLegendSettings legendSettings
Returns
Type Description
MapsBuilder

LegendSettings(Action<MapsLegendSettingsBuilder>)

Declaration
public MapsBuilder LegendSettings(Action<MapsLegendSettingsBuilder> legendSettings)
Parameters
Type Name Description
System.Action<MapsLegendSettingsBuilder> legendSettings
Returns
Type Description
MapsBuilder

Load(String)

Triggers before the maps gets rendered.

Declaration
public MapsBuilder Load(string load)
Parameters
Type Name Description
System.String load
Returns
Type Description
MapsBuilder

Loaded(String)

Triggers after the maps gets rendered.

Declaration
public MapsBuilder Loaded(string loaded)
Parameters
Type Name Description
System.String loaded
Returns
Type Description
MapsBuilder

Locale(String)

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

Declaration
public MapsBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
MapsBuilder

MapsArea(MapsMapsAreaSettings)

Gets or sets the options to customize the area around the map.

Declaration
public MapsBuilder MapsArea(MapsMapsAreaSettings mapsArea)
Parameters
Type Name Description
MapsMapsAreaSettings mapsArea
Returns
Type Description
MapsBuilder

MapsArea(Action<MapsMapsAreaSettingsBuilder>)

Declaration
public MapsBuilder MapsArea(Action<MapsMapsAreaSettingsBuilder> mapsArea)
Parameters
Type Name Description
System.Action<MapsMapsAreaSettingsBuilder> mapsArea
Returns
Type Description
MapsBuilder

Margin(MapsMargin)

Gets or sets the options to customize the margin of the maps.

Declaration
public MapsBuilder Margin(MapsMargin margin)
Parameters
Type Name Description
MapsMargin margin
Returns
Type Description
MapsBuilder

Margin(Action<MapsMarginBuilder>)

Declaration
public MapsBuilder Margin(Action<MapsMarginBuilder> margin)
Parameters
Type Name Description
System.Action<MapsMarginBuilder> margin
Returns
Type Description
MapsBuilder

MarkerClick(String)

Triggers when clicking on a marker element.

Declaration
public MapsBuilder MarkerClick(string markerClick)
Parameters
Type Name Description
System.String markerClick
Returns
Type Description
MapsBuilder

MarkerClusterClick(String)

Triggers when clicking the marker cluster in maps.

Declaration
public MapsBuilder MarkerClusterClick(string markerClusterClick)
Parameters
Type Name Description
System.String markerClusterClick
Returns
Type Description
MapsBuilder

MarkerClusterMouseMove(String)

Triggers when moving the mouse over the marker cluster element in maps.

Declaration
public MapsBuilder MarkerClusterMouseMove(string markerClusterMouseMove)
Parameters
Type Name Description
System.String markerClusterMouseMove
Returns
Type Description
MapsBuilder

MarkerClusterRendering(String)

Triggers before the maps marker cluster gets rendered.

Declaration
public MapsBuilder MarkerClusterRendering(string markerClusterRendering)
Parameters
Type Name Description
System.String markerClusterRendering
Returns
Type Description
MapsBuilder

MarkerDragEnd(String)

When the marker has stopped dragging on the map, this event is triggered.

Declaration
public MapsBuilder MarkerDragEnd(string markerDragEnd)
Parameters
Type Name Description
System.String markerDragEnd
Returns
Type Description
MapsBuilder

MarkerDragStart(String)

When the marker begins to drag on the map, this event is triggered.

Declaration
public MapsBuilder MarkerDragStart(string markerDragStart)
Parameters
Type Name Description
System.String markerDragStart
Returns
Type Description
MapsBuilder

MarkerMouseMove(String)

Triggers when moving the mouse over the marker element in maps.

Declaration
public MapsBuilder MarkerMouseMove(string markerMouseMove)
Parameters
Type Name Description
System.String markerMouseMove
Returns
Type Description
MapsBuilder

MarkerRendering(String)

Triggers before the maps marker gets rendered.

Declaration
public MapsBuilder MarkerRendering(string markerRendering)
Parameters
Type Name Description
System.String markerRendering
Returns
Type Description
MapsBuilder

Onclick(String)

Triggers when a user clicks on an element in Maps.

Declaration
public MapsBuilder Onclick(string onclick)
Parameters
Type Name Description
System.String onclick
Returns
Type Description
MapsBuilder

Pan(String)

Triggers before performing the panning operation.

Declaration
public MapsBuilder Pan(string pan)
Parameters
Type Name Description
System.String pan
Returns
Type Description
MapsBuilder

ProjectionType(ProjectionType)

Gets or sets the projection with which the maps will be rendered to show the two-dimensional curved surface of a globe on a plane.

Declaration
public MapsBuilder ProjectionType(ProjectionType projectionType)
Parameters
Type Name Description
ProjectionType projectionType
Returns
Type Description
MapsBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
Microsoft.AspNetCore.Html.HtmlString

Resize(String)

Triggers to notify the resize of the maps when the window is resized.

Declaration
public MapsBuilder Resize(string resize)
Parameters
Type Name Description
System.String resize
Returns
Type Description
MapsBuilder

RightClick(String)

Triggers when performing the right click operation on an element in maps.

Declaration
public MapsBuilder RightClick(string rightClick)
Parameters
Type Name Description
System.String rightClick
Returns
Type Description
MapsBuilder

ShapeHighlight(String)

Triggers before the shape gets highlighted.

Declaration
public MapsBuilder ShapeHighlight(string shapeHighlight)
Parameters
Type Name Description
System.String shapeHighlight
Returns
Type Description
MapsBuilder

ShapeRendering(String)

Triggers before the maps shape gets rendered.

Declaration
public MapsBuilder ShapeRendering(string shapeRendering)
Parameters
Type Name Description
System.String shapeRendering
Returns
Type Description
MapsBuilder

ShapeSelected(String)

Triggers when a shape is selected in the maps.

Declaration
public MapsBuilder ShapeSelected(string shapeSelected)
Parameters
Type Name Description
System.String shapeSelected
Returns
Type Description
MapsBuilder

TabIndex(Double)

Gets or sets the tab index value for the maps.

Declaration
public MapsBuilder TabIndex(double tabIndex)
Parameters
Type Name Description
System.Double tabIndex
Returns
Type Description
MapsBuilder

Theme(MapsTheme)

Gets or sets the theme styles supported for maps. When the theme is set, the styles associated with the theme will be set in the maps.

Declaration
public MapsBuilder Theme(MapsTheme theme)
Parameters
Type Name Description
MapsTheme theme
Returns
Type Description
MapsBuilder

TitleSettings(MapsTitleSettings)

Gets or sets the options to customize the title of the maps.

Declaration
public MapsBuilder TitleSettings(MapsTitleSettings titleSettings)
Parameters
Type Name Description
MapsTitleSettings titleSettings
Returns
Type Description
MapsBuilder

TitleSettings(Action<MapsTitleSettingsBuilder>)

Declaration
public MapsBuilder TitleSettings(Action<MapsTitleSettingsBuilder> titleSettings)
Parameters
Type Name Description
System.Action<MapsTitleSettingsBuilder> titleSettings
Returns
Type Description
MapsBuilder

TooltipDisplayMode(TooltipGesture)

Gets or sets the mode in which the tooltip is to be displayed. The tooltip can be rendered on mouse move, click or double clicking on the element on the map.

Declaration
public MapsBuilder TooltipDisplayMode(TooltipGesture tooltipDisplayMode)
Parameters
Type Name Description
TooltipGesture tooltipDisplayMode
Returns
Type Description
MapsBuilder

TooltipRender(String)

Triggers before the maps tooltip gets rendered.

Declaration
public MapsBuilder TooltipRender(string tooltipRender)
Parameters
Type Name Description
System.String tooltipRender
Returns
Type Description
MapsBuilder

TooltipRenderComplete(String)

Triggers after the maps tooltip gets rendered.

Declaration
public MapsBuilder TooltipRenderComplete(string tooltipRenderComplete)
Parameters
Type Name Description
System.String tooltipRenderComplete
Returns
Type Description
MapsBuilder

UseGroupingSeparator(Boolean)

Enables or disables the visibility state of the separator for grouping.

Declaration
public MapsBuilder UseGroupingSeparator(bool useGroupingSeparator = true)
Parameters
Type Name Description
System.Boolean useGroupingSeparator
Returns
Type Description
MapsBuilder

Width(String)

Gets or sets the width in which the maps is to be rendered.

Declaration
public MapsBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
MapsBuilder

Zoom(String)

Triggers before the zoom operations such as zoom in and zoom out in the maps.

Declaration
public MapsBuilder Zoom(string zoom)
Parameters
Type Name Description
System.String zoom
Returns
Type Description
MapsBuilder

ZoomSettings(MapsZoomSettings)

Gets or sets the options to customize the zooming operations in maps.

Declaration
public MapsBuilder ZoomSettings(MapsZoomSettings zoomSettings)
Parameters
Type Name Description
MapsZoomSettings zoomSettings
Returns
Type Description
MapsBuilder

ZoomSettings(Action<MapsZoomSettingsBuilder>)

Declaration
public MapsBuilder ZoomSettings(Action<MapsZoomSettingsBuilder> zoomSettings)
Parameters
Type Name Description
System.Action<MapsZoomSettingsBuilder> zoomSettings
Returns
Type Description
MapsBuilder