Skip to content

Fix several typos #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

Plotly.NET is an Interactive charting library for **.NET** programming languages 📈🚀.

It is built on top of plotly.js and provides several API layers for creating, styling and rendering ✨**beatiful data visualizations**✨.
It is built on top of plotly.js and provides several API layers for creating, styling and rendering ✨**beautiful data visualizations**✨.

To get a deep-dive into the rationale behind the design choices of Plotly.NET, check out our [F1000Research paper](https://doi.org/10.12688/f1000research.123971.1)!

Expand Down
6 changes: 3 additions & 3 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### 2.0.0 +

Starting from 2.0.0, Versions of Plotly.NET and expansion packages are decoupled, meaning this single realease notes page does not work anymore.
Starting from 2.0.0, Versions of Plotly.NET and expansion packages are decoupled, meaning this single release notes page does not work anymore.

For the individual package release notes, please refer to these files:
- [Plotly.NET](./src/Plotly.NET/RELEASE_NOTES.md)
Expand Down Expand Up @@ -39,7 +39,7 @@ All APIs have changed significantly - this release is incompatible with 1.x and
- There are 5 main categories of abstractions: `Trace` (chart data and type), `Layout`(non-data chart styling), `Config`(render options), `DisplayOptions`(html display options), `StyleParam`(DSL for styling options)
- Many properties used in these levels are themselves objects, which are in the respective `*Objects` namespace (e.g. `Geo`, which determines map layout of geo traces is an object on the `Layout` and therefore in the `LaoutObjects` namespace.)
- every object is based on `DynamicObj` and its properties can therefore be further customised by dynamic member assignment. Therefore, every plotly property can be set manually, even those which do not have direct abstractions.
- There are now several `Trace` types for each kind of subplot (`Trace2D`, `Trace3D`, etc.) and eqivalent `Chart` types (`Chart2D`, `Chart3D`, etc). while not visible from the top level api (everything kan be accessed via the unified `Chart` API), this greatly improves correct multi chart layouting.
- There are now several `Trace` types for each kind of subplot (`Trace2D`, `Trace3D`, etc.) and equivalent `Chart` types (`Chart2D`, `Chart3D`, etc). while not visible from the top level api (everything kan be accessed via the unified `Chart` API), this greatly improves correct multi chart layouting.
- There are 3 ways of creating charts with increasing level of customization:
1. The `Chart` API as a unified API surface for chart creation and styling
- `Chart.<ChartType>` (e.g. `Chart.Point`) for chart creation from data and some chart specific styling options
Expand Down Expand Up @@ -259,7 +259,7 @@ Additional functionality and plots thanks to external open source contributors:

### 1.1.2 - Aug 16 2018
* Support .net framework 4.7
* Minor improvments
* Minor improvements

### 1.1.1 - Jun 22 2018
* Support netStandard 2.0
Expand Down
42 changes: 21 additions & 21 deletions src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions src/Plotly.NET.CSharp/ChartAPI/Chart3D.cs
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ public static GenericChart.GenericChart Point3D<XType, YType, ZType, TextType>(
/// <param name="x">Sets the x coordinates of the plotted data.</param>
/// <param name="y">Sets the y coordinates of the plotted data.</param>
/// <param name="z">Sets the z coordinates of the plotted data.</param>
/// <param name="ShowMarkers">Wether to show markers for the datums additionally to the line</param>
/// <param name="ShowMarkers">Whether to show markers for the datums additionally to the line</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="Opacity">Sets the opactity of the trace</param>
Expand Down Expand Up @@ -361,7 +361,7 @@ public static GenericChart.GenericChart Bubble3D<XType, YType, ZType, TextType>(
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="Contours">Sets the contours on the surface</param>
/// <param name="ColorScale">Sets the colorscale of the surface</param>
/// <param name="ShowScale">Wether or not to show the colorbar/colorscale</param>
/// <param name="ShowScale">Whether or not to show the colorbar/colorscale</param>
/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
public static GenericChart.GenericChart Surface<ZType, XType, YType, TextType>(
IEnumerable<IEnumerable<ZType>> zData,
Expand Down Expand Up @@ -424,7 +424,7 @@ public static GenericChart.GenericChart Surface<ZType, XType, YType, TextType>(
/// <param name="Color">Sets the color of the whole mesh</param>
/// <param name="Contour">Sets the style and visibility of contours</param>
/// <param name="ColorScale">Sets the colorscale</param>
/// <param name="ShowScale">Wether or not to show the colorbar/colorscale</param>
/// <param name="ShowScale">Whether or not to show the colorbar/colorscale</param>
/// <param name="ColorBar">Sets the colorbar</param>
/// <param name="FlatShading">Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.</param>
/// <param name="TriangulationAlgorithm">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.</param>
Expand Down Expand Up @@ -503,7 +503,7 @@ public static GenericChart.GenericChart Mesh3D<XType, YType, ZType, IType, JType
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="ColorScale">Sets the colorscale</param>
/// <param name="ShowScale">Wether or not to show the colorbar/colorscale</param>
/// <param name="ShowScale">Whether or not to show the colorbar/colorscale</param>
/// <param name="ColorBar">Sets the colorbar</param>
/// <param name="SizeMode">Determines 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).</param>
/// <param name="ConeAnchor">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.</param>
Expand Down Expand Up @@ -580,7 +580,7 @@ public static GenericChart.GenericChart Cone<XType, YType, ZType, UType, VType,
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="ColorScale">Sets the colorscale</param>
/// <param name="ShowScale">Wether or not to show the colorbar/colorscale</param>
/// <param name="ShowScale">Whether or not to show the colorbar/colorscale</param>
/// <param name="ColorBar">Sets the colorbar</param>
/// <param name="MaxDisplayed">The maximum number of displayed segments in a streamtube.</param>
/// <param name="TubeStarts">Use this object to specify custom tube start positions</param>
Expand Down Expand Up @@ -650,7 +650,7 @@ public static GenericChart.GenericChart StreamTube<XType, YType, ZType, UType, V
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="ColorScale">Sets the colorscale</param>
/// <param name="ShowScale">Wether or not to show the colorbar/colorscale</param>
/// <param name="ShowScale">Whether or not to show the colorbar/colorscale</param>
/// <param name="ColorBar">Sets the colorbar</param>
/// <param name="IsoMin">Sets the minimum boundary for iso-surface plot.</param>
/// <param name="IsoMax">Sets the maximum boundary for iso-surface plot.</param>
Expand Down Expand Up @@ -729,7 +729,7 @@ public static GenericChart.GenericChart Volume<XType, YType, ZType, ValueType, T
/// <param name="Text">Sets a text associated with each datum</param>
/// <param name="MultiText">Sets individual text for each datum</param>
/// <param name="ColorScale">Sets the colorscale</param>
/// <param name="ShowScale">Wether or not to show the colorbar/colorscale</param>
/// <param name="ShowScale">Whether or not to show the colorbar/colorscale</param>
/// <param name="ColorBar">Sets the colorbar</param>
/// <param name="IsoMin">Sets the minimum boundary for iso-surface plot.</param>
/// <param name="IsoMax">Sets the maximum boundary for iso-surface plot.</param>
Expand Down
14 changes: 7 additions & 7 deletions src/Plotly.NET.CSharp/ChartAPI/ChartCarpet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public static GenericChart.GenericChart Carpet<XType, MultiXType, YType, MultiYT
///
/// In general, ScatterCarpet creates a plot that uses the given carpet identifier as coordinate system.
///
/// Wether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// Whether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
///
/// ScatterCarpet charts are the basis of PointCarpet, LineCarpet, and BubbleCarpet Charts, and can be customized as such. We also provide abstractions for those: Chart.LineCarpet, Chart.PointCarpet, Chart.BubbleCarpet
/// </summary>
Expand Down Expand Up @@ -186,7 +186,7 @@ public static GenericChart.GenericChart ScatterCarpet<AType, BType, TextType>(
///
/// In general, PointCarpet creates a point plot that uses the given carpet identifier as coordinate system.
///
/// Wether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// Whether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// </summary>
/// <param name="a">Sets the a-axis coordinates on the carpet.</param>
/// <param name="b">Sets the b-axis coordinates on the carpet.</param>
Expand Down Expand Up @@ -256,12 +256,12 @@ public static GenericChart.GenericChart PointCarpet<AType, BType, TextType>(
///
/// In general, LineCarpet creates a line plot that uses the given carpet identifier as coordinate system.
///
/// Wether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// Whether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// </summary>
/// <param name="a">Sets the a-axis coordinates on the carpet.</param>
/// <param name="b">Sets the b-axis coordinates on the carpet.</param>
/// <param name="carpetAnchorId">The identifier of the carpet that this trace will lie on.</param>
/// <param name="ShowMarkers">Wether to show markers for the individual data points</param>
/// <param name="ShowMarkers">Whether to show markers for the individual data points</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
/// <param name="Opacity">Sets the opactity of the trace</param>
Expand Down Expand Up @@ -345,12 +345,12 @@ public static GenericChart.GenericChart LineCarpet<AType, BType, TextType>(
/// In general, SplineCarpet creates a spline plot that uses the given carpet identifier as coordinate system.
/// A spline chart is a line chart in which data points are connected by smoothed curves.
///
/// Wether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// Whether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// </summary>
/// <param name="a">Sets the a-axis coordinates on the carpet.</param>
/// <param name="b">Sets the b-axis coordinates on the carpet.</param>
/// <param name="carpetAnchorId">The identifier of the carpet that this trace will lie on.</param>
/// <param name="ShowMarkers">Wether to show markers for the individual data points</param>
/// <param name="ShowMarkers">Whether to show markers for the individual data points</param>
/// <param name="Smoothing">Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape). Use values between 0. and 1.3</param>
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
Expand Down Expand Up @@ -438,7 +438,7 @@ public static GenericChart.GenericChart SplineCarpet<AType, BType, TextType>(
///
/// A bubble chart is a variation of the Point chart, where the data points get an additional scale by being rendered as bubbles of different sizes.
///
/// Wether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// Whether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.
/// </summary>
/// <param name="a">Sets the a-axis coordinates on the carpet.</param>
/// <param name="b">Sets the b-axis coordinates on the carpet.</param>
Expand Down
Loading