MapboxCluster (Plotly.NET)

Plotly.NET

Documentation for 4.2.0

MapboxCluster Type

Namespace: Plotly.NET.LayoutObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

Clustering options for points on mapbox traces

Constructors

Constructor	Description
`MapboxCluster()` Full Usage: `MapboxCluster()` Returns: `MapboxCluster`	Returns: `MapboxCluster`

Static members

Static member Description

Static member	Description
`MapboxCluster.init (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)` Full Usage: `MapboxCluster.init (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)` Parameters: ?Color : `Color` - Sets the color for each cluster step. ?Enabled : `bool` - Determines whether clustering is enabled or disabled. ?MaxZoom : `float` - Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered. ?Opacity : `float` - Sets the marker opacity. ?Size : `int` - Sets the size for each cluster step. ?MultiSize : `seq<int>` - Sets the size for each cluster step. ?Step : `int` - Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. ?MultiStep : `seq<int>` - Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. Returns: `MapboxCluster`	Returns a new MapboxCluster object with the given styles ?Color : `Color` Sets the color for each cluster step. ?Enabled : `bool` Determines whether clustering is enabled or disabled. ?MaxZoom : `float` Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered. ?Opacity : `float` Sets the marker opacity. ?Size : `int` Sets the size for each cluster step. ?MultiSize : `seq<int>` Sets the size for each cluster step. ?Step : `int` Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. ?MultiStep : `seq<int>` Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. Returns: `MapboxCluster`
`MapboxCluster.style (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)` Full Usage: `MapboxCluster.style (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)` Parameters: ?Color : `Color` - Sets the color for each cluster step. ?Enabled : `bool` - Determines whether clustering is enabled or disabled. ?MaxZoom : `float` - Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered. ?Opacity : `float` - Sets the marker opacity. ?Size : `int` - Sets the size for each cluster step. ?MultiSize : `seq<int>` - Sets the size for each cluster step. ?Step : `int` - Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. ?MultiStep : `seq<int>` - Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. Returns: `MapboxCluster -> MapboxCluster`	Returns a function that applies the given styles to a MapboxCluster object. ?Color : `Color` Sets the color for each cluster step. ?Enabled : `bool` Determines whether clustering is enabled or disabled. ?MaxZoom : `float` Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered. ?Opacity : `float` Sets the marker opacity. ?Size : `int` Sets the size for each cluster step. ?MultiSize : `seq<int>` Sets the size for each cluster step. ?Step : `int` Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. ?MultiStep : `seq<int>` Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value. Returns: `MapboxCluster -> MapboxCluster`


                
                  
                    
                      MapboxCluster.init (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)

Full Usage: MapboxCluster.init (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)

Parameters:

?Color : Color - Sets the color for each cluster step.

?Enabled : bool - Determines whether clustering is enabled or disabled.

?MaxZoom : float - Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.

?Opacity : float - Sets the marker opacity.

?Size : int - Sets the size for each cluster step.

?MultiSize : seq<int> - Sets the size for each cluster step.

?Step : int - Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

?MultiStep : seq<int> - Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

Returns: MapboxCluster

Returns a new MapboxCluster object with the given styles

?Color : Color: Sets the color for each cluster step.
?Enabled : bool: Determines whether clustering is enabled or disabled.
?MaxZoom : float: Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.
?Opacity : float: Sets the marker opacity.
?Size : int: Sets the size for each cluster step.
?MultiSize : seq<int>: Sets the size for each cluster step.
?Step : int: Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.
?MultiStep : seq<int>: Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.

Returns: MapboxCluster


                
                  
                    
                      MapboxCluster.style (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)

Full Usage: MapboxCluster.style (?Color, ?Enabled, ?MaxZoom, ?Opacity, ?Size, ?MultiSize, ?Step, ?MultiStep)

Parameters: