Logo Plotly.NET

Chart Type

Static members

Static member Description

Chart.ChoroplethMapbox(locations, zEncoded, geoJson, ?Name, ?MapboxStyle, ?ShowLegend, ?FeatureIdKey, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Full Usage: Chart.ChoroplethMapbox(locations, zEncoded, geoJson, ?Name, ?MapboxStyle, ?ShowLegend, ?FeatureIdKey, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Parameters:
    locations : string seq - Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
    zEncoded : EncodedTypedArray - The color values for each location as an encoded typed array.
    geoJson : obj - Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon".
    ?Name : string - Sets the trace name. The trace name appear as the legend item and on hover.
    ?MapboxStyle : MapboxStyle - Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this trace is shown in the legend.
    ?FeatureIdKey : string - Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name".
    ?Text : 'a - Sets a text associated with each datum
    ?MultiText : 'a seq - Sets individual text for each datum
    ?ColorBar : ColorBar - Sets the colorbar.
    ?ColorScale : Colorscale - Sets the colorscale.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace.
    ?ReverseScale : bool - Reverses the color mapping if true.
    ?Below : string - Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".
    ?UseDefaults : bool - If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart
Type parameters: 'a (requires :> System.IConvertible)

Creates a choropleth map using mapbox from encoded color values. A choropleth map is a type of thematic map in which a set of pre-defined areas is colored or patterned in proportion to a statistical variable that represents an aggregate summary of a geographic characteristic within each area, such as population density or per-capita income. GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`. Customize the mapbox layers, style, etc. by using Chart.withMapbox. You might need a Mapbox token, which you can also configure with Chart.withMapbox.

locations : string seq

Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.

zEncoded : EncodedTypedArray

The color values for each location as an encoded typed array.

geoJson : obj

Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon".

?Name : string

Sets the trace name. The trace name appear as the legend item and on hover.

?MapboxStyle : MapboxStyle

Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.

?ShowLegend : bool

Determines whether or not an item corresponding to this trace is shown in the legend.

?FeatureIdKey : string

Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name".

?Text : 'a

Sets a text associated with each datum

?MultiText : 'a seq

Sets individual text for each datum

?ColorBar : ColorBar

Sets the colorbar.

?ColorScale : Colorscale

Sets the colorscale.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace.

?ReverseScale : bool

Reverses the color mapping if true.

?Below : string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".

?UseDefaults : bool

If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart

Chart.ChoroplethMapbox(locations, z, geoJson, ?Name, ?MapboxStyle, ?ShowLegend, ?FeatureIdKey, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Full Usage: Chart.ChoroplethMapbox(locations, z, geoJson, ?Name, ?MapboxStyle, ?ShowLegend, ?FeatureIdKey, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Parameters:
    locations : string seq - Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
    z : 'a seq - The color values for each location
    geoJson : obj - Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon".
    ?Name : string - Sets the trace name. The trace name appear as the legend item and on hover.
    ?MapboxStyle : MapboxStyle - Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this trace is shown in the legend.
    ?FeatureIdKey : string - Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name".
    ?Text : 'b - Sets a text associated with each datum
    ?MultiText : 'b seq - Sets individual text for each datum
    ?ColorBar : ColorBar - Sets the colorbar.
    ?ColorScale : Colorscale - Sets the colorscale.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace.
    ?ReverseScale : bool - Reverses the color mapping if true.
    ?Below : string - Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".
    ?UseDefaults : bool - If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart
Type parameters: 'a, 'b (requires :> System.IConvertible and :> System.IConvertible)

Creates a choropleth map using mapbox. A choropleth map is a type of thematic map in which a set of pre-defined areas is colored or patterned in proportion to a statistical variable that represents an aggregate summary of a geographic characteristic within each area, such as population density or per-capita income. GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`. Customize the mapbox layers, style, etc. by using Chart.withMapbox. You might need a Mapbox token, which you can also configure with Chart.withMapbox.

locations : string seq

Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.

z : 'a seq

The color values for each location

geoJson : obj

Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type "FeatureCollection" or "Feature" with geometries of type "Polygon" or "MultiPolygon".

?Name : string

Sets the trace name. The trace name appear as the legend item and on hover.

?MapboxStyle : MapboxStyle

Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.

?ShowLegend : bool

Determines whether or not an item corresponding to this trace is shown in the legend.

?FeatureIdKey : string

Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example "properties.name".

?Text : 'b

Sets a text associated with each datum

?MultiText : 'b seq

Sets individual text for each datum

?ColorBar : ColorBar

Sets the colorbar.

?ColorScale : Colorscale

Sets the colorscale.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace.

?ReverseScale : bool

Reverses the color mapping if true.

?Below : string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".

?UseDefaults : bool

If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart

Chart.DensityMapbox(longitudesEncoded, latitudesEncoded, ?Name, ?MapboxStyle, ?ShowLegend, ?Opacity, ?zEncoded, ?Radius, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Full Usage: Chart.DensityMapbox(longitudesEncoded, latitudesEncoded, ?Name, ?MapboxStyle, ?ShowLegend, ?Opacity, ?zEncoded, ?Radius, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Parameters:
    longitudesEncoded : EncodedTypedArray - Sets the longitude coordinates (in degrees East) as an encoded typed array.
    latitudesEncoded : EncodedTypedArray - Sets the latitude coordinates (in degrees North) as an encoded typed array.
    ?Name : string - Sets the trace name. The trace name appear as the legend item and on hover.
    ?MapboxStyle : MapboxStyle - Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this trace is shown in the legend.
    ?Opacity : float - Sets the opacity of the trace
    ?zEncoded : EncodedTypedArray - Sets the points' weight as an encoded typed array. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot.
    ?Radius : int - Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.
    ?Text : 'a - Sets a text associated with each datum
    ?MultiText : 'a seq - Sets individual text for each datum
    ?ColorBar : ColorBar - Sets the colorbar.
    ?ColorScale : Colorscale - Sets the colorscale.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace.
    ?ReverseScale : bool - Reverses the color mapping if true.
    ?Below : string - Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".
    ?UseDefaults : bool - If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart
Type parameters: 'a (requires :> System.IConvertible)

Creates a DensityMapbox Chart from encoded longitude and latitude coordinates and optional encoded weights. Customize the mapbox layers, style, etc. by using Chart.withMapbox. You might need a Mapbox token, which you can also configure with Chart.withMapbox.

longitudesEncoded : EncodedTypedArray

Sets the longitude coordinates (in degrees East) as an encoded typed array.

latitudesEncoded : EncodedTypedArray

Sets the latitude coordinates (in degrees North) as an encoded typed array.

?Name : string

Sets the trace name. The trace name appear as the legend item and on hover.

?MapboxStyle : MapboxStyle

Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.

?ShowLegend : bool

Determines whether or not an item corresponding to this trace is shown in the legend.

?Opacity : float

Sets the opacity of the trace

?zEncoded : EncodedTypedArray

Sets the points' weight as an encoded typed array. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot.

?Radius : int

Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

?Text : 'a

Sets a text associated with each datum

?MultiText : 'a seq

Sets individual text for each datum

?ColorBar : ColorBar

Sets the colorbar.

?ColorScale : Colorscale

Sets the colorscale.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace.

?ReverseScale : bool

Reverses the color mapping if true.

?Below : string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".

?UseDefaults : bool

If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart

Chart.DensityMapbox(lonlat, ?Name, ?MapboxStyle, ?ShowLegend, ?Opacity, ?Z, ?Radius, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Full Usage: Chart.DensityMapbox(lonlat, ?Name, ?MapboxStyle, ?ShowLegend, ?Opacity, ?Z, ?Radius, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Parameters:
    lonlat : ('a * 'b) seq - Sets the (longitude,latitude) coordinates (in degrees East, degrees North).
    ?Name : string - Sets the trace name. The trace name appear as the legend item and on hover.
    ?MapboxStyle : MapboxStyle - Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this trace is shown in the legend.
    ?Opacity : float - Sets the opacity of the trace
    ?Z : 'c seq - Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
    ?Radius : int - Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.
    ?Text : 'd - Sets a text associated with each datum
    ?MultiText : 'd seq - Sets individual text for each datum
    ?ColorBar : ColorBar - Sets the colorbar.
    ?ColorScale : Colorscale - Sets the colorscale.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace.
    ?ReverseScale : bool - Reverses the color mapping if true.
    ?Below : string - Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".
    ?UseDefaults : bool - If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart
Type parameters: 'a, 'b, 'c, 'd (requires :> System.IConvertible and :> System.IConvertible and :> System.IConvertible and :> System.IConvertible)

Creates a DensityMapbox Chart that draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale. Customize the mapbox layers, style, etc. by using Chart.withMapbox. You might need a Mapbox token, which you can also configure with Chart.withMapbox.

lonlat : ('a * 'b) seq

Sets the (longitude,latitude) coordinates (in degrees East, degrees North).

?Name : string

Sets the trace name. The trace name appear as the legend item and on hover.

?MapboxStyle : MapboxStyle

Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.

?ShowLegend : bool

Determines whether or not an item corresponding to this trace is shown in the legend.

?Opacity : float

Sets the opacity of the trace

?Z : 'c seq

Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

?Radius : int

Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

?Text : 'd

Sets a text associated with each datum

?MultiText : 'd seq

Sets individual text for each datum

?ColorBar : ColorBar

Sets the colorbar.

?ColorScale : Colorscale

Sets the colorscale.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace.

?ReverseScale : bool

Reverses the color mapping if true.

?Below : string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".

?UseDefaults : bool

If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart

Chart.DensityMapbox(longitudes, latitudes, ?Name, ?MapboxStyle, ?ShowLegend, ?Opacity, ?Z, ?Radius, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Full Usage: Chart.DensityMapbox(longitudes, latitudes, ?Name, ?MapboxStyle, ?ShowLegend, ?Opacity, ?Z, ?Radius, ?Text, ?MultiText, ?ColorBar, ?ColorScale, ?ShowScale, ?ReverseScale, ?Below, ?UseDefaults)

Parameters:
    longitudes : 'a seq - Sets the longitude coordinates (in degrees East).
    latitudes : 'b seq - Sets the latitude coordinates (in degrees North).
    ?Name : string - Sets the trace name. The trace name appear as the legend item and on hover.
    ?MapboxStyle : MapboxStyle - Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.
    ?ShowLegend : bool - Determines whether or not an item corresponding to this trace is shown in the legend.
    ?Opacity : float - Sets the opacity of the trace
    ?Z : 'c seq - Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot
    ?Radius : int - Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.
    ?Text : 'd - Sets a text associated with each datum
    ?MultiText : 'd seq - Sets individual text for each datum
    ?ColorBar : ColorBar - Sets the colorbar.
    ?ColorScale : Colorscale - Sets the colorscale.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace.
    ?ReverseScale : bool - Reverses the color mapping if true.
    ?Below : string - Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".
    ?UseDefaults : bool - If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart
Type parameters: 'a, 'b, 'c, 'd (requires :> System.IConvertible and :> System.IConvertible and :> System.IConvertible and :> System.IConvertible)

Creates a DensityMapbox Chart that draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale. Customize the mapbox layers, style, etc. by using Chart.withMapbox. You might need a Mapbox token, which you can also configure with Chart.withMapbox.

longitudes : 'a seq

Sets the longitude coordinates (in degrees East).

latitudes : 'b seq

Sets the latitude coordinates (in degrees North).

?Name : string

Sets the trace name. The trace name appear as the legend item and on hover.

?MapboxStyle : MapboxStyle

Sets the base mapbox layer. Default is `OpenStreetMap`. Note that you will need an access token for some Mapbox presets.

?ShowLegend : bool

Determines whether or not an item corresponding to this trace is shown in the legend.

?Opacity : float

Sets the opacity of the trace

?Z : 'c seq

Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot

?Radius : int

Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.

?Text : 'd

Sets a text associated with each datum

?MultiText : 'd seq

Sets individual text for each datum

?ColorBar : ColorBar

Sets the colorbar.

?ColorScale : Colorscale

Sets the colorscale.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace.

?ReverseScale : bool

Reverses the color mapping if true.

?Below : string

Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to "''".

?UseDefaults : bool

If set to false, ignore the global default settings set in `Defaults`

Returns: GenericChart

Type something to start searching.