menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MapsLayerBuilder - API Reference

    Show / Hide Table of Contents

    Class MapsLayerBuilder

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

    Constructors

    MapsLayerBuilder()

    Declaration
    public MapsLayerBuilder()

    MapsLayerBuilder(List<MapsLayer>)

    Declaration
    public MapsLayerBuilder(List<MapsLayer> collection)
    Parameters
    Type Name Description
    System.Collections.Generic.List<MapsLayer> collection

    Methods

    Add()

    Declaration
    public void Add()

    AnimationDuration(Double)

    Gets or sets the duration of the animation of layers when the zooming is performed in maps.

    Declaration
    public MapsLayerBuilder AnimationDuration(double animationDuration)
    Parameters
    Type Name Description
    System.Double animationDuration
    Returns
    Type Description
    MapsLayerBuilder

    BingMapType(BingMapType)

    Gets or sets the Bing map type for the layer. If you set GeoJSON data in the map and set the BingMapType value without setting the layer type as "Bing", then the map will be rendered based on the provided shape data since the default layer type will be set as "Geometry".

    Declaration
    public MapsLayerBuilder BingMapType(BingMapType bingMapType)
    Parameters
    Type Name Description
    BingMapType bingMapType
    Returns
    Type Description
    MapsLayerBuilder

    BubbleSettings(Action<MapsBubbleBuilder>)

    Declaration
    public MapsLayerBuilder BubbleSettings(Action<MapsBubbleBuilder> bubbleSettings)
    Parameters
    Type Name Description
    System.Action<MapsBubbleBuilder> bubbleSettings
    Returns
    Type Description
    MapsLayerBuilder

    BubbleSettings(List<MapsBubble>)

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

    Declaration
    public MapsLayerBuilder BubbleSettings(List<MapsBubble> bubbleSettings)
    Parameters
    Type Name Description
    System.Collections.Generic.List<MapsBubble> bubbleSettings
    Returns
    Type Description
    MapsLayerBuilder

    DataLabelSettings(MapsDataLabelSettings)

    Gets or sets the options for customizing the data labels in maps.

    Declaration
    public MapsLayerBuilder DataLabelSettings(MapsDataLabelSettings dataLabelSettings)
    Parameters
    Type Name Description
    MapsDataLabelSettings dataLabelSettings
    Returns
    Type Description
    MapsLayerBuilder

    DataLabelSettings(Action<MapsDataLabelSettingsBuilder>)

    Declaration
    public MapsLayerBuilder DataLabelSettings(Action<MapsDataLabelSettingsBuilder> dataLabelSettings)
    Parameters
    Type Name Description
    System.Action<MapsDataLabelSettingsBuilder> dataLabelSettings
    Returns
    Type Description
    MapsLayerBuilder

    DataSource(Action<DataManagerBuilder>)

    Declaration
    public MapsLayerBuilder DataSource(Action<DataManagerBuilder> dataSource)
    Parameters
    Type Name Description
    System.Action<DataManagerBuilder> dataSource
    Returns
    Type Description
    MapsLayerBuilder

    DataSource(Object)

    Gets or sets the data source for the layer. The data bound to the shapes using data source can be used to display the tooltip, marker, and bubble.

    Declaration
    public MapsLayerBuilder DataSource(object dataSource)
    Parameters
    Type Name Description
    System.Object dataSource
    Returns
    Type Description
    MapsLayerBuilder

    GeometryType(GeometryType)

    Gets or sets the geometry type for the layer in maps. There are two types: Geographic and Normal. Geographic type renders the shape maps with geographical coordinate system. Normal type renders the shape maps using default coordinate system.

    Declaration
    public MapsLayerBuilder GeometryType(GeometryType geometryType)
    Parameters
    Type Name Description
    GeometryType geometryType
    Returns
    Type Description
    MapsLayerBuilder

    HighlightSettings(MapsHighlightSettings)

    Gets or sets the options for customizing the shapes when the mouse hovers over maps.

    Declaration
    public MapsLayerBuilder HighlightSettings(MapsHighlightSettings highlightSettings)
    Parameters
    Type Name Description
    MapsHighlightSettings highlightSettings
    Returns
    Type Description
    MapsLayerBuilder

    HighlightSettings(Action<MapsHighlightSettingsBuilder>)

    Declaration
    public MapsLayerBuilder HighlightSettings(Action<MapsHighlightSettingsBuilder> highlightSettings)
    Parameters
    Type Name Description
    System.Action<MapsHighlightSettingsBuilder> highlightSettings
    Returns
    Type Description
    MapsLayerBuilder

    InitialShapeSelection(Action<MapsInitialShapeSelectionBuilder>)

    Declaration
    public MapsLayerBuilder InitialShapeSelection(Action<MapsInitialShapeSelectionBuilder> initialShapeSelection)
    Parameters
    Type Name Description
    System.Action<MapsInitialShapeSelectionBuilder> initialShapeSelection
    Returns
    Type Description
    MapsLayerBuilder

    InitialShapeSelection(List<MapsInitialShapeSelection>)

    Gets or sets the settings for the shapes to be selected when the maps rendering initially. The initial selection of shapes will be performed only when the selection functionality of layer is enabled.

    Declaration
    public MapsLayerBuilder InitialShapeSelection(List<MapsInitialShapeSelection> initialShapeSelection)
    Parameters
    Type Name Description
    System.Collections.Generic.List<MapsInitialShapeSelection> initialShapeSelection
    Returns
    Type Description
    MapsLayerBuilder

    Key(String)

    Gets or sets the key for the online map provider to render in the layer of the maps.

    Declaration
    public MapsLayerBuilder Key(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    MapsLayerBuilder

    LayerType(ShapeLayerType)

    Gets or sets the type of the layer in maps. If we use layer type with shape data property in layer of the maps then map will render based on the provided layer type.

    Declaration
    public MapsLayerBuilder LayerType(ShapeLayerType layerType)
    Parameters
    Type Name Description
    ShapeLayerType layerType
    Returns
    Type Description
    MapsLayerBuilder

    MarkerClusterSettings(MapsMarkerClusterSettings)

    Gets or sets the options for customizing the cluster of markers in maps.

    Declaration
    public MapsLayerBuilder MarkerClusterSettings(MapsMarkerClusterSettings markerClusterSettings)
    Parameters
    Type Name Description
    MapsMarkerClusterSettings markerClusterSettings
    Returns
    Type Description
    MapsLayerBuilder

    MarkerClusterSettings(Action<MapsMarkerClusterSettingsBuilder>)

    Declaration
    public MapsLayerBuilder MarkerClusterSettings(Action<MapsMarkerClusterSettingsBuilder> markerClusterSettings)
    Parameters
    Type Name Description
    System.Action<MapsMarkerClusterSettingsBuilder> markerClusterSettings
    Returns
    Type Description
    MapsLayerBuilder

    MarkerSettings(Action<MapsMarkerBuilder>)

    Declaration
    public MapsLayerBuilder MarkerSettings(Action<MapsMarkerBuilder> markerSettings)
    Parameters
    Type Name Description
    System.Action<MapsMarkerBuilder> markerSettings
    Returns
    Type Description
    MapsLayerBuilder

    MarkerSettings(List<MapsMarker>)

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

    Declaration
    public MapsLayerBuilder MarkerSettings(List<MapsMarker> markerSettings)
    Parameters
    Type Name Description
    System.Collections.Generic.List<MapsMarker> markerSettings
    Returns
    Type Description
    MapsLayerBuilder

    NavigationLineSettings(Action<MapsNavigationLineBuilder>)

    Declaration
    public MapsLayerBuilder NavigationLineSettings(Action<MapsNavigationLineBuilder> navigationLineSettings)
    Parameters
    Type Name Description
    System.Action<MapsNavigationLineBuilder> navigationLineSettings
    Returns
    Type Description
    MapsLayerBuilder

    NavigationLineSettings(List<MapsNavigationLine>)

    Gets or sets the options for customizing the navigation lines in maps.

    Declaration
    public MapsLayerBuilder NavigationLineSettings(List<MapsNavigationLine> navigationLineSettings)
    Parameters
    Type Name Description
    System.Collections.Generic.List<MapsNavigationLine> navigationLineSettings
    Returns
    Type Description
    MapsLayerBuilder

    Query(String)

    Gets or sets the query to select particular data from the layer data source. This property is applicable only when the data source is created by data manager.

    Declaration
    public MapsLayerBuilder Query(string query)
    Parameters
    Type Name Description
    System.String query
    Returns
    Type Description
    MapsLayerBuilder

    SelectionSettings(MapsSelectionSettings)

    Gets or sets the options for customizing the shapes when clicking on the shapes in maps.

    Declaration
    public MapsLayerBuilder SelectionSettings(MapsSelectionSettings selectionSettings)
    Parameters
    Type Name Description
    MapsSelectionSettings selectionSettings
    Returns
    Type Description
    MapsLayerBuilder

    SelectionSettings(Action<MapsSelectionSettingsBuilder>)

    Declaration
    public MapsLayerBuilder SelectionSettings(Action<MapsSelectionSettingsBuilder> selectionSettings)
    Parameters
    Type Name Description
    System.Action<MapsSelectionSettingsBuilder> selectionSettings
    Returns
    Type Description
    MapsLayerBuilder

    ShapeData(Object)

    Gets or sets the data for the maps to render. The data is normally JSON object with GeoJSON format that defines the shapes and geometries of the map.

    Declaration
    public MapsLayerBuilder ShapeData(object shapeData)
    Parameters
    Type Name Description
    System.Object shapeData
    Returns
    Type Description
    MapsLayerBuilder

    ShapeDataPath(String)

    Gets or sets the field name from the GeoJSON data to map the shape to the data defined in the layer data source.

    Declaration
    public MapsLayerBuilder ShapeDataPath(string shapeDataPath)
    Parameters
    Type Name Description
    System.String shapeDataPath
    Returns
    Type Description
    MapsLayerBuilder

    ShapePropertyPath(Object)

    Gets or sets the field name from the data source to map the shape to the data defined in the layer data source.

    Declaration
    public MapsLayerBuilder ShapePropertyPath(object shapePropertyPath)
    Parameters
    Type Name Description
    System.Object shapePropertyPath
    Returns
    Type Description
    MapsLayerBuilder

    ShapePropertyPath(String)

    Gets or sets the field name from the data source to map the shape to the data defined in the layer data source.

    Declaration
    public MapsLayerBuilder ShapePropertyPath(string shapePropertyPath)
    Parameters
    Type Name Description
    System.String shapePropertyPath
    Returns
    Type Description
    MapsLayerBuilder

    ShapePropertyPath(String[])

    Gets or sets the field name from the data source to map the shape to the data defined in the layer data source.

    Declaration
    public MapsLayerBuilder ShapePropertyPath(string[] shapePropertyPath)
    Parameters
    Type Name Description
    System.String[] shapePropertyPath
    Returns
    Type Description
    MapsLayerBuilder

    ShapeSettings(MapsShapeSettings)

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

    Declaration
    public MapsLayerBuilder ShapeSettings(MapsShapeSettings shapeSettings)
    Parameters
    Type Name Description
    MapsShapeSettings shapeSettings
    Returns
    Type Description
    MapsLayerBuilder

    ShapeSettings(Action<MapsShapeSettingsBuilder>)

    Declaration
    public MapsLayerBuilder ShapeSettings(Action<MapsShapeSettingsBuilder> shapeSettings)
    Parameters
    Type Name Description
    System.Action<MapsShapeSettingsBuilder> shapeSettings
    Returns
    Type Description
    MapsLayerBuilder

    StaticMapType(StaticMapType)

    Gets or sets the type of the static maps.

    Declaration
    public MapsLayerBuilder StaticMapType(StaticMapType staticMapType)
    Parameters
    Type Name Description
    StaticMapType staticMapType
    Returns
    Type Description
    MapsLayerBuilder

    ToggleLegendSettings(Object)

    Gets or sets the options for customizing the toggle state of shapes when selecting the legend in maps.

    Declaration
    public MapsLayerBuilder ToggleLegendSettings(object toggleLegendSettings)
    Parameters
    Type Name Description
    System.Object toggleLegendSettings
    Returns
    Type Description
    MapsLayerBuilder

    TooltipSettings(MapsTooltipSettings)

    Gets or sets the options for customizing the tooltip of the layers in maps.

    Declaration
    public MapsLayerBuilder TooltipSettings(MapsTooltipSettings tooltipSettings)
    Parameters
    Type Name Description
    MapsTooltipSettings tooltipSettings
    Returns
    Type Description
    MapsLayerBuilder

    TooltipSettings(Action<MapsTooltipSettingsBuilder>)

    Declaration
    public MapsLayerBuilder TooltipSettings(Action<MapsTooltipSettingsBuilder> tooltipSettings)
    Parameters
    Type Name Description
    System.Action<MapsTooltipSettingsBuilder> tooltipSettings
    Returns
    Type Description
    MapsLayerBuilder

    Type(Type)

    Gets or sets the type of the layer in maps. There are two types: Layer and SubLayer.

    Declaration
    public MapsLayerBuilder Type(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    MapsLayerBuilder

    UrlTemplate(String)

    Gets or sets the URL of the online map providers. The online map providers will be rendered only when the shape data is not set and layer type is set with default value.

    Declaration
    public MapsLayerBuilder UrlTemplate(string urlTemplate)
    Parameters
    Type Name Description
    System.String urlTemplate
    Returns
    Type Description
    MapsLayerBuilder

    Visible(Boolean)

    Enables or disables the visibility of the layers in maps.

    Declaration
    public MapsLayerBuilder Visible(bool visible)
    Parameters
    Type Name Description
    System.Boolean visible
    Returns
    Type Description
    MapsLayerBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved