` containing a chart generation script). This is usually meant to included into another document that contains a reference to plotly.js.
+
+ Functions that generate these fragments are:
+ - [GenericChart.toChartHTML](/reference/plotly-net-genericchart.html#toChartHTML)
+
+
-Plotly.NET provides multiple ways to do that in the generated html:
+Plotly.NET provides multiple ways to reference plotly.js in generated html via the `PlotlyJSReference` type. These differ in their effect depending on if the output is a full html document or a fragment:
-- `Full`: Include the full plotly.js source in a script tag. HTML files using this option are self-contained and can be used offline.
-- `CDN`: The default. uses a script tag in the head of the generated HTML to load plotly.js from a CDN.
-- `Require`: Use requirejs to load plotly. This option is for example used in Plotly.NET.Interactive inside notebooks.
-- `NoReference`: Don't include any plotly.js reference. Useful if you want to embed the output into another page that already references plotly - the documentation pages you are reading now are generated with this option.
+| PlotlyJSReference Option | Description | Document | Fragment |
+| --- | --- | --- | --- |
+| `Full` | Include the full plotly.js source. | HTML documents created using this option are self-contained and can be used offline. | No effect |
+| `CDN` | (default) Include a reference to plotly.js from a CDN. | HTML documents created using this option will contain a reference in their `` tag | No effect |
+| `Require` | Use requirejs to load plotly. | HTML documents created using this option will programmatically add a reference to require.js in their `` tag which will then be used to load plotly.js | Fragments created using this option will programmatically add a reference to require.js when embedded into a html document which will then be used to load plotly.js. |
+| `NoReference` | Don't include any plotly.js reference. Useful if you want to embed the output into another page that already references plotly - the documentation pages you are reading now are generated with this option. | No effect | No effect |
-You can control this on a per-chart basis via `Chart.withDisplayOptionsStyle`, for example if you want to include a script tag with the full plotly.js source:
+You can control this on a per-chart basis via [Chart.withDisplayOptionsStyle](http://localhost:8901/reference/plotly-net-chart.html#withDisplayOptionsStyle), for example if you want to include a script tag with the full plotly.js source:
*)
@@ -72,7 +88,7 @@ Chart.Point(x = x, y = y)
Plotly.NET uses [Giraffe.ViewEngine](https://github.com/giraffe-fsharp/Giraffe.ViewEngine) internally to generate HTML documents, which means you can also use that DSL to add additional content to the output.
-For example, use `Chart.withDescription` to append a list of html tags below the rendered chart:
+For example, use [Chart.withDescription](/reference/plotly-net-chart.html#withDescription) to append a list of html tags below the rendered chart:
*)
open Giraffe.ViewEngine
@@ -99,7 +115,7 @@ desc1 |> GenericChart.toChartHTML
_Note: the example here is shown via an image, as the docs themselves are html pages that cannot load additional head tags._
-You can add any number of additional html tags to the documents `` tag using `Chart.WithAdditionalHeadTags`.
+You can add any number of additional html tags to document `` tag using [Chart.WithAdditionalHeadTags](/reference/plotly-net-chart.html#withAdditionalHeadTags).
For example, you can load external css libraries to style the chart description:
*)
@@ -128,7 +144,7 @@ let desc3 =
## Using MathTeX
-`Chart.WithMathTex` is a prebuilt function to enable MathTeX for your generated plotly chart documents.
+[Chart.WithMathTex](/reference/plotly-net-chart.html#withMathTex) is a prebuilt function to enable MathTeX for your generated plotly chart documents.
It will add a MathJax script reference to your document based on which version (either 2 or 3) you want to use:
*)
diff --git a/docs/general/multi-arguments.fsx b/docs/general/multi-arguments.fsx
index 0ec690dfd..d938c5030 100644
--- a/docs/general/multi-arguments.fsx
+++ b/docs/general/multi-arguments.fsx
@@ -37,7 +37,7 @@ In Plotly.NET, this is modelled by 2 arguments in the constructors:
- The "single value version" (e.g. `Opacity`) that sets one value in the target property
- The "multi value version" (e.g. `MultiOpacity`) that sets a collection of values in the target property
-**Multi-arguments always have precedent over single arguments, meaning setting both will always set the multi version**
+**Multi-arguments always have precedence over single arguments, meaning setting both will always set the multi version**
Here is an example for bar charts:
diff --git a/docs/general/styling-markers.fsx b/docs/general/styling-markers.fsx
index 4c874420e..30bb4d772 100644
--- a/docs/general/styling-markers.fsx
+++ b/docs/general/styling-markers.fsx
@@ -88,9 +88,10 @@ byStyle |> GenericChart.toChartHTML
## Marker Symbols
Marker symbols control the appearance of points in a plot. There are some things to keep in mind when working with marker symbols:
- - 2D and 3D Markers are different types ()
- - 2D Markers can be modified using modification syntax
- - 3D Markers cannot be modified
+
+- 2D and 3D Markers are different types
+- 2D Markers can be modified using modification syntax
+- 3D Markers cannot be modified
### 2D Marker Symbols
diff --git a/docs/general/templates.fsx b/docs/general/templates.fsx
index faeaa56ee..fe0f4eb2e 100644
--- a/docs/general/templates.fsx
+++ b/docs/general/templates.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
## Using premade templates
-premade templates can be accessed via the `ChartTemplates` module. In fact, the `ChartTemplates.plotly` template is always active by default (see [global defaults](./00_5_defaults.html))
+Premade templates can be accessed via the `ChartTemplates` module. In fact, the `ChartTemplates.plotly` template is always active by default (see [global defaults](./00_5_defaults.html))
*)
open Plotly.NET
diff --git a/docs/general/working-with-colors.fsx b/docs/general/working-with-colors.fsx
index f53839208..f09e37910 100644
--- a/docs/general/working-with-colors.fsx
+++ b/docs/general/working-with-colors.fsx
@@ -40,7 +40,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
## The Color type
-There are many ways how plotly.js handles colors. In general, individual colors can be set the same way as in general html/css - so for example string representations of (a)rgb, hsl, or keywords such as "red"
+There are many ways how plotly.js handles colors. In general, individual colors can be set the same way as in general html/css - so for example string representations of (a)rgb, hsl, or keywords such as "red".
Additionally to that, there are several ways of controlling color attributes of plotly objects:
- Setting a single color which will be used for all elements in a collection, for example all markers: `"rgb(r,g,b)"` or `"red"`
diff --git a/docs/geo-map-charts/choropleth-map.fsx b/docs/geo-map-charts/choropleth-map.fsx
index 9aa5035d9..b028d217e 100644
--- a/docs/geo-map-charts/choropleth-map.fsx
+++ b/docs/geo-map-charts/choropleth-map.fsx
@@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create choropleth map in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -286,10 +286,10 @@ choroplethMap2 |> GenericChart.toChartHTML
[GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) is an open standard format designed for representing simple geographical features, along with their non-spatial attributes.
-GeoJSON, or at least the type of GeoJSON accepted by plotly.js are `FeatureCollection`s. A feature has for example the `geometry` field, which defines e.g. the corrdinates of it (think for example the coordinates of a polygon on the map)
+GeoJSON, or at least the type of GeoJSON accepted by plotly.js are `FeatureCollection`s. A feature has for example the `geometry` field, which defines e.g. the coordinates of it (think for example the coordinates of a polygon on the map)
and the `properties` field, a key-value pair of properties of the feature.
-If you want to use GeoJSON with Plotly.NET (or any plotly flavor really), you have to know the property of the feature you are mapping your data to. In the following example this is simply the `id` of a feature, but you can access any property by `property.key`.
+If you want to use GeoJSON with Plotly.NET (or any plotly flavor really), you have to know the property of the feature you are mapping your data to. In the following example, this is simply the `id` of a feature, but you can access any property by `property.key`.
Consider the following GeoJSON:
@@ -305,7 +305,7 @@ let geoJson =
|> JsonConvert.DeserializeObject // the easiest way to use the GeoJSON object is deserializing the JSON string.
(**
-it looks like this:
+It looks like this:
```JSON
{
@@ -330,7 +330,7 @@ it looks like this:
It basically contains all US counties as polygons on the map. Note that the `id` property corresponds to the [**fips code**](https://en.wikipedia.org/wiki/FIPS_county_code).
-To visualize some data using these counties as locations on a choropleth map, we need some exmaple data:
+To visualize some data using these counties as locations on a choropleth map, we need some example data:
*)
// we use the awesome Deedle data frame library to parse and extract our location and z data
diff --git a/docs/geo-map-charts/geo-plots.fsx b/docs/geo-map-charts/geo-plots.fsx
index 22159332b..d26d62735 100644
--- a/docs/geo-map-charts/geo-plots.fsx
+++ b/docs/geo-map-charts/geo-plots.fsx
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create Point and Line charts on geo maps in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
@@ -126,7 +126,7 @@ let flights =
MarkerColor = Color.fromString "red"
))
|> Chart.combine
- |> Chart.withLegend (false)
+ |> Chart.withLayoutStyle (ShowLegend = false)
|> Chart.withGeoStyle (
Scope = StyleParam.GeoScope.NorthAmerica,
Projection = GeoProjection.init (StyleParam.GeoProjectionType.AzimuthalEqualArea),
diff --git a/docs/geo-map-charts/geo-vs-mapbox.fsx b/docs/geo-map-charts/geo-vs-mapbox.fsx
index a7419e0c9..25aafb9e1 100644
--- a/docs/geo-map-charts/geo-vs-mapbox.fsx
+++ b/docs/geo-map-charts/geo-vs-mapbox.fsx
@@ -38,7 +38,7 @@ Plotly and therefore Plotly.NET supports two different kinds of maps:
- **Mapbox maps** are tile-based maps. If your figure is created with a `Chart.*Mapbox` function or otherwise contains one or more traces of type `scattermapbox`,
`choroplethmapbox` or `densitymapbox`, the layout.mapbox object in your figure contains configuration information for the map itself.
-- **Geo maps** are outline-based maps. If your figure is created with a `Chart.ScatterGeo, `Chart.PointGeo`, `Chart.LineGeo` or `Chart.Choropleth` function or
+- **Geo maps** are outline-based maps. If your figure is created with a `Chart.ScatterGeo`, `Chart.PointGeo`, `Chart.LineGeo` or `Chart.Choropleth` function or
otherwise contains one or more traces of type `scattergeo` or `choropleth`, the layout.geo object in your figure contains configuration information for the map itself.
_This page documents Geo outline-based maps, and the [Mapbox Layers documentation]({{root}}mapbox-map-charts/geo-vs-mapbox.html) describes how to configure Mapbox tile-based maps._
@@ -67,7 +67,7 @@ baseMapOnly |> GenericChart.toChartHTML
(***include-it-raw***)
(**
-To control the features of the map, a `Geo` object is used that can be associtaed with a given chart using the `Chart.WithGeo` function.
+To control the features of the map, a `Geo` object is used that can be associated with a given chart using the `Chart.WithGeo` function.
Here is a map with all physical features enabled and styled, at a larger-scale 1:50m resolution:
*)
open Plotly.NET.LayoutObjects
diff --git a/docs/img/logo_meta_tags.png b/docs/img/logo_meta_tags.png
new file mode 100644
index 000000000..dfbbc746e
Binary files /dev/null and b/docs/img/logo_meta_tags.png differ
diff --git a/docs/index.fsx b/docs/index.fsx
index 89c7dd739..f2e129ba5 100644
--- a/docs/index.fsx
+++ b/docs/index.fsx
@@ -27,7 +27,7 @@ Plotly.NET provides functions for generating and rendering plotly.js charts in *
**This documentation page is almost exclusively for the core F# API of Plotly.NET.**
-It should be easy to translate them into C#. However, as work on the idiomatic C# API progresses, we will privde native C# docs as well.
+It should be easy to translate them into C#. However, as work on the idiomatic C# API progresses, we will provide native C# docs as well.
### Table of contents
@@ -56,7 +56,7 @@ Plotly.NET consists of multiple packages. The two main ones are:
### For applications and libraries
-Plotly.NET packages are available on nuget to plug into your favorite package manager.
+Plotly.NET packages are available on NuGet to plug into your favorite package manager.
- dotnet CLI
@@ -101,11 +101,11 @@ the interactive extensions for dotnet interactive have you covered for seamless
_Note_:
-due to the currently fast development cycles of Dotnet Interactive, there might be increments in their versioning that renders the current version of Plotly.NET.Interactive incompatible (example [here](https://github.com/plotly/Plotly.NET/issues/67)).
+Due to the currently fast development cycles of .NET Interactive, there might be increments in their versioning that render the current version of Plotly.NET.Interactive incompatible (example [here](https://github.com/plotly/Plotly.NET/issues/67)).
If the interactive extension does not work, please file an issue and we will try to get it running again as soon as possible.
-A possible fix for this is the inclusion of Dotnet.Interactive preview package sources. To use these, add the following lines before referencning Plotly.NET.Interactive:
+A possible fix for this is the inclusion of Dotnet.Interactive preview package sources. To use these, add the following lines before referencing Plotly.NET.Interactive:
```no-hl
#i "nuget:https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json"
@@ -158,7 +158,7 @@ let myFirstStyledChart =
(**
**Attention:** Styling functions mutate 😈 the input chart, therefore possibly affecting bindings to intermediary results.
-We recommend creating a single chart for each workflow to prevent unexpected results
+We recommend creating a single chart for each workflow to prevent unexpected results.
### Displaying a chart in the browser
@@ -170,7 +170,7 @@ The `Chart.Show` function will open a browser window and render the input chart
(***do-not-eval***)
myFirstChart |> Chart.show
-(**Should render this chart in your brower:*)
+(**Should render this chart in your browser:*)
(***hide***)
myFirstChart |> GenericChart.toChartHTML
@@ -187,9 +187,9 @@ myFirstStyledChart |> GenericChart.toChartHTML
(**
-### Displaying a chart in a notbook cell output
+### Displaying a chart in a notebook cell output
-In a notebook context you usually have (at leat when running on a jupyter server like binder) no access to the browser on the machine where plotly runs on.
+In a notebook context, you usually have (at least when running on a Jupyter server like Binder) no access to the browser on the machine where plotly runs on.
That's why you can render charts directly in the cell output. Just end the cell with the chart value:
*)
@@ -208,7 +208,7 @@ Chart.Point(xData, yData)
(**
## Comparison: Usage in F# and C#
-One of the main design points of Plotly.NET it is to provide support for multiple flavors of chart generation. Here are 2 examples in different styles and languages that create an equivalent chart:
+One of the main design points of Plotly.NET is to provide support for multiple flavors of chart generation. Here are two examples in different styles and languages that create equivalent charts:
### Functional pipeline style in F#:
*)
@@ -279,7 +279,7 @@ GenericChart.ofTraceObject true trace |> GenericChart.setLayout layout
(**
### Declarative style in C# using the underlying `DynamicObj`:
-note that this works only when using the Plotly.NET core API, as the C# bindings only target the high level API.
+Note that this works only when using the Plotly.NET core API, as the C# bindings only target the high level API.
```csharp
using System;
@@ -323,8 +323,8 @@ the project and submit pull requests. If you're adding a new public API, please
consider adding [samples][docs] that can be turned into a documentation. You might
also want to read the [library design notes][readme] to understand how it works.
-The library is available under the OSI-approved MIT license, which allows modification and
-redistribution for both commercial and non-commercial purposes. For more information see the
+The library is available under the OSI-approved MIT license which allows modification and
+redistribution for both commercial and non-commercial purposes. For more information, see the
[License file][license] in the GitHub repository.
[docs]: https://github.com/plotly/Plotly.NET/tree/dev/docs
diff --git a/docs/mapbox-map-charts/choropleth-mapbox.fsx b/docs/mapbox-map-charts/choropleth-mapbox.fsx
index 565232c60..7c9e6d33b 100644
--- a/docs/mapbox-map-charts/choropleth-mapbox.fsx
+++ b/docs/mapbox-map-charts/choropleth-mapbox.fsx
@@ -37,16 +37,16 @@ Choropleth Maps display divided geographical areas or regions that are coloured,
a data variable. This provides a way to visualise values over a geographical area, which can show variation or
patterns across the displayed location.
-This choropleth map version uses [Mapbox Layers]({{root}}/6_0_geo-vs-mapbox.html). For the Geo variant, head over [here]({{root}}/5_2_choropleth-map.html)
+This choropleth map version uses [Mapbox Layers]({{root}}/6_0_geo-vs-mapbox.html). For the Geo variant, head over [here]({{root}}/5_2_choropleth-map.html).
ChoroplethMapbox charts need GeoJSON formatted data.
[GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) is an open standard format designed for representing simple geographical features, along with their non-spatial attributes.
-GeoJSON, or at least the type of GeoJSON accepted by plotly.js are `FeatureCollection`s. A feature has for example the `geometry` field, which defines e.g. the corrdinates of it (think for example the coordinates of a polygon on the map)
+GeoJSON, or at least the type of GeoJSON accepted by plotly.js are `FeatureCollection`s. A feature has for example the `geometry` field, which defines e.g. the coordinates of it (think for example the coordinates of a polygon on the map)
and the `properties` field, a key-value pair of properties of the feature.
-If you want to use GeoJSON with Plotly.NET (or any plotly flavor really), you have to know the property of the feature you are mapping your data to. In the following example this is simply the `id` of a feature, but you can access any property by `property.key`.
+If you want to use GeoJSON with Plotly.NET (or any plotly flavor really), you have to know the property of the feature you are mapping your data to. In the following example, this is simply the `id` of a feature, but you can access any property by `property.key`.
Consider the following GeoJSON:
*)
@@ -87,7 +87,7 @@ it looks like this:
It basically contains all US counties as polygons on the map. Note that the `id` property corresponds to the [**fips code**](https://en.wikipedia.org/wiki/FIPS_county_code).
-To visualize some data using these counties as locations on a choropleth map, we need some exmaple data:
+To visualize some data using these counties as locations on a choropleth map, we need some example data:
*)
// we use the awesome Deedle data frame library to parse and extract our location and z data
diff --git a/docs/mapbox-map-charts/geo-vs-mapbox.fsx b/docs/mapbox-map-charts/geo-vs-mapbox.fsx
index 1a0530a31..c3e649608 100644
--- a/docs/mapbox-map-charts/geo-vs-mapbox.fsx
+++ b/docs/mapbox-map-charts/geo-vs-mapbox.fsx
@@ -37,7 +37,7 @@ Plotly and therefore Plotly.NET supports two different kinds of maps:
- **Mapbox maps** are tile-based maps. If your figure is created with a `Chart.*Mapbox` function or otherwise contains one or more traces of type `scattermapbox`,
`choroplethmapbox` or `densitymapbox`, the layout.mapbox object in your figure contains configuration information for the map itself.
-- **Geo maps** are outline-based maps. If your figure is created with a `Chart.ScatterGeo, `Chart.PointGeo`, `Chart.LineGeo` or `Chart.Choropleth` function or
+- **Geo maps** are outline-based maps. If your figure is created with a `Chart.ScatterGeo`, `Chart.PointGeo`, `Chart.LineGeo` or `Chart.Choropleth` function or
otherwise contains one or more traces of type `scattergeo` or `choropleth`, the layout.geo object in your figure contains configuration information for the map itself.
_This page documents Mapbox tile-based maps, and the [Geo map documentation]({{root}}geo-map-charts/geo-vs-mapbox.html) describes how to configure outline-based maps_
diff --git a/docs/mapbox-map-charts/mapbox-plots.fsx b/docs/mapbox-map-charts/mapbox-plots.fsx
index c4afce098..7485ef9d4 100644
--- a/docs/mapbox-map-charts/mapbox-plots.fsx
+++ b/docs/mapbox-map-charts/mapbox-plots.fsx
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create Point and Line charts on Mapbox maps in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
@@ -119,7 +119,7 @@ let flights =
LineColor = Color.fromString "red"
))
|> Chart.combine
- |> Chart.withLegend (false)
+ |> Chart.withLayoutStyle (ShowLegend = false)
|> Chart.withMapbox (Mapbox.init (Style = StyleParam.MapboxStyle.OpenStreetMap, Center = (-97.0372, 32.8959)))
|> Chart.withMarginSize (0, 0, 50, 0)
|> Chart.withTitle "Feb. 2011 American Airline flights"
diff --git a/docs/polar-charts/polar_bar_charts.fsx b/docs/polar-charts/polar_bar_charts.fsx
index 51c6ee725..66f41bf50 100644
--- a/docs/polar-charts/polar_bar_charts.fsx
+++ b/docs/polar-charts/polar_bar_charts.fsx
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create polar bar charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
diff --git a/docs/polar-charts/polar_line-scatter-plots.fsx b/docs/polar-charts/polar_line-scatter-plots.fsx
index fa86b5065..b138defd0 100644
--- a/docs/polar-charts/polar_line-scatter-plots.fsx
+++ b/docs/polar-charts/polar_line-scatter-plots.fsx
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create polar charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -56,7 +56,7 @@ Each data point is determined by the distance from the pole (the radial coordina
## Polar point charts
-use `Chart.PointPolar` to create a polar plot that displays points on a polar coordinate system:
+Use `Chart.PointPolar` to create a polar plot that displays points on a polar coordinate system:
*)
let pointPolar = Chart.PointPolar(r = radial, theta = theta)
@@ -72,9 +72,9 @@ pointPolar |> GenericChart.toChartHTML
(**
## Polar line charts
-use `Chart.LinePolar` to create a polar plot that displays a line connecting input the data on a polar coordinate system.
+Use `Chart.LinePolar` to create a polar plot that displays a line connecting input the data on a polar coordinate system.
-You can for example change the line style using `Chart.withLineStyle`
+You can, for example, change the line style using `Chart.withLineStyle`
*)
let linePolar =
@@ -93,9 +93,9 @@ linePolar |> GenericChart.toChartHTML
(**
## Polar Spline charts
-use `Chart.SpinePolar` to create a polar plot that displays a smoothed line connecting input the data on a polar coordinate system.
+Use `Chart.SpinePolar` to create a polar plot that displays a smoothed line connecting input the data on a polar coordinate system.
-As for all other plots above, You can for example add labels to each datum:
+As for all other plots above, you can, for example, add labels to each datum:
*)
let splinePolar =
diff --git a/docs/polar-charts/styling_polar_layouts.fsx b/docs/polar-charts/styling_polar_layouts.fsx
index 4c29c7fbe..78dc10bea 100644
--- a/docs/polar-charts/styling_polar_layouts.fsx
+++ b/docs/polar-charts/styling_polar_layouts.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to style polar layouts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
@@ -65,7 +65,7 @@ combinedPolar |> GenericChart.toChartHTML
(**
## Styling the polar layout
-Use the `Chart.withPolar` function and initialize a Polar layout with the desired looks
+Use the `Chart.withPolar` function and initialize a Polar layout with the desired looks:
*)
open Plotly.NET.LayoutObjects
diff --git a/docs/simple-charts/area-plots.fsx b/docs/simple-charts/area-plots.fsx
index 6c8aa75c3..3c8b8bcb9 100644
--- a/docs/simple-charts/area-plots.fsx
+++ b/docs/simple-charts/area-plots.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create area charts, area charts with splines, and stackes area charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
diff --git a/docs/simple-charts/bar-and-column-charts.fsx b/docs/simple-charts/bar-and-column-charts.fsx
index 8876d868d..252a33414 100644
--- a/docs/simple-charts/bar-and-column-charts.fsx
+++ b/docs/simple-charts/bar-and-column-charts.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create bar and a column charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
@@ -80,7 +80,7 @@ bar |> GenericChart.toChartHTML
The following example shows how to create a stacked bar chart by combining bar charts created by combining multiple `Chart.StackedBar` charts:
-Basically those charts are just normal bar/column charts with the Layout property `BarMode` set to `Stack`. You can do this yourself by changing the Chart layout.
+Basically, those charts are just normal bar/column charts with the Layout property `BarMode` set to `Stack`. You can do this yourself by changing the Chart layout.
### Stacked bar Charts
*)
diff --git a/docs/simple-charts/bubble-charts.fsx b/docs/simple-charts/bubble-charts.fsx
index 3a59d90e4..6e455ae13 100644
--- a/docs/simple-charts/bubble-charts.fsx
+++ b/docs/simple-charts/bubble-charts.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create bubble charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
diff --git a/docs/simple-charts/heatmaps.fsx b/docs/simple-charts/heatmaps.fsx
index a69bd1f46..3e0879355 100644
--- a/docs/simple-charts/heatmaps.fsx
+++ b/docs/simple-charts/heatmaps.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create heatmap charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -50,7 +50,7 @@ A heatmap chart can be created using the `Chart.Heatmap` functions.
When creating heatmap charts, it is usually desirable to provide the values in matrix form, rownames and colnames.
-A heatmap needs at least 2 dimensional data that represents the z dimension. the X and Y dimension sizes can be inferred from the z data:
+A heatmap needs at least two-dimensional data that represents the z dimension. The X and Y dimension sizes can be inferred from the z data:
*)
// Generating the Heatmap with only z Data
@@ -68,7 +68,7 @@ heat1 |> GenericChart.toChartHTML
(**
## Inverting the Y Axis
-Per default, the y axis starts at the origin of the X/Y plane.
+By default, the y axis starts at the origin of the X/Y plane.
If it is however desired to represent a 2D matrix exactly how it is notated, invert the YAxis by setting `ReverseYAxis`.
*)
@@ -110,7 +110,7 @@ heat3 |> GenericChart.toChartHTML
(**
## Annotated Heatmaps
-use `Chart.AnnotatedHeatmap` to add an annotation text to each z value:
+Use `Chart.AnnotatedHeatmap` to add an annotation text to each z value:
*)
let heat4 =
diff --git a/docs/simple-charts/images.fsx b/docs/simple-charts/images.fsx
index 6b97f1963..9cf56426e 100644
--- a/docs/simple-charts/images.fsx
+++ b/docs/simple-charts/images.fsx
@@ -33,9 +33,10 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create image charts in F#.
There are multiple ways of generating image charts:
- - From 3 Dimensional color collections, where the inner arrays contain 3 (color dimensions without alpha channel) or 4 (color dimensions and alpha channel) values. The color model can be set separately as shown below.
- - From a 2 dimensional collection Plotly.NETs `ARGB` type that represents rgba values
- - From a base64 encoded image data source
+
+- From three-dimensional color collections, where the inner arrays contain 3 (color dimensions without alpha channel) or 4 (color dimensions and alpha channel) values. The color model can be set separately as shown below.
+- From a two-dimensional collection Plotly.NETs `ARGB` type that represents rgba values
+- From a base64 encoded image data source
## Creating Image charts from raw color arrays
*)
@@ -62,7 +63,7 @@ imageRaw |> GenericChart.toChartHTML
(***include-it-raw***)
(**
-To change the color model to HSL for example, add the `ColorModel` argument:
+To change the color model to HSL, for example, add the `ColorModel` argument:
*)
let imageRawHSL =
diff --git a/docs/simple-charts/line-scatter-plots.fsx b/docs/simple-charts/line-scatter-plots.fsx
index 7cfe9b49c..b2c2444cc 100644
--- a/docs/simple-charts/line-scatter-plots.fsx
+++ b/docs/simple-charts/line-scatter-plots.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create line and point charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -47,7 +47,7 @@ A line or a point chart can be created using the `Chart.Line` and `Chart.Point`
## Chart.Line with LineStyle
-The following example generates a line Plot containing X and Y values and applies a line style to it.
+The following example generates a line plot containing X and Y values and applies a line style to it.
*)
let line1 =
@@ -117,10 +117,10 @@ spline2 |> GenericChart.toChartHTML
(**
## Point chart with text label
-The following example calls the `Chart.Point` function to generate a scatter Plot containing X and Y values.
-Addtionally, text labels are added .
+The following example calls the `Chart.Point` function to generate a scatter plot containing X and Y values.
+Additionally, text labels are added.
-If `TextPosition` is set the labels are drawn otherwise only shown when hovering over the points.
+If `TextPosition` is set, the labels are drawn, otherwise only shown when hovering over the points.
*)
diff --git a/docs/simple-charts/multicategory.fsx b/docs/simple-charts/multicategory.fsx
index 1b25ce8b1..f0da1fc04 100644
--- a/docs/simple-charts/multicategory.fsx
+++ b/docs/simple-charts/multicategory.fsx
@@ -46,9 +46,9 @@ Since Plotly.NET v4, multicategory data are supported on the following 2D charts
## Scatter
-Note that this does not apply to all derived Charts such as `Chart.Point`, `Chart.Line`, `Chart.Bubble`, `Chart.Spline` etc. (to avoid creating dozens ov overloads for scatter derived traces)
+Note that this does not apply to all derived Charts such as `Chart.Point`, `Chart.Line`, `Chart.Bubble`, `Chart.Spline` etc. (to avoid creating dozens of overloads for scatter derived traces).
-You can however design those yourself using Chart.Scatter, here are some examples:
+You can, however, design those yourself using Chart.Scatter. Here are some examples:
*)
open Plotly.NET
open System
diff --git a/docs/simple-charts/pie-doughnut-charts.fsx b/docs/simple-charts/pie-doughnut-charts.fsx
index 835328ec6..0dfa5d253 100644
--- a/docs/simple-charts/pie-doughnut-charts.fsx
+++ b/docs/simple-charts/pie-doughnut-charts.fsx
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create pie and doughnut charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
@@ -74,7 +74,7 @@ doughnut1 |> GenericChart.toChartHTML
(**
## More styled example
-This example shows the usage of some of the styling possibility using `Chart.Pie`.
+This example shows the usage of some of the styling options using `Chart.Pie`.
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Pie`
*)
diff --git a/docs/simple-charts/range-plots.fsx b/docs/simple-charts/range-plots.fsx
index e10c00062..2363f4588 100644
--- a/docs/simple-charts/range-plots.fsx
+++ b/docs/simple-charts/range-plots.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create Range plot charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -74,7 +74,7 @@ range1 |> GenericChart.toChartHTML
(**
## More styled example
-This example shows the usage of some of the styling possibility using `Chart.Range`.
+This example shows the usage of some of the styling options using `Chart.Range`.
*)
open Plotly.NET.TraceObjects
diff --git a/docs/simple-charts/table.fsx b/docs/simple-charts/table.fsx
index df125a384..5c4b47a0b 100644
--- a/docs/simple-charts/table.fsx
+++ b/docs/simple-charts/table.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
This example shows how to create tables in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
diff --git a/docs/smith-charts/smith_line_scatter_plots.fsx b/docs/smith-charts/smith_line_scatter_plots.fsx
index ea553d5d6..c09876fca 100644
--- a/docs/smith-charts/smith_line_scatter_plots.fsx
+++ b/docs/smith-charts/smith_line_scatter_plots.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create smith charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -45,7 +45,7 @@ let real = [ 0.5; 1.; 2.; 3. ]
let imaginary = [ 0.5; 1.; 2.; 3. ]
(**
-The Smith chart, invented by Phillip H. Smith (1905�1987) and independently by Mizuhashi Tosaku, is a graphical calculator or nomogram designed for electrical and electronics engineers specializing in radio frequency (RF) engineering to assist in solving problems with transmission lines and matching circuits
+The Smith chart, invented by Phillip H. Smith (1905-1987) and independently by Mizuhashi Tosaku, is a graphical calculator or nomogram designed for electrical and electronics engineers specializing in radio frequency (RF) engineering to assist in solving problems with transmission lines and matching circuits
The Smith chart is a mathematical transformation of the two-dimensional Cartesian complex plane. Complex numbers with positive real parts map inside the circle. Those with negative real parts map outside the circle. If we are dealing only with impedances with non-negative resistive components, our interest is focused on the area inside the circle.
@@ -55,7 +55,7 @@ Still, you can plot any kind of imaginary numbers on this plane.
## point smith charts
-use `Chart.PointSmith` to create a chart that displays points on a smith subplot:
+Use `Chart.PointSmith` to create a chart that displays points on a smith subplot:
*)
let pointSmith = Chart.PointSmith(real, imaginary)
@@ -71,7 +71,7 @@ pointSmith |> GenericChart.toChartHTML
(**
## line smith charts
-use `Chart.LineSmith` to create a plot that displays a line connecting the data on a smith subplot.
+Use `Chart.LineSmith` to create a plot that displays a line connecting the data on a smith subplot.
This example also changes the styles of the line.
*)
@@ -97,9 +97,9 @@ lineSmith |> GenericChart.toChartHTML
(**
## bubble smith charts
-use `Chart.BubbleSmith` to create a plot that displays datums on a smith subplot, with an additional 3rd dimension set as the marker size.
+Use `Chart.BubbleSmith` to create a plot that displays datums on a smith subplot, with an additional 3rd dimension set as the marker size.
-As for all other plots above, You can for example add labels to each datum:
+As for all other plots above, you can, for example, add labels to each datum:
*)
let bubbleSmith =
diff --git a/docs/ternary-charts/styling_ternary_layouts.fsx b/docs/ternary-charts/styling_ternary_layouts.fsx
index c19fb1b25..18e34995c 100644
--- a/docs/ternary-charts/styling_ternary_layouts.fsx
+++ b/docs/ternary-charts/styling_ternary_layouts.fsx
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to style polar layouts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
open Plotly.NET
@@ -67,7 +67,7 @@ combinedTernary |> GenericChart.toChartHTML
(**
## Styling the polar layout
-Use the `Chart.withTernary` function and initialize a Ternary layout with the desired looks
+Use the `Chart.withTernary` function and initialize a Ternary layout with the desired looks:
*)
open Plotly.NET.LayoutObjects
diff --git a/docs/ternary-charts/ternary_line_scatter_plots.fsx b/docs/ternary-charts/ternary_line_scatter_plots.fsx
index 85ca51b27..45a3e4dd4 100644
--- a/docs/ternary-charts/ternary_line_scatter_plots.fsx
+++ b/docs/ternary-charts/ternary_line_scatter_plots.fsx
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create ternary charts in F#.
-let's first create some data for the purpose of creating example charts:
+Let's first create some data for the purpose of creating example charts:
*)
@@ -61,7 +61,7 @@ Ternary plots are tools for analyzing compositional data in the three-dimensiona
## Ternary point charts
-use `Chart.PointTernary` to create a ternary plot that displays points on a ternary coordinate system:
+Use `Chart.PointTernary` to create a ternary plot that displays points on a ternary coordinate system:
*)
let ternaryPoint = Chart.PointTernary(A = a, B = b, C = c)
@@ -77,11 +77,11 @@ ternaryPoint |> GenericChart.toChartHTML
(**
## Ternary line charts
-use `Chart.LineTernary` to create a ternary plot that displays a line connecting input the data on a ternary coordinate system:
+Use `Chart.LineTernary` to create a ternary plot that displays a line connecting input the data on a ternary coordinate system.
-As values on ternary plots sum to a constant, you can omit one dimension ofd the data by providing that sum.
+As values on ternary plots sum to a constant, you can omit one dimension of the data by providing that sum.
-You can also for example change the line style using `Chart.withLineStyle`
+You can also, for example, change the line style using `Chart.withLineStyle`:
*)
let lineTernary =
diff --git a/global.json b/global.json
index 74536f9a3..b2ede13ce 100644
--- a/global.json
+++ b/global.json
@@ -1,6 +1,6 @@
{
"sdk": {
- "version": "6.0.100",
+ "version": "8.0.100",
"rollForward": "latestMinor"
}
}
\ No newline at end of file
diff --git a/src/Plotly.NET.CSharp/ChartAPI/Chart.cs b/src/Plotly.NET.CSharp/ChartAPI/Chart.cs
index 0e5e5ffee..13db2dac3 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/Chart.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/Chart.cs
@@ -12,10 +12,10 @@ namespace Plotly.NET.CSharp
{
public static partial class Chart
{
- public static GenericChart.GenericChart Combine(IEnumerable
gCharts) => Plotly.NET.Chart.Combine(gCharts);
+ public static GenericChart Combine(IEnumerable gCharts) => Plotly.NET.Chart.Combine(gCharts);
- public static GenericChart.GenericChart Invisible() => Plotly.NET.Chart.Invisible();
+ public static GenericChart Invisible() => Plotly.NET.Chart.Invisible();
///
/// Creates a subplot grid with the given dimensions (nRows x nCols) for the input charts.
@@ -23,6 +23,9 @@ public static partial class Chart
/// The charts to display on the grid.
/// The number of rows in the grid. If you provide a 2D `subplots` array or a `yaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
/// The number of columns in the grid. If you provide a 2D `subplots` array, the length of its longest row is used as the default. If you give an `xaxes` array, its length is used as the default. But it's also possible to have a different length, if you want to leave a row at the end for non-cartesian subplots.
+ /// A collection of titles for the individual subplots.
+ /// The font of the subplot titles
+ /// A vertical offset applied to each subplot title, moving it upwards if positive and vice versa
/// Used for freeform grids, where some axes may be shared across subplots but others are not. Each entry should be a cartesian subplot id, like "xy" or "x3y2", or "" to leave that cell empty. You may reuse x axes within the same column, and y axes within the same row. Non-cartesian subplots and traces that support `domain` can place themselves in this grid separately using the `gridcell` attribute.
/// Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an y axis id like "y", "y2", etc., or "" to not put a y axis in that row. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `xaxes` is present, will generate consecutive IDs.
/// Used with `yaxes` when the x and y axes are shared across columns and rows. Each entry should be an x axis id like "x", "x2", etc., or "" to not put an x axis in that column. Entries other than "" must be unique. Ignored if `subplots` is present. If missing but `yaxes` is present, will generate consecutive IDs.
@@ -33,10 +36,13 @@ public static partial class Chart
/// Sets the domains of this grid subplot (in plot fraction). The first and last cells end exactly at the domain edges, with no grout around the edges.
/// Sets where the x axis labels and titles go. "bottom" means the very bottom of the grid. "bottom plot" is the lowest plot that each x axis is used in. "top" and "top plot" are similar.
/// Sets where the y axis labels and titles go. "left" means the very left edge of the grid. "left plot" is the leftmost plot that each y axis is used in. "right" and "right plot" are similar.
- public static GenericChart.GenericChart Grid(
- IEnumerable gCharts,
+ public static GenericChart Grid(
+ IEnumerable gCharts,
int nRows,
int nCols,
+ Optional> SubPlotTitles = default,
+ Optional SubPlotTitleFont = default,
+ Optional SubPlotTitleOffset = default,
Optional[][]> SubPlots = default,
Optional XAxes = default,
Optional YAxes = default,
@@ -48,9 +54,12 @@ public static GenericChart.GenericChart Grid(
Optional XSide = default,
Optional YSide = default
) =>
- Plotly.NET.Chart.Grid>(
+ Plotly.NET.Chart.Grid,IEnumerable>(
nRows: nRows,
nCols: nCols,
+ SubPlotTitles: SubPlotTitles.ToOption(),
+ SubPlotTitleFont: SubPlotTitleFont.ToOption(),
+ SubPlotTitleOffset: SubPlotTitleOffset.ToOption(),
SubPlots: SubPlots.ToOption(),
XAxes: XAxes.ToOption(),
YAxes: YAxes.ToOption(),
diff --git a/src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs b/src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs
index 7b6ea3966..7c7145718 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs
@@ -46,7 +46,7 @@ public static partial class Chart
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Scatter(
+ public static GenericChart Scatter(
IEnumerable x,
IEnumerable y,
StyleParam.Mode mode,
@@ -137,7 +137,7 @@ public static GenericChart.GenericChart Scatter(
/// Sets the normalization for the sum of this `stackgroup. Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Point(
+ public static GenericChart Point(
IEnumerable x,
IEnumerable y,
Optional Name = default,
@@ -218,7 +218,7 @@ public static GenericChart.GenericChart Point(
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Line(
+ public static GenericChart Line(
IEnumerable x,
IEnumerable y,
Optional ShowMarkers = default,
@@ -317,7 +317,7 @@ public static GenericChart.GenericChart Line(
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Spline(
+ public static GenericChart Spline(
IEnumerable x,
IEnumerable y,
Optional ShowMarkers = default,
@@ -414,7 +414,7 @@ public static GenericChart.GenericChart Spline(
/// Sets the normalization for the sum of this `stackgroup. Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Bubble(
+ public static GenericChart Bubble(
IEnumerable x,
IEnumerable y,
IEnumerable sizes,
@@ -518,7 +518,7 @@ public static GenericChart.GenericChart Bubble(
/// Sets the line for the upper Y values.
/// Sets the marker for the upper Y values.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Range(
+ public static GenericChart Range(
IEnumerable x,
IEnumerable y,
IEnumerable upper,
@@ -600,6 +600,48 @@ public static GenericChart.GenericChart Range(
UpperName: UpperName.ToOption(),
UseDefaults: UseDefaults.ToOption()
);
+
+ /// Creates a Pareto chart.
+ /// Sets the (key,value) pairs that are plotted as the size and key of each bar.
+ /// Sets the trace name. The trace name appear as the legend item and on hover
+ /// Sets the y axis label.
+ /// Determines whether or not grid lines are drawn. If "true", the grid lines are drawn for the pareto distribution figure; defaults to true.
+ public static GenericChart Pareto(
+ IEnumerable<(TLabel,double)> keysValues
+ , Optional Name
+ , Optional Label
+ , Optional ShowGrid
+ )
+ where TLabel : IConvertible
+ =>
+ Chart2D.Chart.Pareto(
+ keysValues.Select(t => t.ToTuple())
+ , Name: Name.ToOption()
+ , Label: Label.ToOption()
+ , ShowGrid: ShowGrid.ToOption()
+ );
+ /// Creates a Pareto chart.
+ /// Sets the labels that are matching the .
+ /// Sets the values that are plotted as the size of each bar.
+ /// Sets the trace name. The trace name appear as the legend item and on hover
+ /// Sets the y axis label.
+ /// Determines whether or not grid lines are drawn. If "true", the grid lines are drawn for the pareto distribution figure; defaults to true.
+ public static GenericChart Pareto(
+ IEnumerable labels
+ , IEnumerable values
+ , Optional Name
+ , Optional Label
+ , Optional ShowGrid
+ )
+ where TLabel : IConvertible
+ =>
+ Chart2D.Chart.Pareto(
+ labels
+ , values
+ , Name: Name.ToOption()
+ , Label: Label.ToOption()
+ , ShowGrid: ShowGrid.ToOption()
+ );
/// Creates an Area chart, which uses a Line plotted between the given datums in a 2D space, additionally colouring the area between the line and the Y Axis.
/// Sets the x coordinates of the plotted data.
@@ -630,7 +672,7 @@ public static GenericChart.GenericChart Range(
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Area(
+ public static GenericChart Area(
IEnumerable x,
IEnumerable y,
Optional ShowMarkers = default,
@@ -725,7 +767,7 @@ public static GenericChart.GenericChart Area(
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart SplineArea(
+ public static GenericChart SplineArea(
IEnumerable x,
IEnumerable y,
Optional ShowMarkers = default,
@@ -820,7 +862,7 @@ public static GenericChart.GenericChart SplineArea(
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart StackedArea(
+ public static GenericChart StackedArea(
IEnumerable x,
IEnumerable y,
Optional ShowMarkers = default,
@@ -914,7 +956,7 @@ public static GenericChart.GenericChart StackedArea(
/// Sets the font used for `text` lying inside the bar.
/// Sets the font used for `text` lying outside the bar.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Funnel(
+ public static GenericChart Funnel(
IEnumerable x,
IEnumerable y,
Optional Name = default,
@@ -1007,7 +1049,7 @@ public static GenericChart.GenericChart Funnel(
/// Sets the font used for `text` lying inside the bar.
/// Sets the font used for `text` lying outside the bar.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart StackedFunnel(
+ public static GenericChart StackedFunnel(
IEnumerable x,
IEnumerable y,
Optional Name = default,
@@ -1098,7 +1140,7 @@ public static GenericChart.GenericChart StackedFunnel(
/// Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
/// Only relevant when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`. Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Waterfall(
+ public static GenericChart Waterfall(
IEnumerable x,
IEnumerable y,
Optional Name = default,
@@ -1183,7 +1225,7 @@ public static GenericChart.GenericChart Waterfall(
/// Sets the position of text associated with each datum
/// Sets the position of text associated with individual datum
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Bar(
+ public static GenericChart Bar(
IEnumerable values,
Optional> Keys = default,
Optional Name = default,
@@ -1261,7 +1303,7 @@ public static GenericChart.GenericChart Bar(
/// Sets the position of text associated with each datum
/// Sets the position of text associated with individual datum
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart StackedBar(
+ public static GenericChart StackedBar(
IEnumerable values,
Optional> Keys = default,
Optional Name = default,
@@ -1338,7 +1380,7 @@ public static GenericChart.GenericChart StackedBarSets the position of text associated with each datum
/// Sets the position of text associated with individual datum
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Column(
+ public static GenericChart Column(
IEnumerable values,
Optional> Keys = default,
Optional Name = default,
@@ -1417,7 +1459,7 @@ public static GenericChart.GenericChart Column(
/// Sets the position of text associated with each datum
/// Sets the position of text associated with individual datum
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart StackedColumn(
+ public static GenericChart StackedColumn(
IEnumerable values,
Optional> Keys = default,
Optional Name = default,
@@ -1501,7 +1543,7 @@ public static GenericChart.GenericChart StackedColumnSets whether and how the cumulative distribution is displayed
/// Sets the style of the hoverlabels of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Histogram(
+ public static GenericChart Histogram(
Optional> X = default,
Optional> Y = default,
Optional Orientation = default,
@@ -1585,7 +1627,7 @@ public static GenericChart.GenericChart Histogram(
/// Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
/// Picks a smoothing algorithm use to smooth `z` data.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Histogram2D(
+ public static GenericChart Histogram2D(
IEnumerable x,
IEnumerable y,
Optional>> Z = default,
@@ -1666,7 +1708,7 @@ public static GenericChart.GenericChart Histogram2D(
/// Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es).
/// Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publications/jse/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BoxPlot(
+ public static GenericChart BoxPlot(
Optional> X = default,
Optional> Y = default,
Optional Name = default,
@@ -1764,7 +1806,7 @@ public static GenericChart.GenericChart BoxPlot(
/// Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to "manual".
/// Sets the method by which the span in data space where the density function will be computed. "soft" means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. "hard" means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode "manual" and fill in the `span` attribute.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Violin(
+ public static GenericChart Violin(
Optional> X = default,
Optional> Y = default,
Optional Name = default,
@@ -1869,7 +1911,7 @@ public static GenericChart.GenericChart Violin(
/// Sets the style of the contours
/// Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "true" or if `contours.size` is missing.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Histogram2DContour(
+ public static GenericChart Histogram2DContour(
IEnumerable x,
IEnumerable y,
Optional Name = default,
@@ -1919,10 +1961,10 @@ public static GenericChart.GenericChart Histogram2DContour(
YBinGroup: YBinGroup.ToOption(),
YBins: YBins.ToOption(),
Marker: Marker.ToOption(),
- ContourLineColor: ContourLineColor.ToOption(),
- ContourLineDash: ContourLineDash.ToOption(),
- ContourLineSmoothing: ContourLineSmoothing.ToOption(),
- ContourLine: ContourLine.ToOption(),
+ ContourLinesColor: ContourLineColor.ToOption(),
+ ContourLinesDash: ContourLineDash.ToOption(),
+ ContourLinesSmoothing: ContourLineSmoothing.ToOption(),
+ ContourLines: ContourLine.ToOption(),
ColorBar: ColorBar.ToOption(),
ColorScale: ColorScale.ToOption(),
ShowScale: ShowScale.ToOption(),
@@ -1956,7 +1998,7 @@ public static GenericChart.GenericChart Histogram2DContour(
/// Whether or not to use WebGL to render this trace
/// Whether or not to reverse the y axis. If true, (0,0) will lie on the top left and increase downwards.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Heatmap(
+ public static GenericChart Heatmap(
IEnumerable> zData,
Optional Name = default,
Optional ShowLegend = default,
@@ -2031,7 +2073,7 @@ public static GenericChart.GenericChart Heatmap(
/// Whether or not to use WebGL to render this trace
/// Whether or not to reverse the y axis. If true, (0,0) will lie on the top left and increase downwards.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart AnnotatedHeatmap(
+ public static GenericChart AnnotatedHeatmap(
IEnumerable> zData,
IEnumerable> annotationText,
Optional Name = default,
@@ -2095,7 +2137,7 @@ public static GenericChart.GenericChart AnnotatedHeatmapSets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
/// Picks a smoothing algorithm use to smooth `z` data.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Image(
+ public static GenericChart Image(
Optional>>> Z = default,
Optional Source = default,
Optional Name = default,
@@ -2157,7 +2199,7 @@ public static GenericChart.GenericChart Image(
/// Sets the fill color if `contours.type` is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "true" or if `contours.size` is missing.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Contour(
+ public static GenericChart Contour(
IEnumerable> zData,
Optional Name = default,
Optional ShowLegend = default,
@@ -2204,15 +2246,15 @@ public static GenericChart.GenericChart Contour(
ShowScale: ShowScale.ToOption(),
ReverseScale: ReverseScale.ToOption(),
Transpose: Transpose.ToOption(),
- ContourLineColor: ContourLineColor.ToOption(),
- ContourLineDash: ContourLineDash.ToOption(),
- ContourLineSmoothing: ContourLineSmoothing.ToOption(),
- ContourLine: ContourLine.ToOption(),
+ ContourLinesColor: ContourLineColor.ToOption(),
+ ContourLinesDash: ContourLineDash.ToOption(),
+ ContourLinesSmoothing: ContourLineSmoothing.ToOption(),
+ ContourLines: ContourLine.ToOption(),
ContoursColoring: ContoursColoring.ToOption(),
ContoursOperation: ContoursOperation.ToOption(),
ContoursType: ContoursType.ToOption(),
- ShowContourLabels: ShowContourLabels.ToOption(),
- ContourLabelFont: ContourLabelFont.ToOption(),
+ ShowContoursLabels: ShowContourLabels.ToOption(),
+ ContoursLabelFont: ContourLabelFont.ToOption(),
Contours: Contours.ToOption(),
FillColor: FillColor.ToOption(),
NContours: NContours.ToOption(),
@@ -2242,7 +2284,7 @@ public static GenericChart.GenericChart Contour(
/// Sets the style options of decreasing values (use this for more finegrained control than the other increasing-associated arguments).
/// Sets the width of the open/close tick marks relative to the "x" minimal interval.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart OHLC(
+ public static GenericChart OHLC(
IEnumerable open,
IEnumerable high,
IEnumerable low,
@@ -2307,7 +2349,7 @@ public static GenericChart.GenericChart OHLC(
/// Sets the style options of decreasing values (use this for more finegrained control than the other increasing-associated arguments).
/// Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Candlestick(
+ public static GenericChart Candlestick(
IEnumerable open,
IEnumerable high,
IEnumerable low,
@@ -2372,7 +2414,7 @@ public static GenericChart.GenericChart Candlestick(
/// Determines whether or not subplots on the lower half from the diagonal are displayed.
/// Determines whether or not subplots on the upper half from the diagonal are displayed.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Splom(
+ public static GenericChart Splom(
IEnumerable dimensions,
Optional Name = default,
Optional ShowLegend = default,
@@ -2439,7 +2481,7 @@ public static GenericChart.GenericChart Splom(
/// Sets the colorscale of the histogram2dcontour trace.
/// whether or not to show the colorbar
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointDensity(
+ public static GenericChart PointDensity(
IEnumerable x,
IEnumerable y,
Optional PointOpacity = default,
@@ -2470,12 +2512,12 @@ public static GenericChart.GenericChart PointDensity(
PointMarkerColor: PointMarkerColor.ToOption(),
PointMarkerSymbol: PointMarkerSymbol.ToOption(),
PointMarkerSize: PointMarkerSize.ToOption(),
- ContourLineColor: ContourLineColor.ToOption(),
- ContourLineSmoothing: ContourLineSmoothing.ToOption(),
- ContourLineWidth: ContourLineWidth.ToOption(),
+ ContourLinesColor: ContourLineColor.ToOption(),
+ ContourLinesSmoothing: ContourLineSmoothing.ToOption(),
+ ContourLinesWidth: ContourLineWidth.ToOption(),
ShowContourLines: ShowContourLines.ToOption(),
- ShowContourLabels: ShowContourLabels.ToOption(),
- ContourColoring: ContourColoring.ToOption(),
+ ShowContoursLabels: ShowContourLabels.ToOption(),
+ ContoursColoring: ContourColoring.ToOption(),
NContours: NContours.ToOption(),
HistNorm: HistNorm.ToOption(),
ContourOpacity: ContourOpacity.ToOption(),
diff --git a/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs b/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs
index a374a5f55..add74c53b 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs
@@ -45,7 +45,7 @@ public static partial class Chart
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// Sets the projection of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Scatter3D(
+ public static GenericChart Scatter3D(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -129,7 +129,7 @@ public static GenericChart.GenericChart Scatter3D
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// Sets the projection of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Point3D(
+ public static GenericChart Point3D(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -207,7 +207,7 @@ public static GenericChart.GenericChart Point3D(
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// Sets the projection of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Line3D(
+ public static GenericChart Line3D(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -292,7 +292,7 @@ public static GenericChart.GenericChart Line3D(
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// Sets the projection of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Bubble3D(
+ public static GenericChart Bubble3D(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -351,7 +351,7 @@ public static GenericChart.GenericChart Bubble3D(
/// Coordinates in `x` and `y` can either be 1D arrays or 2D arrays (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step.
/// The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a 2D array, where its bounds can be controlled using `cmin` and `cmax`.
///
- /// 2 dimensional data array representing the surface's z values
+ /// Two-dimensional data array representing the surface's z values
/// Sets the x coordinates.
/// Sets the y coordinates.
/// Sets the trace name. The trace name appear as the legend item and on hover
@@ -363,7 +363,7 @@ public static GenericChart.GenericChart Bubble3D(
/// Sets the colorscale of the surface
/// Whether or not to show the colorbar/colorscale
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Surface(
+ public static GenericChart Surface(
IEnumerable> zData,
Optional> X = default,
Optional> Y = default,
@@ -429,7 +429,7 @@ public static GenericChart.GenericChart Surface(
/// Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
/// Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Mesh3D(
+ public static GenericChart Mesh3D(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -508,7 +508,7 @@ public static GenericChart.GenericChart Mesh3DDetermines whether `sizeref` is set as a "scaled" (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as "absolute" value (in the same units as the vector field).
/// Sets the cones' anchor with respect to their x/y/z positions. Note that "cm" denote the cone's center of mass which corresponds to 1/4 from the tail to tip.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Cone(
+ public static GenericChart Cone(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -585,7 +585,7 @@ public static GenericChart.GenericChart ConeThe maximum number of displayed segments in a streamtube.
/// Use this object to specify custom tube start positions
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart StreamTube(
+ public static GenericChart StreamTube(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -659,7 +659,7 @@ public static GenericChart.GenericChart StreamTubeSets the surface.
/// Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Volume(
+ public static GenericChart Volume(
IEnumerable x,
IEnumerable y,
IEnumerable z,
@@ -737,7 +737,7 @@ public static GenericChart.GenericChart VolumeAdds Slices through the volume
/// Sets the surface.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart IsoSurface(
+ public static GenericChart IsoSurface(
IEnumerable x,
IEnumerable y,
IEnumerable z,
diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartCarpet.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartCarpet.cs
index 30fbc658f..246d07e35 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/ChartCarpet.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/ChartCarpet.cs
@@ -45,7 +45,7 @@ public static partial class Chart
/// Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
/// The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been omitted.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Carpet(
+ public static GenericChart Carpet(
string carpetId,
Optional Name = default,
Optional ShowLegend = default,
@@ -124,7 +124,7 @@ public static GenericChart.GenericChart Carpetsets the drawing style of the line
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ScatterCarpet(
+ public static GenericChart ScatterCarpet(
IEnumerable a,
IEnumerable b,
StyleParam.Mode mode,
@@ -206,7 +206,7 @@ public static GenericChart.GenericChart ScatterCarpet(
/// Sets the marker symbol for each individual datum
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointCarpet(
+ public static GenericChart PointCarpet(
IEnumerable a,
IEnumerable b,
string carpetAnchorId,
@@ -282,7 +282,7 @@ public static GenericChart.GenericChart PointCarpet(
/// sets the drawing style of the line
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart LineCarpet(
+ public static GenericChart LineCarpet(
IEnumerable a,
IEnumerable b,
string carpetAnchorId,
@@ -372,7 +372,7 @@ public static GenericChart.GenericChart LineCarpet(
/// sets the drawing style of the line
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart SplineCarpet(
+ public static GenericChart SplineCarpet(
IEnumerable a,
IEnumerable b,
string carpetAnchorId,
@@ -464,7 +464,7 @@ public static GenericChart.GenericChart SplineCarpet(
/// sets the drawing style of the line
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BubbleCarpet(
+ public static GenericChart BubbleCarpet(
IEnumerable a,
IEnumerable b,
IEnumerable sizes,
@@ -551,7 +551,7 @@ public static GenericChart.GenericChart BubbleCarpet(
/// Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.
/// Sets the styles of the contours (use this for more finegrained control than the other contour-associated arguments).
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ContourCarpet(
+ public static GenericChart ContourCarpet(
IEnumerable z,
string carpetAnchorId,
Optional Name = default,
diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs
index a9eba300c..354e756ef 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs
@@ -41,7 +41,7 @@ public static partial class Chart
/// Instead of the first slice starting at 12 o'clock, rotate to some other angle.
/// Determines whether or not the sectors are reordered from largest to smallest.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Pie(
+ public static GenericChart Pie(
IEnumerable values,
Optional Name = default,
Optional ShowLegend = default,
@@ -127,7 +127,7 @@ public static GenericChart.GenericChart Pie(
/// Instead of the first slice starting at 12 o'clock, rotate to some other angle.
/// Determines whether or not the sectors are reordered from largest to smallest.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Doughnut(
+ public static GenericChart Doughnut(
IEnumerable values,
Optional Name = default,
Optional ShowLegend = default,
@@ -210,7 +210,7 @@ public static GenericChart.GenericChart Doughnut
///
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart FunnelArea(
+ public static GenericChart FunnelArea(
IEnumerable values,
Optional Name = default,
Optional ShowLegend = default,
@@ -293,7 +293,7 @@ public static GenericChart.GenericChart FunnelAreaRotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o'clock.
/// Determines whether or not the sectors are reordered from largest to smallest.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Sunburst(
+ public static GenericChart Sunburst(
IEnumerable labels,
IEnumerable parents,
Optional> Values = default,
@@ -399,7 +399,7 @@ public static GenericChart.GenericChart SunburstSets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.
/// Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Treemap(
+ public static GenericChart Treemap(
IEnumerable labels,
IEnumerable parents,
Optional> Values = default,
@@ -490,7 +490,7 @@ public static GenericChart.GenericChart TreemapSets the range font of this trace.
/// Sets the tick font of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ParallelCoord(
+ public static GenericChart ParallelCoord(
IEnumerable dimensions,
Optional Name = default,
Optional LineColor = default,
@@ -545,7 +545,7 @@ public static GenericChart.GenericChart ParallelCoord(
/// Sets the label font of this trace.
/// Sets the tick font of this trace.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ParallelCategories(
+ public static GenericChart ParallelCategories(
IEnumerable dimensions,
Optional Name = default,
Optional Counts = default,
@@ -598,7 +598,7 @@ public static GenericChart.GenericChart ParallelCategories(
/// Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
/// Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Sankey(
+ public static GenericChart Sankey(
SankeyNodes nodes,
SankeyLinks links,
Optional Name = default,
@@ -628,7 +628,7 @@ public static GenericChart.GenericChart Sankey(
///
/// Creates a table.
///
- /// The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a row-major order per default, ie. the grid is represented as a vector of row vectors.
+ /// The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a row-major order by default, ie. the grid is represented as a vector of row vectors.
///
/// Sets the header of the table
/// Sets the cells of the table
@@ -637,7 +637,7 @@ public static GenericChart.GenericChart Sankey(
/// The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
/// The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Table(
+ public static GenericChart Table(
TableCells header,
TableCells cells,
Optional Name = default,
@@ -679,7 +679,7 @@ public static GenericChart.GenericChart Table(
/// Whether or not to show the gauge axis
/// Sets the gauge axis
///
- public static GenericChart.GenericChart Indicator(
+ public static GenericChart Indicator(
ValueType value,
StyleParam.IndicatorMode mode,
Optional Range = default,
@@ -754,7 +754,7 @@ public static GenericChart.GenericChart Indicator(
/// Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an "id" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.
/// Sets the number of rendered sectors from any given `level`. Set `maxdepth` to "-1" to render all the levels in the hierarchy.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart Icicle(
+ public static GenericChart Icicle(
IEnumerable labels,
IEnumerable parents,
Optional> Values = default,
diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartMap.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartMap.cs
index ce4df89d8..5d85c5244 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/ChartMap.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/ChartMap.cs
@@ -31,7 +31,7 @@ public static partial class Chart
/// Reverses the color mapping if true.
/// Determines the set of locations used to match entries in `locations` to regions on the map. Values "ISO-3", "USA-states", "country names" correspond to features on the base map and value "geojson-id" corresponds to features from a custom GeoJSON linked to the `geojson` attribute.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ChoroplethMap(
+ public static GenericChart ChoroplethMap(
IEnumerable locations,
IEnumerable z,
Optional Name = default,
@@ -100,7 +100,7 @@ public static GenericChart.GenericChart ChoroplethMap(
/// Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. 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".
/// Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ScatterGeo(
+ public static GenericChart ScatterGeo(
IEnumerable longitudes,
IEnumerable latitudes,
StyleParam.Mode mode,
@@ -186,7 +186,7 @@ public static GenericChart.GenericChart ScatterGeoSets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. 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".
/// Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointGeo(
+ public static GenericChart PointGeo(
IEnumerable longitudes,
IEnumerable latitudes,
Optional Name = default,
@@ -266,7 +266,7 @@ public static GenericChart.GenericChart PointGeoSets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. 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".
/// Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart LineGeo(
+ public static GenericChart LineGeo(
IEnumerable longitudes,
IEnumerable latitudes,
Optional ShowMarkers = default,
@@ -353,7 +353,7 @@ public static GenericChart.GenericChart LineGeoSets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. 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".
/// Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example "properties.name".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BubbleGeo(
+ public static GenericChart BubbleGeo(
IEnumerable longitudes,
IEnumerable latitudes,
IEnumerable sizes,
@@ -439,7 +439,7 @@ public static GenericChart.GenericChart BubbleGeoWhether or not to enable clustering for points
/// Sets the clustering options (use this for more finegrained control than the other cluster-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ScatterMapbox(
+ public static GenericChart ScatterMapbox(
IEnumerable longitudes,
IEnumerable latitudes,
StyleParam.Mode mode,
@@ -527,7 +527,7 @@ public static GenericChart.GenericChart ScatterMapboxWhether or not to enable clustering for points
/// Sets the clustering options (use this for more finegrained control than the other cluster-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointMapbox(
+ public static GenericChart PointMapbox(
IEnumerable longitudes,
IEnumerable latitudes,
Optional Name = default,
@@ -607,7 +607,7 @@ public static GenericChart.GenericChart PointMapboxSets the line (use this for more finegrained control than the other line-associated arguments)
/// 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 "''".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart LineMapbox(
+ public static GenericChart LineMapbox(
IEnumerable longitudes,
IEnumerable latitudes,
Optional ShowMarkers = default,
@@ -690,7 +690,7 @@ public static GenericChart.GenericChart LineMapboxSets the marker (use this for more finegrained control than the other marker-associated arguments)
/// 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 "''".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BubbleMapbox(
+ public static GenericChart BubbleMapbox(
IEnumerable longitudes,
IEnumerable latitudes,
IEnumerable sizes,
@@ -762,7 +762,7 @@ public static GenericChart.GenericChart BubbleMapboxReverses the color mapping if true.
/// 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 "''".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ChoroplethMapbox(
+ public static GenericChart ChoroplethMapbox(
IEnumerable locations,
IEnumerable z,
object geoJson,
@@ -820,7 +820,7 @@ public static GenericChart.GenericChart ChoroplethMapbox(
/// Reverses the color mapping if true.
/// 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 "''".
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart DensityMapbox(
+ public static GenericChart DensityMapbox(
IEnumerable longitudes,
IEnumerable latitudes,
Optional Name = default,
diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartPolar.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartPolar.cs
index 1389f3532..c3f98c7b1 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/ChartPolar.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/ChartPolar.cs
@@ -43,7 +43,7 @@ public static partial class Chart
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ScatterPolar(
+ public static GenericChart ScatterPolar(
IEnumerable r,
IEnumerable theta,
StyleParam.Mode mode,
@@ -124,7 +124,7 @@ public static GenericChart.GenericChart ScatterPolar
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointPolar(
+ public static GenericChart PointPolar(
IEnumerable r,
IEnumerable theta,
Optional Name = default,
@@ -199,7 +199,7 @@ public static GenericChart.GenericChart PointPolar(
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart LinePolar(
+ public static GenericChart LinePolar(
IEnumerable r,
IEnumerable theta,
Optional ShowMarkers = default,
@@ -287,7 +287,7 @@ public static GenericChart.GenericChart LinePolar(
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart SplinePolar(
+ public static GenericChart SplinePolar(
IEnumerable r,
IEnumerable theta,
Optional ShowMarkers = default,
@@ -371,7 +371,7 @@ public static GenericChart.GenericChart SplinePolar(
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// If true, plotly.js will use the WebGL engine to render this chart. use this when you want to render many objects at once.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BubblePolar(
+ public static GenericChart BubblePolar(
IEnumerable r,
IEnumerable theta,
IEnumerable sizes,
@@ -443,7 +443,7 @@ public static GenericChart.GenericChart BubblePolar(
/// Sets the bar width (in position axis units) of all bars.
/// Sets the individual bar width (in position axis units) for each bar.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BarPolar(
+ public static GenericChart BarPolar(
IEnumerable r,
IEnumerable theta,
Optional Name = default,
diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartSmith.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartSmith.cs
index 8c3520ddf..63d79bd03 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/ChartSmith.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/ChartSmith.cs
@@ -39,7 +39,7 @@ public static partial class Chart
/// Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `FillColor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ScatterSmith(
+ public static GenericChart ScatterSmith(
IEnumerable real,
IEnumerable imag,
StyleParam.Mode mode,
@@ -120,7 +120,7 @@ public static GenericChart.GenericChart ScatterSmithSets the marker symbol for each individual datum
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointSmith(
+ public static GenericChart PointSmith(
IEnumerable real,
IEnumerable imag,
Optional Name = default,
@@ -193,7 +193,7 @@ public static GenericChart.GenericChart PointSmith
/// Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked, then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `FillColor` if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty" fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.
/// ets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart LineSmith(
+ public static GenericChart LineSmith(
IEnumerable real,
IEnumerable imag,
Optional ShowMarkers = default,
@@ -279,7 +279,7 @@ public static GenericChart.GenericChart LineSmith(
/// sets the drawing style of the line
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart BubbleSmith(
+ public static GenericChart BubbleSmith(
IEnumerable real,
IEnumerable imag,
IEnumerable sizes,
diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartTernary.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartTernary.cs
index 58a5c0e9b..c795eb73f 100644
--- a/src/Plotly.NET.CSharp/ChartAPI/ChartTernary.cs
+++ b/src/Plotly.NET.CSharp/ChartAPI/ChartTernary.cs
@@ -43,7 +43,7 @@ public static partial class Chart
/// sets the drawing style of the line
/// Sets the line (use this for more finegrained control than the other line-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart ScatterTernary(
+ public static GenericChart ScatterTernary(
Optional> A = default,
Optional> B = default,
Optional> C = default,
@@ -128,7 +128,7 @@ public static GenericChart.GenericChart ScatterTernarySets the marker symbol for each individual datum
/// Sets the marker (use this for more finegrained control than the other marker-associated arguments)
/// If set to false, ignore the global default settings set in `Defaults`
- public static GenericChart.GenericChart PointTernary(
+ public static GenericChart PointTernary(
Optional> A = default,
Optional> B = default,
Optional