diff --git a/docs/3D-charts/3d-isosurface-plots.fsx b/docs/3D-charts/3d-isosurface-plots.fsx index b80b6bb3e..13d6ac984 100644 --- a/docs/3D-charts/3d-isosurface-plots.fsx +++ b/docs/3D-charts/3d-isosurface-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create 3D-IsoSurface 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 System diff --git a/docs/3D-charts/3d-mesh-plots.fsx b/docs/3D-charts/3d-mesh-plots.fsx index 00423b2dc..ce5ad9319 100644 --- a/docs/3D-charts/3d-mesh-plots.fsx +++ b/docs/3D-charts/3d-mesh-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create 3D-Mesh 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 System diff --git a/docs/3D-charts/3d-scatter-plots.fsx b/docs/3D-charts/3d-scatter-plots.fsx index 9f616f23e..b211746c1 100644 --- a/docs/3D-charts/3d-scatter-plots.fsx +++ b/docs/3D-charts/3d-scatter-plots.fsx @@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create three-dimensional point and line charts in F#. -Point3D, Line3D, and Bubble3D charts are all derived from `Chart.Scatter3D` and can be generated by that function as well. +Point3D, Line3D, and Bubble3D charts are all derived from `Chart.Scatter3D` and can be generated by that function, as well. However, `Chart.Point3D`, `Chart.Line3D`, or `Chart.Bubble3D` provide sensible defaults and arguments for the respective derived chart, and are recommended to use. ## 3D point chart diff --git a/docs/3D-charts/3d-streamtube-plots.fsx b/docs/3D-charts/3d-streamtube-plots.fsx index 8f54e17cb..339c4b174 100644 --- a/docs/3D-charts/3d-streamtube-plots.fsx +++ b/docs/3D-charts/3d-streamtube-plots.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create 3D-StreamTube 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 Deedle diff --git a/docs/3D-charts/3d-surface-plots.fsx b/docs/3D-charts/3d-surface-plots.fsx index 8f9bf0ae1..70d92287e 100644 --- a/docs/3D-charts/3d-surface-plots.fsx +++ b/docs/3D-charts/3d-surface-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create 3D surface plots 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 System open Plotly.NET diff --git a/docs/3D-charts/3d-volume-plots.fsx b/docs/3D-charts/3d-volume-plots.fsx index 3eacad100..f7faf3ec4 100644 --- a/docs/3D-charts/3d-volume-plots.fsx +++ b/docs/3D-charts/3d-volume-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create 3D-Volume 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 System diff --git a/docs/carpet-charts/carpet_line_scatter_plots.fsx b/docs/carpet-charts/carpet_line_scatter_plots.fsx index ba9dbb25b..40b1b5b60 100644 --- a/docs/carpet-charts/carpet_line_scatter_plots.fsx +++ b/docs/carpet-charts/carpet_line_scatter_plots.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create carpet 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 @@ Besides the ability to incorporate more variables, another feature that distingu A conventional carpet plot can capture the interaction of up to three independent variables and three dependent variables and still be easily read and interpolated. -Carpet plots have common applications within areas such as material science for showing elastic modulus in laminates,and within aeronautics. +Carpet plots have common applications within areas such as material science for showing elastic modulus in laminates, and within aeronautics. A carpet plot with two independent variables and one dependent variable is often called a cheater plot for the use of a phantom "cheater" axis instead of the horizontal axis. @@ -66,7 +66,7 @@ A carpet plot with two independent variables and one dependent variable is often In plotly, carpet plots are different to all other trace types in the regard that the coordinate system of the carpet is not set on the layout, but is itself a trace. -Use `Chart.Carpet` to define these `coordinate traces`. All carpets have a mandatory identifier, which will be used by other traces to define which carpet coordinate system to use. +Use `Chart.Carpet` to define these `coordinate traces`. All carpets have a mandatory identifier which will be used by other traces to define which carpet coordinate system to use. *) let carpet = Chart.Carpet(carpetId = "carpetIdentifier", A = a, B = b, Y = y) @@ -83,7 +83,7 @@ carpet |> GenericChart.toChartHTML (** ## Carpet point charts -use `Chart.PointCarpet` to create a point plot on the referenced carpet coordinate system: +Use `Chart.PointCarpet` to create a point plot on the referenced carpet coordinate system: *) let carpetPoint = [ carpet @@ -102,7 +102,7 @@ carpetPoint |> GenericChart.toChartHTML (** ## Carpet line charts -use `Chart.LineCarpet` to create a line plot on the referenced carpet coordinate system: +Use `Chart.LineCarpet` to create a line plot on the referenced carpet coordinate system: *) let carpetLine = @@ -122,7 +122,7 @@ carpetLine |> GenericChart.toChartHTML (** ## Carpet Spline charts -use `Chart.LineCarpet` to create a spline plot on the referenced carpet coordinate system: +Use `Chart.LineCarpet` to create a spline plot on the referenced carpet coordinate system: *) let carpetSpline = @@ -142,7 +142,7 @@ carpetSpline |> GenericChart.toChartHTML (** ## Carpet bubble charts -use `Chart.LineCarpet` to create a bubble plot on the referenced carpet coordinate system: +Use `Chart.LineCarpet` to create a bubble plot on the referenced carpet coordinate system: *) let carpetBubble = diff --git a/docs/categorical-charts/icicle.fsx b/docs/categorical-charts/icicle.fsx index bb0214771..a38dda104 100644 --- a/docs/categorical-charts/icicle.fsx +++ b/docs/categorical-charts/icicle.fsx @@ -37,7 +37,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- Icicle charts visualize hierarchical data using rectangular sectors that cascade from root to leaves in one of four directions: up, down, left, or right. Similar to Sunburst charts and Treemaps charts, the hierarchy is defined by labels and parents attributes. Click on one sector to zoom in/out, which also displays a pathbar on the top of your icicle. -To zoom out, you can click the parent sector or click the pathbar as well. +To zoom out, you can click the parent sector or click the pathbar, as well. *) open Plotly.NET @@ -71,7 +71,7 @@ icicle |> GenericChart.toChartHTML (** ## More styled example -This example shows the usage of some of the styling possibility using `Chart.Icicle`. +This example shows the usage of some of the styling options using `Chart.Icicle`. For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Icicle` *) diff --git a/docs/categorical-charts/parallel-categories.fsx b/docs/categorical-charts/parallel-categories.fsx index 961a6ffee..8a8bf1976 100644 --- a/docs/categorical-charts/parallel-categories.fsx +++ b/docs/categorical-charts/parallel-categories.fsx @@ -62,7 +62,7 @@ parcats |> GenericChart.toChartHTML (** ## More styled example -This example shows the usage of some of the styling possibility using `Chart.ParallelCategories`. +This example shows the usage of some of the styling options using `Chart.ParallelCategories`. For even more styling control, use the respective TraceStyle function `TraceDomainStyle.ParallelCategories` *) diff --git a/docs/categorical-charts/parallel-coords.fsx b/docs/categorical-charts/parallel-coords.fsx index 7a6069ce6..3397315bb 100644 --- a/docs/categorical-charts/parallel-coords.fsx +++ b/docs/categorical-charts/parallel-coords.fsx @@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create parallel coordinates plot 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: *) @@ -69,7 +69,7 @@ parcoords1 |> GenericChart.toChartHTML (** ## More styled example -This example shows the usage of some of the styling possibility using `Chart.ParallelCoord`. +This example shows the usage of some of the styling options using `Chart.ParallelCoord`. For even more styling control, use the respective TraceStyle function `TraceDomainStyle.ParallelCoord` *) diff --git a/docs/categorical-charts/sunburst.fsx b/docs/categorical-charts/sunburst.fsx index 9b3d7f07f..702534ab7 100644 --- a/docs/categorical-charts/sunburst.fsx +++ b/docs/categorical-charts/sunburst.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create sunburst charts in F#. -Sunburst Chart � also known as Ring Chart, Multi-level Pie Chart, and Radial Treemap � is typically used to visualize hierarchical data structures. +Sunburst Chart, also known as Ring Chart, Multi-level Pie Chart, and Radial Treemap, is typically used to visualize hierarchical data structures. A Sunburst Chart consists of an inner circle surrounded by rings of deeper hierarchy levels. The angle of each segment is either proportional to a value or divided equally under its parent node. @@ -55,7 +55,7 @@ let sunburstChart = (** ## More styled example -This example shows the usage of some of the styling possibility using `Chart.Sunburst`. +This example shows the usage of some of the styling options using `Chart.Sunburst`. For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Sunburst` *) diff --git a/docs/categorical-charts/treemap.fsx b/docs/categorical-charts/treemap.fsx index 54f66c7e2..15e666b1e 100644 --- a/docs/categorical-charts/treemap.fsx +++ b/docs/categorical-charts/treemap.fsx @@ -39,7 +39,7 @@ The space inside each of the rectangles that compose a Treemap is highlighted ba ## Treemap example -This example shows the usage of some of the styling possibility using `Chart.Treemap`. +This example shows the usage of some of the styling options using `Chart.Treemap`. For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Treemap` *) diff --git a/docs/chart-layout/annotations.fsx b/docs/chart-layout/annotations.fsx index 5d58cdcd0..7699cd6e8 100644 --- a/docs/chart-layout/annotations.fsx +++ b/docs/chart-layout/annotations.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create Shapes and add them to the 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: *) @@ -42,7 +42,7 @@ let x = [ 1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10. ] let y = [ 2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1. ] (** -use the `Annotation.init` function to generate a shape, and either the `Chart.withAnnotation` or the `Chart.withAnnotations` function to add +Use the `Annotation.init` function to generate a shape, and either the `Chart.withAnnotation` or the `Chart.withAnnotations` function to add multiple annotations at once. *) diff --git a/docs/chart-layout/axis-styling.fsx b/docs/chart-layout/axis-styling.fsx index 71364706b..5b30fa6b0 100644 --- a/docs/chart-layout/axis-styling.fsx +++ b/docs/chart-layout/axis-styling.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to style chart axes 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 @@ -62,7 +62,7 @@ plot1 |> GenericChart.toChartHTML (***include-it-raw***) (** -for even more fine-grained control, initialize a new axis and replace the old one of the plot with ````. +For even more fine-grained control, initialize a new axis and replace the old one of the plot with `Chart.with*_Axis`. The following example creates two mirrored axes with inside ticks, one of them with a log scale: *) diff --git a/docs/chart-layout/errorbars.fsx b/docs/chart-layout/errorbars.fsx index 5f88e659d..88f8d2221 100644 --- a/docs/chart-layout/errorbars.fsx +++ b/docs/chart-layout/errorbars.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to add error bars to plots 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/chart-layout/layout_images.fsx b/docs/chart-layout/layout_images.fsx index 117c60bae..62543a023 100644 --- a/docs/chart-layout/layout_images.fsx +++ b/docs/chart-layout/layout_images.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create Images and add them to the 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: *) @@ -42,7 +42,7 @@ let x = [ 1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10. ] let y = [ 2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1. ] (** -use the `LayoutImage.init` function to generate an image, and either the `Chart.withLayoutImage` or the `Chart.withLayoutImages` function to add +Use the `LayoutImage.init` function to generate an image, and either the `Chart.withLayoutImage` or the `Chart.withLayoutImages` function to add multiple annotations at once. *) diff --git a/docs/chart-layout/multiple-charts.fsx b/docs/chart-layout/multiple-charts.fsx index f7cf26176..b112742c1 100644 --- a/docs/chart-layout/multiple-charts.fsx +++ b/docs/chart-layout/multiple-charts.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create charts with multiple subplots 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: *) @@ -71,7 +71,7 @@ combinedChart |> GenericChart.toChartHTML `Chart.Grid` creates a subplot grid. There are two overloads: -You can either use Chart.Grid with a 1 dimensional sequence of Charts and specify the amount of rows and columns: +You can either use Chart.Grid with a 1 dimensional sequence of Charts and specify the number of rows and columns: *) @@ -133,8 +133,8 @@ grid2 |> GenericChart.toChartHTML (** To leave cells of the grid empty, you have to fill it with dummy charts via `Chart.Invisible()`. -Pleas enote that when using a 2D sequence with unequal amounts of charts in the rows, the column amount will be set -to the row with the highest amount of charts, and the other rows will be filled by invisible charts to the right. +Pleas note that when using a 2D sequence with unequal numbers of charts in the rows, the column count will be set +to the row with the highest number of charts, and the other rows will be filled by invisible charts to the right. *) //simple 2x2 subplot grid with an empty cell at position 1,2 @@ -164,7 +164,7 @@ grid3 |> GenericChart.toChartHTML (***include-it-raw***) (** -use `Pattern=StyleParam.LayoutGridPatter.Coupled` to use one shared x axis per column and one shared y axis per row. +Use `Pattern=StyleParam.LayoutGridPatter.Coupled` to use one shared x axis per column and one shared y axis per row. (Try zooming in the single subplots below) *) @@ -196,7 +196,7 @@ grid4 |> GenericChart.toChartHTML ### Chart.SingleStack The `Chart.SingleStack` function is a special version of Chart.Grid that creates only one column from a 1D input chart sequence. -It uses a shared x axis per default. +It uses a shared x axis by default. As with all grid charts, you can also use the Chart.withLayoutGridStyle to style subplot grids: @@ -228,7 +228,7 @@ singleStack |> GenericChart.toChartHTML Chart.Grid does some internal magic to make sure that all trace types get their grid cell according to plotly.js's inner logic. -The only thing you have to consider is, that when you are using nested combined charts, that these have to have the same trace type. +The only thing you have to consider is that when you are using nested combined charts, they have to have the same trace type. Otherwise, you can freely combine all charts with Chart.Grid: @@ -324,7 +324,7 @@ multipleTraceTypesGrid |> GenericChart.toChartHTML (***include-it-raw***) (** -If you are not sure if traceTypes are compatible, look at the `TraceIDs`: +If you are not sure if trace types are compatible, look at the `TraceIDs`: *) let pointType = Chart.Point(xy = [ 1, 2 ]) |> GenericChart.getTraceID diff --git a/docs/chart-layout/shapes.fsx b/docs/chart-layout/shapes.fsx index d8ba9fe87..7f52539b5 100644 --- a/docs/chart-layout/shapes.fsx +++ b/docs/chart-layout/shapes.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create Shapes and add them to the 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: *) @@ -42,7 +42,7 @@ let x = [ 1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10. ] let y' = [ 2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1. ] (** -use the `Shape.init` function to generate a shape, and either the `Chart.withShape` or the `Chart.withShapes` function to add +Use the `Shape.init` function to generate a shape, and either the `Chart.withShape` or the `Chart.withShapes` function to add multiple shapes at once. **Attention**: Adding a shape after you added a previous one currently removes the old one. This is a bug and will be fixed diff --git a/docs/chart-layout/sliders.fsx b/docs/chart-layout/sliders.fsx index a6eb55234..438890d26 100644 --- a/docs/chart-layout/sliders.fsx +++ b/docs/chart-layout/sliders.fsx @@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- The sliders give the option of passing the arguments to the Plotly chart. In the example we use the visibility parameter to make the step chosen in the slider visible. -The original exapmle is made with python and can be found [here](https://plotly.com/python/sliders) +The original example is written in Python and can be found [here](https://plotly.com/python/sliders) *) open Plotly.NET @@ -78,7 +78,7 @@ let sliderSteps = steps |> Seq.indexed |> Seq.map (fun (i, step) -> - // Create a visibility and a title parameters + // Create a visibility and a title parameter // The visibility parameter includes an array where every parameter // is mapped onto the trace visibility let visible = diff --git a/docs/distribution-charts/2d-histograms.fsx b/docs/distribution-charts/2d-histograms.fsx index 489d7be47..dfc7a0530 100644 --- a/docs/distribution-charts/2d-histograms.fsx +++ b/docs/distribution-charts/2d-histograms.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create a bi-dimensional histogram of two data samples 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/distribution-charts/box-plots.fsx b/docs/distribution-charts/box-plots.fsx index 1a5953529..94cc9f164 100644 --- a/docs/distribution-charts/box-plots.fsx +++ b/docs/distribution-charts/box-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create boxplot 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 @@ -71,7 +71,7 @@ box1 |> GenericChart.toChartHTML (***include-it-raw***) (** -By swapping x and y plus using `StyleParam.Orientation.Horizontal` we can flip the chart horizontaly. +By swapping x and y plus using `StyleParam.Orientation.Horizontal`, we can flip the chart horizontally. *) let box2 = Chart.BoxPlot( diff --git a/docs/distribution-charts/contour-plots.fsx b/docs/distribution-charts/contour-plots.fsx index 675c313e9..0a1bd773b 100644 --- a/docs/distribution-charts/contour-plots.fsx +++ b/docs/distribution-charts/contour-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create contour plot 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: *) @@ -79,7 +79,7 @@ contour1 |> GenericChart.toChartHTML (** ## Smooth Contour Coloring -to apply heatmap gradient coloring between each contour level, set the `ContourColoring` to `heatmap`: +To apply heatmap gradient coloring between each contour level, set the `ContourColoring` to `heatmap`: *) let contour2 = diff --git a/docs/distribution-charts/histograms.fsx b/docs/distribution-charts/histograms.fsx index 02d6a5d86..d2e85a509 100644 --- a/docs/distribution-charts/histograms.fsx +++ b/docs/distribution-charts/histograms.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create a one-dimensional histogram of a data samples 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/distribution-charts/point-density.fsx b/docs/distribution-charts/point-density.fsx index 49c2ae62f..e0a66bb6a 100644 --- a/docs/distribution-charts/point-density.fsx +++ b/docs/distribution-charts/point-density.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create PointDensity plots 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: *) @@ -43,7 +43,7 @@ let y = [ for i in 0..100 -> rnd.NextDouble() ] (** `Chart.PointDensity` is a combination of a scatter plot and a histogram2dcontour. -It helps assessing the 2 dimensional distribution of a scatter plot by adding density contours based on the same data. +It helps assessing the two-dimensional distribution of a scatter plot by adding density contours based on the same data. *) open Plotly.NET @@ -62,7 +62,7 @@ pointDensityChart |> GenericChart.toChartHTML (** ## More styled example -This example shows the usage of some of the styling possibility using `Chart.PointDensity`. +This example shows the usage of some of the styling options using `Chart.PointDensity`. *) let pointDensityChartStyled = diff --git a/docs/distribution-charts/splom.fsx b/docs/distribution-charts/splom.fsx index 78a7586a7..c1a67d05a 100644 --- a/docs/distribution-charts/splom.fsx +++ b/docs/distribution-charts/splom.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to plot a scatterplot matrix (splom) 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 Deedle diff --git a/docs/distribution-charts/violin-plots.fsx b/docs/distribution-charts/violin-plots.fsx index 9fa587870..b4b8a4fe1 100644 --- a/docs/distribution-charts/violin-plots.fsx +++ b/docs/distribution-charts/violin-plots.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create violin 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: *) @@ -70,7 +70,7 @@ violin1 |> GenericChart.toChartHTML (***include-it-raw***) (** -By swapping x and y plus using `StyleParam.Orientation.Horizontal` we can flip the chart horizontaly. +By swapping x and y plus using `StyleParam.Orientation.Horizontal`, we can flip the chart horizontally. *) open Plotly.NET.TraceObjects diff --git a/docs/finance-charts/candlestick.fsx b/docs/finance-charts/candlestick.fsx index cbd502530..4e4825fd9 100644 --- a/docs/finance-charts/candlestick.fsx +++ b/docs/finance-charts/candlestick.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create candlestick 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 Deedle @@ -62,7 +62,7 @@ let candles = (** A candlestick chart is useful for plotting stock prices over time. A candle is a group of high, open, close and low values over a period of time, e.g. 1 minute, 5 minute, hour, day, etc.. -The x-axis is usually dateime values and y is a sequence of candle structures. +The x-axis is usually datetime values and y is a sequence of candle structures. *) open Plotly.NET diff --git a/docs/finance-charts/funnel.fsx b/docs/finance-charts/funnel.fsx index c3d2a411c..34222cb14 100644 --- a/docs/finance-charts/funnel.fsx +++ b/docs/finance-charts/funnel.fsx @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create funnel 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: *) let y = diff --git a/docs/finance-charts/funnel_area.fsx b/docs/finance-charts/funnel_area.fsx index 5becf8a6a..268f5dcca 100644 --- a/docs/finance-charts/funnel_area.fsx +++ b/docs/finance-charts/funnel_area.fsx @@ -31,7 +31,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create funnel 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: *) let values = [| 5; 4; 3; 2; 1 |] @@ -64,7 +64,7 @@ funnelArea |> GenericChart.toChartHTML (** ## More styled example -This example shows the usage of some of the styling possibility using `Chart.FunnelArea`. +This example shows the usage of some of the styling options using `Chart.FunnelArea`. For even more styling control, use the respective TraceStyle function `TraceDomainStyle.FunnelArea` *) diff --git a/docs/finance-charts/ohlc.fsx b/docs/finance-charts/ohlc.fsx index c8f81b892..e7552b3f9 100644 --- a/docs/finance-charts/ohlc.fsx +++ b/docs/finance-charts/ohlc.fsx @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- *Summary:* This example shows how to create ohlc 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 Deedle @@ -53,7 +53,7 @@ let dateData = (** An open-high-low-close chart (also OHLC) is a type of chart typically used to illustrate movements in the price of a financial instrument over time. Each vertical line on the chart shows the price range (the highest and lowest prices) over one unit of time. -Tick marks project from each side of the line indicating the opening price (e.g., for a daily bar chart this would be the starting price for that day) on the left, and the closing price for that time period on the right. +Tick marks project from each side of the line indicating the opening price (e.g., for a daily bar chart, this would be the starting price for that day) on the left, and the closing price for that time period on the right. The bars may be shown in different hues depending on whether prices rose or fell in that period. You can create an OHLC chart using `Chart.OHLC`: diff --git a/docs/finance-charts/waterfall.fsx b/docs/finance-charts/waterfall.fsx index 4524468b3..4690e5d33 100644 --- a/docs/finance-charts/waterfall.fsx +++ b/docs/finance-charts/waterfall.fsx @@ -34,8 +34,8 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- Waterfall charts are special bar charts that help visualizing the cumulative effect of sequentially introduced positive or negative values. -In addition to the x and y values, a `WaterfallMeasure` can be passed corresponding to each xy pair (there is also a constructor overload using a tripel of x,y,measure). -By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed. +In addition to the x and y values, a `WaterfallMeasure` can be passed, corresponding to each xy pair (there is also a constructor overload using a tripel of x,y,measure). +By default, the values are considered as 'relative'. However, it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed. *) @@ -74,7 +74,7 @@ waterfall1 |> GenericChart.toChartHTML (** ## Horizontal waterfall charts -Set the orientation argument to `Horizontal` to create a horizontal waterfall. Keep in mind to correctly assign x and y values (the vallues are switched on the axes in comparison to the chart example above) +Set the orientation argument to `Horizontal` to create a horizontal waterfall. Keep in mind to correctly assign x and y values (the values are switched on the axes in comparison to the chart example above) To keep better track of which measure belongs to which datum, use *) diff --git a/docs/general/basics.fsx b/docs/general/basics.fsx index 76885fd47..c2362c4ca 100644 --- a/docs/general/basics.fsx +++ b/docs/general/basics.fsx @@ -129,7 +129,7 @@ withTraceStyle |> GenericChart.toChartHTML The prime directive for all functions provided by Plotly.NET is the construction of valid plotly JSON objects. For this purpose, `Trace`, `Layout`, and `Config` (and many other internal objects) are inheriting from [`DynamicObj`](https://github.com/plotly/Plotly.NET/blob/dev/src/Plotly.NET/DynamicObj.fs), -an extension of `DynamicObject` which makes it possible to set arbitraryly named and typed properties of these objects via the `?` operator. +an extension of `DynamicObject` which makes it possible to set arbitrarily named and typed properties of these objects via the `?` operator. If you want to exactly mirror a plotly.js tutorial, or want to set properties that for any reason are not abstracted in Plotly.NET, it can be useful to use the power of DynamicObj to set the parameters directly. Just make sure that the property name is exactly the same as in plotly.js (all lowercase) @@ -153,7 +153,7 @@ withDynObj |> GenericChart.toChartHTML (***include-it-raw***) (** -lets have a look at the trace object that will be created. The relevant section of the html generated with Chart.Show is the following: +Let's have a look at the trace object that will be created. The relevant section of the html generated with Chart.Show is the following: ```javascript var data = [{"type":"scatter","x":[0,1,2],"y":[0,1,2]}]; diff --git a/docs/general/chart-config.fsx b/docs/general/chart-config.fsx index 62bc5eab7..701d5c6b9 100644 --- a/docs/general/chart-config.fsx +++ b/docs/general/chart-config.fsx @@ -119,7 +119,7 @@ editablePlot |> GenericChart.toChartHTML (** ## Responsive charts -To create a chart that is reponsive to its container size, use `Responsive=true` on the Config: +To create a chart that is responsive to its container size, use `Responsive=true` on the Config: (try resizing the window) *) diff --git a/docs/general/defaults.fsx b/docs/general/defaults.fsx index b70d5ffdc..b8d374ea5 100644 --- a/docs/general/defaults.fsx +++ b/docs/general/defaults.fsx @@ -82,7 +82,7 @@ Defaults.DefaultTemplate <- ChartTemplates.plotly (** ## Ignoring global defaults -All Chart functions have a `UseDefaults` argument, which when set to `false` will ignore all global defaults: +All Chart functions have a `UseDefaults` argument which, when set to `false`, will ignore all global defaults: *) diff --git a/docs/general/display-options.fsx b/docs/general/display-options.fsx index 49571ae6b..9afda986f 100644 --- a/docs/general/display-options.fsx +++ b/docs/general/display-options.fsx @@ -35,7 +35,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <- You can control the html output that gets created (e.g. documents created with `Chart.Show` or the output of `GenericChart.toChartHTML`) with various functions that change a chart's `DisplayOptions`. -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: *) @@ -71,7 +71,7 @@ Plotly.NET provides multiple ways to reference plotly.js in generated html via t | --- | --- | --- | --- | | `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 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. | +| `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](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: 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..cda5853fd 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 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/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..428b8895b 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 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/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs b/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs index a374a5f55..d6bbeb498 100644 --- a/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs +++ b/src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs @@ -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 diff --git a/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs b/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs index a9eba300c..abf1ea0c4 100644 --- a/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs +++ b/src/Plotly.NET.CSharp/ChartAPI/ChartDomain.cs @@ -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 diff --git a/src/Plotly.NET/ChartAPI/Chart3D.fs b/src/Plotly.NET/ChartAPI/Chart3D.fs index 35912ad10..8eeb37839 100644 --- a/src/Plotly.NET/ChartAPI/Chart3D.fs +++ b/src/Plotly.NET/ChartAPI/Chart3D.fs @@ -864,7 +864,7 @@ module Chart3D = /// 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 diff --git a/src/Plotly.NET/ChartAPI/ChartDomain.fs b/src/Plotly.NET/ChartAPI/ChartDomain.fs index d4a2635ab..d8a0b3f7b 100644 --- a/src/Plotly.NET/ChartAPI/ChartDomain.fs +++ b/src/Plotly.NET/ChartAPI/ChartDomain.fs @@ -1423,7 +1423,7 @@ module ChartDomain = /// /// 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 @@ -1464,7 +1464,7 @@ module ChartDomain = /// /// 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 values contained in the table header. /// Sets the values contained in the table cells.